PatternOrientation Class

class NXOpen.GeometricUtilities.PatternOrientation

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

the pattern orientation definition.

Allows to specify an orientation option and corresponding entities. .. versionadded:: NX7.5.0

Properties

Property	Description
AlongOrientationOption	Returns or sets the orientationOption for Along pattern type
AlongPathRotationAngle	Returns the along path rotation angle for the Along type pattern Normal to Path option.
CircularOrientationOption	Returns or sets the orientationOption for Circular pattern type
FollowFaceProjDirOption	Returns or sets the followFaceProjDirOption, an enum for follow face project direction.
FollowFaceSelection	Returns the followFaceSelection, a sc collector to store selected faces.
FollowFaceToggle	Returns or sets the followFaceToggle, a logical flag to indicate if the we need to modify the orientation to follow selected faces.
FromCSYS	Returns or sets the fromCSYS, a CSYS for certain pattern type orientation need.
GeneralOrientationOption	Returns or sets the orientationOption for General pattern type
HelixOrientationOption	Returns or sets the orientationOption for Helix pattern type
LinearOrientationOption	Returns or sets the orientationOption for Linear pattern type
MirrorOrientationOption	Returns or sets the orientationOption for Mirror pattern type
OrientationOption	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`()
PolygonOrientationOption	Returns or sets the orientationOption for Polygon pattern type
RepeatTransformSetting	Returns or sets the repeatTransformSetting, a logical flag to indicate if the we need to repeatedly apply the transform.
SpiralOrientationOption	Returns or sets the orientationOption for Spiral pattern type
Tag	Returns the Tag for this object.
ToCSYS	Returns or sets the toCSYS, a CSYS for certain pattern type orientation need.
UserDefinedProjDir	Returns or sets the userDefinedProjDir, a vector for user defined follow face project direction.
VectorForAlong	Returns or sets the vectorForAlong, a vector for Along type orientation need.

Methods

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

Enumerations

PatternOrientationEnum Enumeration	pattern orientation options for all pattern types.
PatternOrientationProjDirEnum Enumeration	pattern follow face project direction options available.

Property Detail

AlongOrientationOption

PatternOrientation.AlongOrientationOption

Returns or sets the orientationOption for Along pattern type

-------------------------------------

Getter Method

Signature AlongOrientationOption

Returns: Return type:NXOpen.GeometricUtilities.PatternOrientationEnum

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AlongOrientationOption

Parameters:alongOrientationOption (NXOpen.GeometricUtilities.PatternOrientationEnum) –

New in version NX8.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

AlongPathRotationAngle

PatternOrientation.AlongPathRotationAngle

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

-------------------------------------

Getter Method

Signature AlongPathRotationAngle

Returns: Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: None.

CircularOrientationOption

PatternOrientation.CircularOrientationOption

Returns or sets the orientationOption for Circular pattern type

-------------------------------------

Getter Method

Signature CircularOrientationOption

Returns: Return type:NXOpen.GeometricUtilities.PatternOrientationEnum

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CircularOrientationOption

Parameters:circularOrientationOption (NXOpen.GeometricUtilities.PatternOrientationEnum) –

New in version NX8.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

FollowFaceProjDirOption

PatternOrientation.FollowFaceProjDirOption

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

-------------------------------------

Getter Method

Signature FollowFaceProjDirOption

Returns: Return type:NXOpen.GeometricUtilities.PatternOrientationProjDirEnum

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FollowFaceProjDirOption

Parameters:followFaceProjDirOption (NXOpen.GeometricUtilities.PatternOrientationProjDirEnum) –

New in version NX7.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

FollowFaceSelection

PatternOrientation.FollowFaceSelection

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

-------------------------------------

Getter Method

Signature FollowFaceSelection

Returns: Return type:NXOpen.ScCollector

New in version NX7.5.0.

License requirements: None.

FollowFaceToggle

PatternOrientation.FollowFaceToggle

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

-------------------------------------

Getter Method

Signature FollowFaceToggle

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FollowFaceToggle

Parameters:followFaceToggle (bool) –

New in version NX7.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

FromCSYS

PatternOrientation.FromCSYS

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

-------------------------------------

Getter Method

Signature FromCSYS

Returns: Return type:NXOpen.CoordinateSystem

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FromCSYS

Parameters:fromCSYS (NXOpen.CoordinateSystem) –

New in version NX7.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

GeneralOrientationOption

PatternOrientation.GeneralOrientationOption

Returns or sets the orientationOption for General pattern type

-------------------------------------

Getter Method

Signature GeneralOrientationOption

Returns: Return type:NXOpen.GeometricUtilities.PatternOrientationEnum

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature GeneralOrientationOption

Parameters:generalOrientationOption (NXOpen.GeometricUtilities.PatternOrientationEnum) –

New in version NX8.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

HelixOrientationOption

PatternOrientation.HelixOrientationOption

Returns or sets the orientationOption for Helix pattern type

-------------------------------------

Getter Method

Signature HelixOrientationOption

Returns: Return type:NXOpen.GeometricUtilities.PatternOrientationEnum

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature HelixOrientationOption

Parameters:helixOrientationOption (NXOpen.GeometricUtilities.PatternOrientationEnum) –

New in version NX9.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

LinearOrientationOption

PatternOrientation.LinearOrientationOption

Returns or sets the orientationOption for Linear pattern type

-------------------------------------

Getter Method

Signature LinearOrientationOption

Returns: Return type:NXOpen.GeometricUtilities.PatternOrientationEnum

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LinearOrientationOption

Parameters:linearOrientationOption (NXOpen.GeometricUtilities.PatternOrientationEnum) –

New in version NX8.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

MirrorOrientationOption

PatternOrientation.MirrorOrientationOption

Returns or sets the orientationOption for Mirror pattern type

-------------------------------------

Getter Method

Signature MirrorOrientationOption

Returns: Return type:NXOpen.GeometricUtilities.PatternOrientationEnum

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MirrorOrientationOption

Parameters:mirrorOrientationOption (NXOpen.GeometricUtilities.PatternOrientationEnum) –

New in version NX8.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

OrientationOption

PatternOrientation.OrientationOption

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`()

