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

Represents a NXOpen::Features::Geomcopy builder
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateGeomcopyBuilder
Default values. More...

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

Public Types

enum  AlongPathDistanceOptions { AlongPathDistanceOptionsFillPathLength, AlongPathDistanceOptionsArcLength }
 along path distance options More...
 
enum  CsysMirrorOptions { CsysMirrorOptionsMirrorXAndY, CsysMirrorOptionsMirrorYAndZ, CsysMirrorOptionsMirrorZAndX }
 CSYS mirror options. More...
 
enum  TransformTypes {
  TransformTypesBetweenLocations, TransformTypesMirror, TransformTypesTranslation, TransformTypesRotation,
  TransformTypesAlongCurve, TransformTypesOffset
}
 user input transform types. More...
 

Public Member Functions

NXOpen::ExpressionAlongPathAngle ()
 Returns the angle dimension used for along path type of instancing. More...
 
bool Associative ()
 Returns the associative, a logical flag to indicate if the copies are associative. More...
 
NXOpen::GeometricUtilities::BetweenLocationsDataBetweenLocations ()
 Returns the between locations data for between locations type of the transformation. More...
 
bool CopyThreads ()
 Returns the copy threads option
Created in NX8.0.0. More...
 
NXOpen::Features::GeomcopyBuilder::CsysMirrorOptions CsysMirrorOption ()
 Returns the Alternate Datum CSYS mirror method option
Created in NX6.0.0. More...
 
NXOpen::Features::GeomcopyBuilder::AlongPathDistanceOptions FillPathLength ()
 Returns the fill path length, a distance option for along path type of instancing. More...
 
NXOpen::SelectObjectListGeometryToInstance ()
 Returns the selected object list of geometry to instance. More...
 
bool HideOriginal ()
 Returns the hide original
Created in NX6.0.0. More...
 
NXOpen::PlaneMirrorPlane ()
 Returns the mirror plane for mirror type of instancing. More...
 
NXOpen::ExpressionNumberOfCopies ()
 Returns the number of copies to make for the geometry to instance. More...
 
NXOpen::GeometricUtilities::OnPathDimensionBuilderOnPathDistance ()
 Returns the onpath distance dimension used for along path type of instancing. More...
 
NXOpen::SectionPath ()
 Returns the section path for along path type of instancing. More...
 
NXOpen::ExpressionRotateAngle ()
 Returns the angle dimension used for rotation type of instancing. More...
 
NXOpen::ExpressionRotateDistance ()
 Returns the distance dimension used for rotation type of instancing. More...
 
NXOpen::AxisRotationAxis ()
 Returns the rotation axis for rotation type of instancing. More...
 
void SetAssociative (bool associative)
 Sets the associative, a logical flag to indicate if the copies are associative. More...
 
void SetCopyThreads (bool copyThreads)
 Sets the copy threads option
Created in NX8.0.0. More...
 
void SetCsysMirrorOption (NXOpen::Features::GeomcopyBuilder::CsysMirrorOptions csysMirrorOption)
 Sets the Alternate Datum CSYS mirror method option
Created in NX6.0.0. More...
 
void SetFillPathLength (NXOpen::Features::GeomcopyBuilder::AlongPathDistanceOptions fillPathLength)
 Sets the fill path length, a distance option for along path type of instancing. More...
 
void SetHideOriginal (bool hideOriginal)
 Sets the hide original
Created in NX6.0.0. More...
 
void SetMirrorPlane (NXOpen::Plane *mirrorPlane)
 Sets the mirror plane for mirror type of instancing. More...
 
void SetPath (NXOpen::Section *path)
 Sets the section path for along path type of instancing. More...
 
void SetRotationAxis (NXOpen::Axis *rotationAxis)
 Sets the rotation axis for rotation type of instancing. More...
 
void SetTranslationVector (NXOpen::Direction *translationVector)
 Sets the translation vector for translation type of instancing. More...
 
void SetType (NXOpen::Features::GeomcopyBuilder::TransformTypes transformType)
 Sets the transformation type of instancing, such as Between Locations, or Mirror. More...
 
NXOpen::ExpressionTranslateDistance ()
 Returns the distance dimension used for translation type of instancing. More...
 
NXOpen::DirectionTranslationVector ()
 Returns the translation vector for translation type of instancing. More...
 
NXOpen::Features::GeomcopyBuilder::TransformTypes Type ()
 Returns the transformation type of instancing, such as Between Locations, or Mirror. 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 NXOpen::Features::Geomcopy builder
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateGeomcopyBuilder
Default values.

Property Value

Associative

True

CopyThreads

True

CsysMirrorOption

MirrorYAndZ

FillPathLength

FillPathLength


Created in NX5.0.0.

Member Enumeration Documentation

along path distance options

Enumerator
AlongPathDistanceOptionsFillPathLength 

fill path length option

AlongPathDistanceOptionsArcLength 

arc length option

CSYS mirror options.

Enumerator
CsysMirrorOptionsMirrorXAndY 

Mirror X and Y and derive Z.

CsysMirrorOptionsMirrorYAndZ 

Mirror Y and Z and derive X.

CsysMirrorOptionsMirrorZAndX 

Mirror X and Z and derive Y.

user input transform types.

Enumerator
TransformTypesBetweenLocations 

between two point or csys locations

TransformTypesMirror 

mirror about a plane

TransformTypesTranslation 

translation along a direction

TransformTypesRotation 

rotation about an axis

TransformTypesAlongCurve 

along a path

TransformTypesOffset 

offset

