NXOpen::GeometricUtilities::PatternOrientation Class Reference

the pattern orientation definition. More...

Inheritance diagram for NXOpen::GeometricUtilities::PatternOrientation:

Public Types
enum	Enum {   EnumFixed, EnumNormalToPath, EnumNormalToVector, EnumParallelToVector,   EnumThroughAxis, EnumFollowPattern, EnumFollowCSYS, EnumCSYStoCSYS }
	pattern orientation options for all pattern types. More...
enum	ProjDirEnum { ProjDirEnumPatternPlaneNormal, ProjDirEnumNormalToFace, ProjDirEnumRadialDir, ProjDirEnumUserDefinedVector }
	pattern follow face project direction options available. More...

Public Member Functions
NXOpen::GeometricUtilities::PatternOrientation::Enum	AlongOrientationOption ()
	Returns the orientationOption for Along pattern type Created in NX8.0.0.
NXOpen::Expression *	AlongPathRotationAngle ()
	Returns the along path rotation angle for the Along type pattern Normal to Path option.
NXOpen::GeometricUtilities::PatternOrientation::Enum	CircularOrientationOption ()
	Returns the orientationOption for Circular pattern type Created in NX8.0.0.
NXOpen::GeometricUtilities::PatternOrientation::ProjDirEnum	FollowFaceProjDirOption ()
	Returns the followFaceProjDirOption, an enum for follow face project direction.
NXOpen::ScCollector *	FollowFaceSelection ()
	Returns the followFaceSelection, a sc collector to store selected faces.
bool	FollowFaceToggle ()
	Returns the followFaceToggle, a logical flag to indicate if the we need to modify the orientation to follow selected faces.
NXOpen::CoordinateSystem *	FromCSYS ()
	Returns the fromCSYS, a CSYS for certain pattern type orientation need.
NXOpen::GeometricUtilities::PatternOrientation::Enum	GeneralOrientationOption ()
	Returns the orientationOption for General pattern type Created in NX8.0.0.
NXOpen::GeometricUtilities::PatternOrientation::Enum	HelixOrientationOption ()
	Returns the orientationOption for Helix pattern type Created in NX9.0.0.
NXOpen::GeometricUtilities::PatternOrientation::Enum	LinearOrientationOption ()
	Returns the orientationOption for Linear pattern type Created in NX8.0.0.
NXOpen::GeometricUtilities::PatternOrientation::Enum	MirrorOrientationOption ()
	Returns the orientationOption for Mirror pattern type Created in NX8.0.0.
NXOpen::GeometricUtilities::PatternOrientation::Enum	OrientationOption ()
	Returns the orientationOption for rectangular pattern type Note: this one does not have a straight forward replacement; Replacement based on pattern type: GeometricUtilities::PatternOrientation::LinearOrientationOption and GeometricUtilities::PatternOrientation::SetLinearOrientationOption GeometricUtilities::PatternOrientation::CircularOrientationOption and GeometricUtilities::PatternOrientation::SetCircularOrientationOption GeometricUtilities::PatternOrientation::AlongOrientationOption and GeometricUtilities::PatternOrientation::SetAlongOrientationOption GeometricUtilities::PatternOrientation::PolygonOrientationOption and GeometricUtilities::PatternOrientation::SetPolygonOrientationOption GeometricUtilities::PatternOrientation::SpiralOrientationOption and GeometricUtilities::PatternOrientation::SetSpiralOrientationOption GeometricUtilities::PatternOrientation::GeneralOrientationOption and GeometricUtilities::PatternOrientation::SetGeneralOrientationOption GeometricUtilities::PatternOrientation::MirrorOrientationOption and GeometricUtilities::PatternOrientation::SetMirrorOrientationOption GeometricUtilities::PatternOrientation::HelixOrientationOption and GeometricUtilities::PatternOrientation::SetHelixOrientationOption
NXOpen::GeometricUtilities::PatternOrientation::Enum	PolygonOrientationOption ()
	Returns the orientationOption for Polygon pattern type Created in NX8.0.0.
bool	RepeatTransformSetting ()
	Returns the repeatTransformSetting, a logical flag to indicate if the we need to repeatedly apply the transform.
