NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Features::PatternFaceBuilder Class Reference

Represents a builder for a pattern face feature, don't use it until nx502. More...

Inheritance diagram for NXOpen::Features::PatternFaceBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  PatternTypes { PatternTypesRectangular, PatternTypesCircular, PatternTypesMirror }
 Enumeration of pattern type, don't use it until nx502
Created in NX5.0.2. More...
 

Public Member Functions

NXOpen::ExpressionAngle ()
 Returns the angle between circular pattern, don't use it until nx502
Created in NX5.0.2. More...
 
NXOpen::AxisAxis ()
 Returns the axis of circular pattern, don't use it until nx502
Created in NX5.0.2. More...
 
NXOpen::ExpressionCircularCount ()
 Returns the count of circular pattern, don't use it until nx502
Created in NX5.0.2. More...
 
NXOpen::ScCollectorFace ()
 Returns the faces to pattern, don't use it until nx502
Created in NX5.0.2. More...
 
NXOpen::SelectTaggedObjectPlane ()
 Returns the mirror plane of mirror pattern, don't use it until nx502
Created in NX5.0.2. More...
 
bool RestoreOption ()
 Returns the restore option for absent members. More...
 
void SetAxis (NXOpen::Axis *axis)
 Sets the axis of circular pattern, don't use it until nx502
Created in NX5.0.2. More...
 
void SetRestoreOption (bool restoreOption)
 Sets the restore option for absent members. More...
 
void SetType (NXOpen::Features::PatternFaceBuilder::PatternTypes patternType)
 Sets the pattern face type, don't use it until nx502
Created in NX5.0.2. More...
 
void SetXVector (NXOpen::Direction *xVector)
 Sets the X direction of rectangular pattern, don't use it until nx502
Created in NX5.0.2. More...
 
void SetYVector (NXOpen::Direction *yVector)
 Sets the Y direction of rectangular pattern, don't use it until nx502
Created in NX5.0.2. More...
 
NXOpen::Features::PatternFaceBuilder::PatternTypes Type ()
 Returns the pattern face type, don't use it until nx502
Created in NX5.0.2. More...
 
NXOpen::ExpressionXCount ()
 Returns the count of rectangular pattern along X direction, don't use it until nx502
Created in NX5.0.2. More...
 
NXOpen::ExpressionXDistance ()
 Returns the distance between rectangular pattern along X direction, don't use it until nx502
Created in NX5.0.2. More...
 
NXOpen::DirectionXVector ()
 Returns the X direction of rectangular pattern, don't use it until nx502
Created in NX5.0.2. More...
 
NXOpen::ExpressionYCount ()
 Returns the count of rectangular pattern along Y direction, don't use it until nx502
Created in NX5.0.2. More...
 
NXOpen::ExpressionYDistance ()
 Returns the distance between rectangular pattern along Y direction, don't use it until nx502
Created in NX5.0.2. More...
 
NXOpen::DirectionYVector ()
 Returns the Y direction of rectangular pattern, don't use it until nx502
Created in NX5.0.2. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 Returns the feature currently being edited by this builder. More...
 
void HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
bool ParentFeatureInternal ()
 Returns whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
bool PatchSolutionFlag ()
 Returns the patch solution flag
Created in NX8.0.1. More...
 
NXString PatchSurfaceFilename ()
 Returns the patch surface filename
Created in NX8.0.1. More...
 
void SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited
Created in NX6.0.0. More...
 
void SetParentFeatureInternal (bool isInternal)
 Sets whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
void SetPatchSolutionFlag (bool optionValue)
 Sets the patch solution flag
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const NXString &surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const char *surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
NXString SurroundingPatchSurfaceFilename ()
 Returns the surrounding patch surface filename
Created in NX8.0.1. More...
 
void UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the internal parent feature of the feature being edited to external
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a builder for a pattern face feature, don't use it until nx502.


To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreatePatternFaceBuilder
Default values.

Property Value

Angle.Value

90.0

CircularCount.Value

2

RestoreOption

False

XCount.Value

2

XDistance.Value