-------------------------------------

Getter Method

Signature OrientationOption

Returns: Return type:NXOpen.GeometricUtilities.PatternOrientationEnum

New in version NX7.5.0.

Deprecated since version NX8.0.0: The replacement function depends on the pattern type. See this method’s documentation for more detailed information.

License requirements: None.

-------------------------------------

Setter Method

Signature OrientationOption

Parameters:orientationOption (NXOpen.GeometricUtilities.PatternOrientationEnum) –

New in version NX7.5.0.

Deprecated since version NX8.0.0: The replacement function depends on the pattern type. See this method’s documentation for more detailed information.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

PolygonOrientationOption

PatternOrientation.PolygonOrientationOption

Returns or sets the orientationOption for Polygon pattern type

-------------------------------------

Getter Method

Signature PolygonOrientationOption

Returns: Return type:NXOpen.GeometricUtilities.PatternOrientationEnum

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PolygonOrientationOption

Parameters:polygonOrientationOption (NXOpen.GeometricUtilities.PatternOrientationEnum) –

New in version NX8.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

RepeatTransformSetting

PatternOrientation.RepeatTransformSetting

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

-------------------------------------

Getter Method

Signature RepeatTransformSetting

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RepeatTransformSetting

Parameters:repeatTransformSetting (bool) –

New in version NX9.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

SpiralOrientationOption

PatternOrientation.SpiralOrientationOption

Returns or sets the orientationOption for Spiral pattern type

-------------------------------------

Getter Method

Signature SpiralOrientationOption

Returns: Return type:NXOpen.GeometricUtilities.PatternOrientationEnum

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SpiralOrientationOption

Parameters:spiralOrientationOption (NXOpen.GeometricUtilities.PatternOrientationEnum) –

New in version NX8.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

ToCSYS

PatternOrientation.ToCSYS

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

-------------------------------------

Getter Method

Signature ToCSYS

Returns: Return type:NXOpen.CoordinateSystem

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ToCSYS

Parameters:toCSYS (NXOpen.CoordinateSystem) –

New in version NX7.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

UserDefinedProjDir

PatternOrientation.UserDefinedProjDir

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

-------------------------------------

Getter Method

Signature UserDefinedProjDir

Returns: Return type:NXOpen.Direction

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UserDefinedProjDir

Parameters:userDefinedProjDir (NXOpen.Direction) –

New in version NX7.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

VectorForAlong

PatternOrientation.VectorForAlong

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

-------------------------------------

Getter Method

Signature VectorForAlong

Returns: Return type:NXOpen.Direction

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature VectorForAlong

Parameters:vectorForAlong (NXOpen.Direction) –

New in version NX7.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

Method Detail

Validate

PatternOrientation.Validate

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.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.