void	SetAlongOrientationOption (NXOpen::GeometricUtilities::PatternOrientation::Enum alongOrientationOption)
	Sets the orientationOption for Along pattern type Created in NX8.0.0.
void	SetCircularOrientationOption (NXOpen::GeometricUtilities::PatternOrientation::Enum circularOrientationOption)
	Sets the orientationOption for Circular pattern type Created in NX8.0.0.
void	SetFollowFaceProjDirOption (NXOpen::GeometricUtilities::PatternOrientation::ProjDirEnum followFaceProjDirOption)
	Sets the followFaceProjDirOption, an enum for follow face project direction.
void	SetFollowFaceToggle (bool followFaceToggle)
	Sets the followFaceToggle, a logical flag to indicate if the we need to modify the orientation to follow selected faces.
void	SetFromCSYS (NXOpen::CoordinateSystem *fromCSYS)
	Sets the fromCSYS, a CSYS for certain pattern type orientation need.
void	SetGeneralOrientationOption (NXOpen::GeometricUtilities::PatternOrientation::Enum generalOrientationOption)
	Sets the orientationOption for General pattern type Created in NX8.0.0.
void	SetHelixOrientationOption (NXOpen::GeometricUtilities::PatternOrientation::Enum helixOrientationOption)
	Sets the orientationOption for Helix pattern type Created in NX9.0.0.
void	SetLinearOrientationOption (NXOpen::GeometricUtilities::PatternOrientation::Enum linearOrientationOption)
	Sets the orientationOption for Linear pattern type Created in NX8.0.0.
void	SetMirrorOrientationOption (NXOpen::GeometricUtilities::PatternOrientation::Enum mirrorOrientationOption)
	Sets the orientationOption for Mirror pattern type Created in NX8.0.0.
void	SetOrientationOption (NXOpen::GeometricUtilities::PatternOrientation::Enum orientationOption)
	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 and GeometricUtilities::PatternOrientation::SetLinearOrientationOption GeometricUtilities::PatternOrientation::CircularOrientationOption and GeometricUtilities::PatternOrientation::SetCircularOrientationOption GeometricUtilities::PatternOrientation::AlongOrientationOption and GeometricUtilities::PatternOrientation::SetAlongOrientationOption GeometricUtilities::PatternOrientation::PolygonOrientationOption and GeometricUtilities::PatternOrientation::SetPolygonOrientationOption GeometricUtilities::PatternOrientation::SpiralOrientationOption and GeometricUtilities::PatternOrientation::SetSpiralOrientationOption GeometricUtilities::PatternOrientation::GeneralOrientationOption and GeometricUtilities::PatternOrientation::SetGeneralOrientationOption GeometricUtilities::PatternOrientation::MirrorOrientationOption and GeometricUtilities::PatternOrientation::SetMirrorOrientationOption GeometricUtilities::PatternOrientation::HelixOrientationOption and GeometricUtilities::PatternOrientation::SetHelixOrientationOption
void	SetPolygonOrientationOption (NXOpen::GeometricUtilities::PatternOrientation::Enum polygonOrientationOption)
	Sets the orientationOption for Polygon pattern type Created in NX8.0.0.
void	SetRepeatTransformSetting (bool repeatTransformSetting)
	Sets the repeatTransformSetting, a logical flag to indicate if the we need to repeatedly apply the transform.
void	SetSpiralOrientationOption (NXOpen::GeometricUtilities::PatternOrientation::Enum spiralOrientationOption)
	Sets the orientationOption for Spiral pattern type Created in NX8.0.0.
void	SetToCSYS (NXOpen::CoordinateSystem *toCSYS)
	Sets the toCSYS, a CSYS for certain pattern type orientation need.
void	SetUserDefinedProjDir (NXOpen::Direction *userDefinedProjDir)
	Sets the userDefinedProjDir, a vector for user defined follow face project direction.
void	SetVectorForAlong (NXOpen::Direction *vectorForAlong)
	Sets the vectorForAlong, a vector for Along type orientation need.
NXOpen::GeometricUtilities::PatternOrientation::Enum	SpiralOrientationOption ()
	Returns the orientationOption for Spiral pattern type Created in NX8.0.0.