Member Function Documentation

NXOpen::Expression* NXOpen::Features::GeomcopyBuilder::AlongPathAngle ( )

Returns the angle dimension used for along path type of instancing.


Created in NX5.0.0.

License requirements : None

bool NXOpen::Features::GeomcopyBuilder::Associative ( )

Returns the associative, a logical flag to indicate if the copies are associative.


Created in NX5.0.0.

License requirements : None

NXOpen::GeometricUtilities::BetweenLocationsData* NXOpen::Features::GeomcopyBuilder::BetweenLocations ( )

Returns the between locations data for between locations type of the transformation.


Created in NX5.0.0.

License requirements : None

bool NXOpen::Features::GeomcopyBuilder::CopyThreads ( )

Returns the copy threads option
Created in NX8.0.0.



License requirements : None

NXOpen::Features::GeomcopyBuilder::CsysMirrorOptions NXOpen::Features::GeomcopyBuilder::CsysMirrorOption ( )

Returns the Alternate Datum CSYS mirror method option
Created in NX6.0.0.



License requirements : None

NXOpen::Features::GeomcopyBuilder::AlongPathDistanceOptions NXOpen::Features::GeomcopyBuilder::FillPathLength ( )

Returns the fill path length, a distance option for along path type of instancing.


Created in NX5.0.0.

License requirements : None

NXOpen::SelectObjectList* NXOpen::Features::GeomcopyBuilder::GeometryToInstance ( )

Returns the selected object list of geometry to instance.


Created in NX5.0.0.

License requirements : None

bool NXOpen::Features::GeomcopyBuilder::HideOriginal ( )

Returns the hide original
Created in NX6.0.0.



License requirements : None

NXOpen::Plane* NXOpen::Features::GeomcopyBuilder::MirrorPlane ( )

Returns the mirror plane for mirror type of instancing.


Created in NX5.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::GeomcopyBuilder::NumberOfCopies ( )

Returns the number of copies to make for the geometry to instance.


Created in NX5.0.0.

License requirements : None

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::Features::GeomcopyBuilder::OnPathDistance ( )

Returns the onpath distance dimension used for along path type of instancing.


Created in NX5.0.0.

License requirements : None

NXOpen::Section* NXOpen::Features::GeomcopyBuilder::Path ( )

Returns the section path for along path type of instancing.


Created in NX5.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::GeomcopyBuilder::RotateAngle ( )

Returns the angle dimension used for rotation type of instancing.


Created in NX5.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::GeomcopyBuilder::RotateDistance ( )

Returns the distance dimension used for rotation type of instancing.


Created in NX5.0.0.

License requirements : None

NXOpen::Axis* NXOpen::Features::GeomcopyBuilder::RotationAxis ( )

Returns the rotation axis for rotation type of instancing.


Created in NX5.0.0.

License requirements : None

void NXOpen::Features::GeomcopyBuilder::SetAssociative ( bool  associative)

Sets the associative, a logical flag to indicate if the copies are associative.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
associativeassociative
void NXOpen::Features::GeomcopyBuilder::SetCopyThreads ( bool  copyThreads)

Sets the copy threads option
Created in NX8.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
copyThreadscopythreads
void NXOpen::Features::GeomcopyBuilder::SetCsysMirrorOption ( NXOpen::Features::GeomcopyBuilder::CsysMirrorOptions  csysMirrorOption)

Sets the Alternate Datum CSYS mirror method option
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
csysMirrorOptioncsysmirroroption
void NXOpen::Features::GeomcopyBuilder::SetFillPathLength ( NXOpen::Features::GeomcopyBuilder::AlongPathDistanceOptions  fillPathLength)

Sets the fill path length, a distance option for along path type of instancing.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
fillPathLengthfillpathlength
void NXOpen::Features::GeomcopyBuilder::SetHideOriginal ( bool  hideOriginal)

Sets the hide original
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
hideOriginalhideoriginal
void NXOpen::Features::GeomcopyBuilder::SetMirrorPlane ( NXOpen::Plane mirrorPlane)

Sets the mirror plane for mirror type of instancing.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
mirrorPlanemirrorplane
void NXOpen::Features::GeomcopyBuilder::SetPath ( NXOpen::Section path)

Sets the section path for along path type of instancing.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
pathpath
void NXOpen::Features::GeomcopyBuilder::SetRotationAxis ( NXOpen::Axis rotationAxis)

Sets the rotation axis for rotation type of instancing.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
rotationAxisrotationaxis
void NXOpen::Features::GeomcopyBuilder::SetTranslationVector ( NXOpen::Direction translationVector)

Sets the translation vector for translation type of instancing.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
translationVectortranslationvector
void NXOpen::Features::GeomcopyBuilder::SetType ( NXOpen::Features::GeomcopyBuilder::TransformTypes  transformType)

Sets the transformation type of instancing, such as Between Locations, or Mirror.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
transformTypetransform type
NXOpen::Expression* NXOpen::Features::GeomcopyBuilder::TranslateDistance ( )

Returns the distance dimension used for translation type of instancing.


Created in NX5.0.0.

License requirements : None

NXOpen::Direction* NXOpen::Features::GeomcopyBuilder::TranslationVector ( )

Returns the translation vector for translation type of instancing.


Created in NX5.0.0.

License requirements : None

NXOpen::Features::GeomcopyBuilder::TransformTypes NXOpen::Features::GeomcopyBuilder::Type ( )

Returns the transformation type of instancing, such as Between Locations, or Mirror.


Created in NX5.0.0.

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.