10.0 (millimeters part), 0.5 (inches part)

YCount.Value

2

YDistance.Value

10.0 (millimeters part), 0.5 (inches part)


Created in NX5.0.2.

Member Enumeration Documentation

Enumeration of pattern type, don't use it until nx502
Created in NX5.0.2.


Enumerator
PatternTypesRectangular 

This stands for rectangular pattern type.

PatternTypesCircular 

This stands for circular pattern type.

PatternTypesMirror 

This stands for mirror pattern type.

Member Function Documentation

NXOpen::Expression* NXOpen::Features::PatternFaceBuilder::Angle ( )

Returns the angle between circular pattern, don't use it until nx502
Created in NX5.0.2.



License requirements : None

NXOpen::Axis* NXOpen::Features::PatternFaceBuilder::Axis ( )

Returns the axis of circular pattern, don't use it until nx502
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::Features::PatternFaceBuilder::CircularCount ( )

Returns the count of circular pattern, don't use it until nx502
Created in NX5.0.2.



License requirements : None

NXOpen::ScCollector* NXOpen::Features::PatternFaceBuilder::Face ( )

Returns the faces to pattern, don't use it until nx502
Created in NX5.0.2.



License requirements : None

NXOpen::SelectTaggedObject* NXOpen::Features::PatternFaceBuilder::Plane ( )

Returns the mirror plane of mirror pattern, don't use it until nx502
Created in NX5.0.2.



License requirements : None

bool NXOpen::Features::PatternFaceBuilder::RestoreOption ( )

Returns the restore option for absent members.


Created in NX7.0.0.

License requirements : None

void NXOpen::Features::PatternFaceBuilder::SetAxis ( NXOpen::Axis axis)

Sets the axis of circular pattern, don't use it until nx502
Created in NX5.0.2.



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

Parameters
axisthe circular axis
void NXOpen::Features::PatternFaceBuilder::SetRestoreOption ( bool  restoreOption)

Sets the restore option for absent members.


Created in NX7.0.0.

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

Parameters
restoreOptionthe restore option
void NXOpen::Features::PatternFaceBuilder::SetType ( NXOpen::Features::PatternFaceBuilder::PatternTypes  patternType)

Sets the pattern face type, don't use it until nx502
Created in NX5.0.2.



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

Parameters
patternTypethe pattern face type
void NXOpen::Features::PatternFaceBuilder::SetXVector ( NXOpen::Direction xVector)

Sets the X direction of rectangular pattern, don't use it until nx502
Created in NX5.0.2.



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

Parameters
xVectorthe x direction
void NXOpen::Features::PatternFaceBuilder::SetYVector ( NXOpen::Direction yVector)

Sets the Y direction of rectangular pattern, don't use it until nx502
Created in NX5.0.2.



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

Parameters
yVectorthe y direction
NXOpen::Features::PatternFaceBuilder::PatternTypes NXOpen::Features::PatternFaceBuilder::Type ( )

Returns the pattern face type, don't use it until nx502
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::Features::PatternFaceBuilder::XCount ( )

Returns the count of rectangular pattern along X direction, don't use it until nx502
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::Features::PatternFaceBuilder::XDistance ( )

Returns the distance between rectangular pattern along X direction, don't use it until nx502
Created in NX5.0.2.



License requirements : None

NXOpen::Direction* NXOpen::Features::PatternFaceBuilder::XVector ( )

Returns the X direction of rectangular pattern, don't use it until nx502
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::Features::PatternFaceBuilder::YCount ( )

Returns the count of rectangular pattern along Y direction, don't use it until nx502
Created in NX5.0.2.



License requirements : None

NXOpen::Expression* NXOpen::Features::PatternFaceBuilder::YDistance ( )

Returns the distance between rectangular pattern along Y direction, don't use it until nx502
Created in NX5.0.2.



License requirements : None

NXOpen::Direction* NXOpen::Features::PatternFaceBuilder::YVector ( )

Returns the Y direction of rectangular pattern, don't use it until nx502
Created in NX5.0.2.



License requirements : None


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