NXOpen::CoordinateSystem *	ToCSYS ()
	Returns the toCSYS, a CSYS for certain pattern type orientation need.
NXOpen::Direction *	UserDefinedProjDir ()
	Returns the userDefinedProjDir, a vector for user defined follow face project direction.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
NXOpen::Direction *	VectorForAlong ()
	Returns the vectorForAlong, a vector for Along type orientation need.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

the pattern orientation definition.

Allows to specify an orientation option and corresponding entities.
Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::GeometricUtilities::PatternOrientation::Enum

pattern orientation options for all pattern types.

Enumerator:

EnumFixed	same orientation as the seed.
EnumNormalToPath	normal to path orientation for Along Type first direction.
EnumNormalToVector	normal to vector orientation for Along Type first direction.
EnumParallelToVector	parallel to vector orientation for Along Type first direction.
EnumThroughAxis	through axis orientation for Along Type first direction.
EnumFollowPattern	follow pattern orientation, for example, circular pattern type.
EnumFollowCSYS	follow CSYS orientation, for general pattern type, when from/to is CSYS.
EnumCSYStoCSYS	a relative orientation defined by two CSYSs to transform the seed to an instance location.

enum NXOpen::GeometricUtilities::PatternOrientation::ProjDirEnum

pattern follow face project direction options available.

Enumerator:

ProjDirEnumPatternPlaneNormal	use pattern plane normal as project direction.
ProjDirEnumNormalToFace	project along face normal.
ProjDirEnumRadialDir	project along radial direction. This is specific for Circular pattern type.
ProjDirEnumUserDefinedVector	project along user defined vector.

Member Function Documentation

NXOpen::GeometricUtilities::PatternOrientation::Enum NXOpen::GeometricUtilities::PatternOrientation::AlongOrientationOption

(

)

Returns the orientationOption for Along pattern type
Created in NX8.0.0.

License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::PatternOrientation::AlongPathRotationAngle

(

)

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

Created in NX9.0.0.

License requirements : None

NXOpen::GeometricUtilities::PatternOrientation::Enum NXOpen::GeometricUtilities::PatternOrientation::CircularOrientationOption

(

)

Returns the orientationOption for Circular pattern type
Created in NX8.0.0.

License requirements : None

NXOpen::GeometricUtilities::PatternOrientation::ProjDirEnum NXOpen::GeometricUtilities::PatternOrientation::FollowFaceProjDirOption

(

)

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

Created in NX7.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::GeometricUtilities::PatternOrientation::FollowFaceSelection

(

)

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

Created in NX7.5.0.

License requirements : None

bool NXOpen::GeometricUtilities::PatternOrientation::FollowFaceToggle

(

)

Returns 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 : None

NXOpen::CoordinateSystem* NXOpen::GeometricUtilities::PatternOrientation::FromCSYS

(

)

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

Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::PatternOrientation::Enum NXOpen::GeometricUtilities::PatternOrientation::GeneralOrientationOption

(

)

Returns the orientationOption for General pattern type
Created in NX8.0.0.

License requirements : None

NXOpen::GeometricUtilities::PatternOrientation::Enum NXOpen::GeometricUtilities::PatternOrientation::HelixOrientationOption

(

)

Returns the orientationOption for Helix pattern type
Created in NX9.0.0.

License requirements : None

NXOpen::GeometricUtilities::PatternOrientation::Enum NXOpen::GeometricUtilities::PatternOrientation::LinearOrientationOption

(

)

Returns the orientationOption for Linear pattern type
Created in NX8.0.0.

License requirements : None

NXOpen::GeometricUtilities::PatternOrientation::Enum NXOpen::GeometricUtilities::PatternOrientation::MirrorOrientationOption

(

)

Returns the orientationOption for Mirror pattern type
Created in NX8.0.0.

License requirements : None

NXOpen::GeometricUtilities::PatternOrientation::Enum NXOpen::GeometricUtilities::PatternOrientation::OrientationOption

(

)

