NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::GeometricUtilities::PatternOrientation Class Reference

the pattern orientation definition. More...

Inheritance diagram for NXOpen::GeometricUtilities::PatternOrientation:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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::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::ScCollectorFollowFaceSelection ()
 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::CoordinateSystemFromCSYS ()
 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 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

NXOpen::GeometricUtilities::PatternOrientation::Enum PolygonOrientationOption ()
 Returns the orientationOption for Polygon pattern type
Created in NX8.0.0.
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 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

void SetPolygonOrientationOption (NXOpen::GeometricUtilities::PatternOrientation::Enum polygonOrientationOption)
 Sets the orientationOption for Polygon pattern type
Created in NX8.0.0.
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::CoordinateSystemToCSYS ()
 Returns the toCSYS, a CSYS for certain pattern type orientation need.
NXOpen::DirectionUserDefinedProjDir ()
 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::DirectionVectorForAlong ()
 Returns the vectorForAlong, a vector for Along type orientation need.

Detailed Description

the pattern orientation definition.

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


Member Enumeration Documentation

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.

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

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



License requirements : None

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



License requirements : None

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


Created in NX7.5.0.

License requirements : None

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


Created in NX7.5.0.

License requirements : None

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

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


Created in NX7.5.0.

License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

Returns the orientationOption for rectangular pattern type

Deprecated:
Deprecated in NX8.0.0.



Created in NX7.5.0.

License requirements : None

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



License requirements : None

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



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
alongOrientationOptionalongorientationoption

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



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
circularOrientationOptioncircularorientationoption

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


Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
followFaceProjDirOptionfollowfaceprojdiroption

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")

Parameters:
followFaceTogglefollowfacetoggle

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


Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
fromCSYSfromcsys

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



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
generalOrientationOptiongeneralorientationoption

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



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
linearOrientationOptionlinearorientationoption

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



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
mirrorOrientationOptionmirrororientationoption

Sets the orientationOption for rectangular pattern type

Deprecated:
Deprecated in NX8.0.0.



Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
orientationOptionorientationoption

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



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
polygonOrientationOptionpolygonorientationoption

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



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
spiralOrientationOptionspiralorientationoption

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


Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
toCSYStocsys

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


Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
userDefinedProjDiruserdefinedprojdir

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


Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
vectorForAlongvectorforalong

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



License requirements : None

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


Created in NX5.0.0.

License requirements : None

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


Created in NX7.5.0.

License requirements : None

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.

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.