NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.GeometricUtilities.PatternOrientation Class Reference

the pattern orientation definition. More...

Inheritance diagram for NXOpen.GeometricUtilities.PatternOrientation:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  Enum {
  Fixed, NormalToPath, NormalToVector, ParallelToVector,
  ThroughAxis, FollowPattern, FollowCSYS, CSYStoCSYS
}
 pattern orientation options for all pattern types. More...
 
enum  ProjDirEnum { PatternPlaneNormal, NormalToFace, RadialDir, UserDefinedVector }
 pattern follow face project direction options available. More...
 

Public Member Functions

unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.GeometricUtilities.PatternOrientation.Enum 
AlongOrientationOption [get, set]
 Returns or sets the orientationOption for Along pattern type More...
 
unsafe NXOpen.Expression AlongPathRotationAngle [get]
 Returns the along path rotation angle for the Along type pattern Normal to Path option. More...
 
unsafe
NXOpen.GeometricUtilities.PatternOrientation.Enum 
CircularOrientationOption [get, set]
 Returns or sets the orientationOption for Circular pattern type More...
 
unsafe
NXOpen.GeometricUtilities.PatternOrientation.ProjDirEnum 
FollowFaceProjDirOption [get, set]
 Returns or sets the followFaceProjDirOption, an enum for follow face project direction. More...
 
unsafe NXOpen.ScCollector FollowFaceSelection [get]
 Returns the followFaceSelection, a sc collector to store selected faces. More...
 
unsafe bool FollowFaceToggle [get, set]
 Returns or sets the followFaceToggle, a logical flag to indicate if the we need to modify the orientation to follow selected faces. More...
 
unsafe NXOpen.CoordinateSystem FromCSYS [get, set]
 Returns or sets the fromCSYS, a CSYS for certain pattern type orientation need. More...
 
unsafe
NXOpen.GeometricUtilities.PatternOrientation.Enum 
GeneralOrientationOption [get, set]
 Returns or sets the orientationOption for General pattern type More...
 
unsafe
NXOpen.GeometricUtilities.PatternOrientation.Enum 
HelixOrientationOption [get, set]
 Returns or sets the orientationOption for Helix pattern type More...
 
unsafe
NXOpen.GeometricUtilities.PatternOrientation.Enum 
LinearOrientationOption [get, set]
 Returns or sets the orientationOption for Linear pattern type More...
 
unsafe
NXOpen.GeometricUtilities.PatternOrientation.Enum 
MirrorOrientationOption [get, set]
 Returns or sets the orientationOption for Mirror pattern type More...
 
unsafe
NXOpen.GeometricUtilities.PatternOrientation.Enum 
OrientationOption [get, set]
 Returns or sets the orientationOption for rectangular pattern type Note: this one does not have a straight forward replacement; Replacement based on pattern type: GeometricUtilities.PatternOrientation.LinearOrientationOption GeometricUtilities.PatternOrientation.CircularOrientationOption GeometricUtilities.PatternOrientation.AlongOrientationOption GeometricUtilities.PatternOrientation.PolygonOrientationOption GeometricUtilities.PatternOrientation.SpiralOrientationOption GeometricUtilities.PatternOrientation.GeneralOrientationOption GeometricUtilities.PatternOrientation.MirrorOrientationOption GeometricUtilities.PatternOrientation.HelixOrientationOption More...
 
unsafe
NXOpen.GeometricUtilities.PatternOrientation.Enum 
PolygonOrientationOption [get, set]
 Returns or sets the orientationOption for Polygon pattern type More...
 
unsafe bool RepeatTransformSetting [get, set]
 Returns or sets the repeatTransformSetting, a logical flag to indicate if the we need to repeatedly apply the transform. More...
 
unsafe
NXOpen.GeometricUtilities.PatternOrientation.Enum 
SpiralOrientationOption [get, set]
 Returns or sets the orientationOption for Spiral pattern type More...
 
unsafe NXOpen.CoordinateSystem ToCSYS [get, set]
 Returns or sets the toCSYS, a CSYS for certain pattern type orientation need. More...
 
unsafe NXOpen.Direction UserDefinedProjDir [get, set]
 Returns or sets the userDefinedProjDir, a vector for user defined follow face project direction. More...
 
unsafe NXOpen.Direction VectorForAlong [get, set]
 Returns or sets the vectorForAlong, a vector for Along type orientation need. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

the pattern orientation definition.

Allows to specify an orientation option and corresponding entities.

Created in NX7.5.0

Member Enumeration Documentation

pattern orientation options for all pattern types.

Enumerator
Fixed 

same orientation as the seed.

NormalToPath 

normal to path orientation for Along Type first direction.

NormalToVector 

normal to vector orientation for Along Type first direction.

ParallelToVector 

parallel to vector orientation for Along Type first direction.

ThroughAxis 

through axis orientation for Along Type first direction.

FollowPattern 

follow pattern orientation, for example, circular pattern type.

FollowCSYS 

follow CSYS orientation, for general pattern type, when from/to is CSYS.

CSYStoCSYS 