Returns the orientationOption for rectangular pattern type Note: this one does not have a straight forward replacement; Replacement based on pattern type: GeometricUtilities::PatternOrientation::LinearOrientationOption and GeometricUtilities::PatternOrientation::SetLinearOrientationOption GeometricUtilities::PatternOrientation::CircularOrientationOption and GeometricUtilities::PatternOrientation::SetCircularOrientationOption GeometricUtilities::PatternOrientation::AlongOrientationOption and GeometricUtilities::PatternOrientation::SetAlongOrientationOption GeometricUtilities::PatternOrientation::PolygonOrientationOption and GeometricUtilities::PatternOrientation::SetPolygonOrientationOption GeometricUtilities::PatternOrientation::SpiralOrientationOption and GeometricUtilities::PatternOrientation::SetSpiralOrientationOption GeometricUtilities::PatternOrientation::GeneralOrientationOption and GeometricUtilities::PatternOrientation::SetGeneralOrientationOption GeometricUtilities::PatternOrientation::MirrorOrientationOption and GeometricUtilities::PatternOrientation::SetMirrorOrientationOption GeometricUtilities::PatternOrientation::HelixOrientationOption and GeometricUtilities::PatternOrientation::SetHelixOrientationOption

Deprecated:

Deprecated in NX8.0.0.

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

Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::PatternOrientation::Enum NXOpen::GeometricUtilities::PatternOrientation::PolygonOrientationOption

(

)

Returns the orientationOption for Polygon pattern type
Created in NX8.0.0.

License requirements : None

bool NXOpen::GeometricUtilities::PatternOrientation::RepeatTransformSetting

(

)

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

Created in NX9.0.0.

License requirements : None

void NXOpen::GeometricUtilities::PatternOrientation::SetAlongOrientationOption

(

NXOpen::GeometricUtilities::PatternOrientation::Enum

alongOrientationOption

)

Sets the orientationOption for Along pattern type
Created in NX8.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")

Parameters

alongOrientationOption

alongorientationoption

void NXOpen::GeometricUtilities::PatternOrientation::SetCircularOrientationOption

(

NXOpen::GeometricUtilities::PatternOrientation::Enum

circularOrientationOption

)

Sets the orientationOption for Circular pattern type
Created in NX8.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")

Parameters

circularOrientationOption

circularorientationoption

void NXOpen::GeometricUtilities::PatternOrientation::SetFollowFaceProjDirOption

(

NXOpen::GeometricUtilities::PatternOrientation::ProjDirEnum

followFaceProjDirOption

)

Sets the followFaceProjDirOption, an enum for follow face project direction.

Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")

Parameters

followFaceProjDirOption

followfaceprojdiroption

void NXOpen::GeometricUtilities::PatternOrientation::SetFollowFaceToggle

(

bool

followFaceToggle

)

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 : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")

Parameters

followFaceToggle

followfacetoggle

void NXOpen::GeometricUtilities::PatternOrientation::SetFromCSYS

(

NXOpen::CoordinateSystem *

fromCSYS

)

Sets the fromCSYS, a CSYS for certain pattern type orientation need.

Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")

Parameters

fromCSYS

fromcsys

void NXOpen::GeometricUtilities::PatternOrientation::SetGeneralOrientationOption

(

NXOpen::GeometricUtilities::PatternOrientation::Enum

generalOrientationOption

)

Sets the orientationOption for General pattern type
Created in NX8.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")

Parameters

generalOrientationOption

generalorientationoption

void NXOpen::GeometricUtilities::PatternOrientation::SetHelixOrientationOption

(

NXOpen::GeometricUtilities::PatternOrientation::Enum

helixOrientationOption

)

Sets the orientationOption for Helix pattern type
Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")

Parameters

helixOrientationOption

helixorientationoption

void NXOpen::GeometricUtilities::PatternOrientation::SetLinearOrientationOption

(

NXOpen::GeometricUtilities::PatternOrientation::Enum

linearOrientationOption

)

Sets the orientationOption for Linear pattern type
Created in NX8.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")

Parameters

linearOrientationOption

linearorientationoption

void NXOpen::GeometricUtilities::PatternOrientation::SetMirrorOrientationOption

(

NXOpen::GeometricUtilities::PatternOrientation::Enum

mirrorOrientationOption

)

Sets the orientationOption for Mirror pattern type
Created in NX8.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")

Parameters