a relative orientation defined by two CSYSs to transform the seed to an instance location.

pattern follow face project direction options available.

Enumerator
PatternPlaneNormal 

use pattern plane normal as project direction.

NormalToFace 

project along face normal.

RadialDir 

project along radial direction.

This is specific for Circular pattern type.

UserDefinedVector 

project along user defined vector.

Member Function Documentation

unsafe bool NXOpen.GeometricUtilities.PatternOrientation.Validate ( )
inline

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.GeometricUtilities.PatternOrientation.Enum NXOpen.GeometricUtilities.PatternOrientation.AlongOrientationOption
getset

Returns or sets the orientationOption for Along pattern type

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe NXOpen.Expression NXOpen.GeometricUtilities.PatternOrientation.AlongPathRotationAngle
get

Returns the along path rotation angle for the Along type pattern Normal to Path option.

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.GeometricUtilities.PatternOrientation.Enum NXOpen.GeometricUtilities.PatternOrientation.CircularOrientationOption
getset

Returns or sets the orientationOption for Circular pattern type

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe NXOpen.GeometricUtilities.PatternOrientation.ProjDirEnum NXOpen.GeometricUtilities.PatternOrientation.FollowFaceProjDirOption
getset

Returns or sets the followFaceProjDirOption, an enum for follow face project direction.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe NXOpen.ScCollector NXOpen.GeometricUtilities.PatternOrientation.FollowFaceSelection
get

Returns the followFaceSelection, a sc collector to store selected faces.

Created in NX7.5.0

License requirements: None.

unsafe bool NXOpen.GeometricUtilities.PatternOrientation.FollowFaceToggle
getset

Returns or sets the followFaceToggle, a logical flag to indicate if the we need to modify the orientation to follow selected faces.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe NXOpen.CoordinateSystem NXOpen.GeometricUtilities.PatternOrientation.FromCSYS
getset

Returns or sets the fromCSYS, a CSYS for certain pattern type orientation need.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe NXOpen.GeometricUtilities.PatternOrientation.Enum NXOpen.GeometricUtilities.PatternOrientation.GeneralOrientationOption
getset

Returns or sets the orientationOption for General pattern type

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe NXOpen.GeometricUtilities.PatternOrientation.Enum NXOpen.GeometricUtilities.PatternOrientation.HelixOrientationOption
getset

Returns or sets the orientationOption for Helix pattern type

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe NXOpen.GeometricUtilities.PatternOrientation.Enum NXOpen.GeometricUtilities.PatternOrientation.LinearOrientationOption
getset

Returns or sets the orientationOption for Linear pattern type

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe NXOpen.GeometricUtilities.PatternOrientation.Enum NXOpen.GeometricUtilities.PatternOrientation.MirrorOrientationOption
getset

Returns or sets the orientationOption for Mirror pattern type

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe NXOpen.GeometricUtilities.PatternOrientation.Enum NXOpen.GeometricUtilities.PatternOrientation.OrientationOption
getset

Returns or sets the orientationOption for rectangular pattern type Note: this one does not have a straight forward replacement; Replacement based on pattern type: GeometricUtilities.PatternOrientation.LinearOrientationOption GeometricUtilities.PatternOrientation.CircularOrientationOption GeometricUtilities.PatternOrientation.AlongOrientationOption GeometricUtilities.PatternOrientation.PolygonOrientationOption GeometricUtilities.PatternOrientation.SpiralOrientationOption GeometricUtilities.PatternOrientation.GeneralOrientationOption GeometricUtilities.PatternOrientation.MirrorOrientationOption GeometricUtilities.PatternOrientation.HelixOrientationOption

Created in NX7.5.0

Deprecated in NX8.0.0. The replacement function depends on the pattern type. See this method's documentation for more detailed information.

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe NXOpen.GeometricUtilities.PatternOrientation.Enum NXOpen.GeometricUtilities.PatternOrientation.PolygonOrientationOption
getset

Returns or sets the orientationOption for Polygon pattern type

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe bool NXOpen.GeometricUtilities.PatternOrientation.RepeatTransformSetting
getset

Returns or sets the repeatTransformSetting, a logical flag to indicate if the we need to repeatedly apply the transform.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe NXOpen.GeometricUtilities.PatternOrientation.Enum NXOpen.GeometricUtilities.PatternOrientation.SpiralOrientationOption
getset

Returns or sets the orientationOption for Spiral pattern type

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe NXOpen.CoordinateSystem NXOpen.GeometricUtilities.PatternOrientation.ToCSYS
getset

Returns or sets the toCSYS, a CSYS for certain pattern type orientation need.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe NXOpen.Direction NXOpen.GeometricUtilities.PatternOrientation.UserDefinedProjDir
getset

Returns or sets the userDefinedProjDir, a vector for user defined follow face project direction.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe NXOpen.Direction NXOpen.GeometricUtilities.PatternOrientation.VectorForAlong
getset

Returns or sets the vectorForAlong, a vector for Along type orientation need.

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT") OR insp_programming ("INSPECTION PROGRAMMING")


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.