mirrorOrientationOption

mirrororientationoption

void NXOpen::GeometricUtilities::PatternOrientation::SetOrientationOption

(

NXOpen::GeometricUtilities::PatternOrientation::Enum

orientationOption

)

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 and GeometricUtilities::PatternOrientation::SetLinearOrientationOption GeometricUtilities::PatternOrientation::CircularOrientationOption and GeometricUtilities::PatternOrientation::SetCircularOrientationOption GeometricUtilities::PatternOrientation::AlongOrientationOption and GeometricUtilities::PatternOrientation::SetAlongOrientationOption GeometricUtilities::PatternOrientation::PolygonOrientationOption and GeometricUtilities::PatternOrientation::SetPolygonOrientationOption GeometricUtilities::PatternOrientation::SpiralOrientationOption and GeometricUtilities::PatternOrientation::SetSpiralOrientationOption GeometricUtilities::PatternOrientation::GeneralOrientationOption and GeometricUtilities::PatternOrientation::SetGeneralOrientationOption GeometricUtilities::PatternOrientation::MirrorOrientationOption and GeometricUtilities::PatternOrientation::SetMirrorOrientationOption GeometricUtilities::PatternOrientation::HelixOrientationOption and GeometricUtilities::PatternOrientation::SetHelixOrientationOption

Deprecated:

Deprecated in NX8.0.0.

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

Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")

Parameters

orientationOption

orientationoption

void NXOpen::GeometricUtilities::PatternOrientation::SetPolygonOrientationOption

(

NXOpen::GeometricUtilities::PatternOrientation::Enum

polygonOrientationOption

)

Sets the orientationOption for Polygon pattern type
Created in NX8.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")

Parameters

polygonOrientationOption

polygonorientationoption

void NXOpen::GeometricUtilities::PatternOrientation::SetRepeatTransformSetting

(

bool

repeatTransformSetting

)

Sets the repeatTransformSetting, a logical flag to indicate if the we need to repeatedly apply the transform.

Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")

Parameters

repeatTransformSetting

repeattransformsetting

void NXOpen::GeometricUtilities::PatternOrientation::SetSpiralOrientationOption

(

NXOpen::GeometricUtilities::PatternOrientation::Enum

spiralOrientationOption

)

Sets the orientationOption for Spiral pattern type
Created in NX8.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")

Parameters

spiralOrientationOption

spiralorientationoption

void NXOpen::GeometricUtilities::PatternOrientation::SetToCSYS

(

NXOpen::CoordinateSystem *

toCSYS

)

Sets the toCSYS, a CSYS for certain pattern type orientation need.

Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")

Parameters

toCSYS

tocsys

void NXOpen::GeometricUtilities::PatternOrientation::SetUserDefinedProjDir

(

NXOpen::Direction *

userDefinedProjDir

)

Sets the userDefinedProjDir, a vector for user defined follow face project direction.

Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")

Parameters

userDefinedProjDir

userdefinedprojdir

void NXOpen::GeometricUtilities::PatternOrientation::SetVectorForAlong

(

NXOpen::Direction *

vectorForAlong

)

Sets the vectorForAlong, a vector for Along type orientation need.

Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")

Parameters

vectorForAlong

vectorforalong

NXOpen::GeometricUtilities::PatternOrientation::Enum NXOpen::GeometricUtilities::PatternOrientation::SpiralOrientationOption

(

)

Returns the orientationOption for Spiral pattern type
Created in NX8.0.0.

License requirements : None

NXOpen::CoordinateSystem* NXOpen::GeometricUtilities::PatternOrientation::ToCSYS

(

)

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

Created in NX5.0.0.

License requirements : None

NXOpen::Direction* NXOpen::GeometricUtilities::PatternOrientation::UserDefinedProjDir

(

)

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

Created in NX7.5.0.

License requirements : None

virtual bool NXOpen::GeometricUtilities::PatternOrientation::Validate ( )

virtual

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.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

NXOpen::Direction* NXOpen::GeometricUtilities::PatternOrientation::VectorForAlong

(

)

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

Created in NX7.5.0.

License requirements : None

---

The documentation for this class was generated from the following file:

• GeometricUtilities_PatternOrientation.hxx