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

Represents a NXOpen::Features::MirrorBody builder. More...

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

Public Types

enum  FeatureOptionType { FeatureOptionTypeOneFeatureForAllBodies, FeatureOptionTypeSeparateFeatureForEachBody }
 enum for feature option type More...
 
enum  ParentPart { ParentPartWorkPart, ParentPartOtherPart }
 the parent part types More...
 

Public Member Functions

bool Associative ()
 Returns the associative. More...
 
bool CopyThreads ()
 Returns the copy threads option
Created in NX8.0.0. More...
 
NXOpen::Features::MirrorBodyBuilder::FeatureOptionType FeatureOption ()
 Returns the feature option type
Created in NX9.0.3. More...
 
bool FixAtCurrentTimestamp ()
 Returns the fix at current timestamp
Created in NX5.0.0. More...
 
NXOpen::Features::FeatureFrecAtTimeStamp ()
 Returns the frec at time stamp
Created in NX5.0.0. More...
 
void GetProductInterfaceObjects (std::vector< NXOpen::Assemblies::ProductInterface::InterfaceObject * > &selectedObjects)
 Gets selected product interface objects
Created in NX9.0.0. More...
 
void GetSourcePartOccurrences (std::vector< NXOpen::TaggedObject * > &sourcePartOccurrences)
 Gets source part occurrences
Created in NX10.0.0. More...
 
void GetWaveLinkInformation (NXString *info, bool *xformExists, NXOpen::Point3d *xformOrigin, NXOpen::Matrix3x3 *xformOrientation, double *xformScale)
 Prints wave browser type information about link
Created in NX6.0.0. More...
 
bool InheritDisplayProperties ()
 Returns the inherit display properties from source option
Created in NX6.0.0. More...
 
bool MakePositionIndependent ()
 Returns the make position independent
Created in NX5.0.0. More...
 
NXOpen::ScCollectorMirrorBodyCollector ()
 Returns a collection of bodies to mirror
Created in NX9.0.0. More...
 
NXOpen::SelectBodyListMirrorBodyList ()
 Returns the mirror body list. More...
 
NXOpen::Features::MirrorBodyBuilder::ParentPart ParentPartType ()
 Returns the parent part type
Created in NX5.0.0. More...
 
NXOpen::SelectDatumPlanePlane ()
 Returns the mirror plane. More...
 
NXOpen::GeometricUtilities::ReplAsstBuilderReplacementAssistant ()
 Returns the Replacement Assistant builder. More...
 
bool ReverseDirection ()
 Returns the reverse direction. More...
 
void SetAssociative (bool associative)
 Sets the associative. More...
 
void SetCopyThreads (bool copyThreads)
 Sets the copy threads option
Created in NX8.0.0. More...
 
void SetFeatureOption (NXOpen::Features::MirrorBodyBuilder::FeatureOptionType featureOptionType)
 Sets the feature option type
Created in NX9.0.3. More...
 
void SetFixAtCurrentTimestamp (bool atTimeStamp)
 Sets the fix at current timestamp
Created in NX5.0.0. More...
 
void SetFrecAtTimeStamp (NXOpen::Features::Feature *terminalFrec)
 Sets the frec at time stamp
Created in NX5.0.0. More...
 
void SetInheritDisplayProperties (bool inheritDisplayProperties)
 Sets the inherit display properties from source option
Created in NX6.0.0. More...
 
void SetMakePositionIndependent (bool makePositionIndependent)
 Sets the make position independent
Created in NX5.0.0. More...
 
void SetParentPartType (NXOpen::Features::MirrorBodyBuilder::ParentPart sourceType)
 Sets the parent part type
Created in NX5.0.0. More...
 
void SetProductInterfaceObjects (const std::vector< NXOpen::Assemblies::ProductInterface::InterfaceObject * > &selectedObjects)
 Sets selected product interface objects
Created in NX9.0.0. More...
 
void SetReverseDirection (bool reverse)
 Sets the reverse direction. More...
 
void SetSourcePartOccurrence (NXOpen::TaggedObject *sourcePartOcc)
 Sets the source part occurrence
Created in NX9.0.0. More...
 
void SetSourcePartOccurrences (const std::vector< NXOpen::TaggedObject * > &sourcePartOccurrences)
 Sets source part occurrences
Created in NX10.0.0. More...
 
NXOpen::TaggedObjectSourcePartOccurrence ()
 Returns the source part occurrence
Created in NX9.0.0. 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::MirrorBody builder.

Inputs to this class can be convergent objects.
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateMirrorBodyBuilder
Default values.

Property Value

Associative

True

CopyThreads

True

FixAtCurrentTimestamp

True

InheritDisplayProperties

False

MakePositionIndependent

False

ParentPartType

WorkPart

ReplacementAssistant.OneToOne

True


Created in NX5.0.0.

Member Enumeration Documentation

enum for feature option type

Enumerator
FeatureOptionTypeOneFeatureForAllBodies 

An option to create one mirror or linked mirror body feature for all selected bodies as body collector.

FeatureOptionTypeSeparateFeatureForEachBody 

An option to create a separate mirror or linked mirror body feature per single body.

the parent part types

Enumerator
ParentPartWorkPart 

Work Part.

ParentPartOtherPart 

Other Part.

Member Function Documentation

bool NXOpen::Features::MirrorBodyBuilder::Associative ( )

Returns the associative.


Created in NX5.0.0.

License requirements : None

bool NXOpen::Features::MirrorBodyBuilder::CopyThreads ( )

Returns the copy threads option
Created in NX8.0.0.



License requirements : None

NXOpen::Features::MirrorBodyBuilder::FeatureOptionType NXOpen::Features::MirrorBodyBuilder::FeatureOption ( )

Returns the feature option type
Created in NX9.0.3.



License requirements : None

bool NXOpen::Features::MirrorBodyBuilder::FixAtCurrentTimestamp ( )

Returns the fix at current timestamp
Created in NX5.0.0.



License requirements : None

NXOpen::Features::Feature* NXOpen::Features::MirrorBodyBuilder::FrecAtTimeStamp ( )

Returns the frec at time stamp
Created in NX5.0.0.



License requirements : None

void NXOpen::Features::MirrorBodyBuilder::GetProductInterfaceObjects ( std::vector< NXOpen::Assemblies::ProductInterface::InterfaceObject * > &  selectedObjects)

Gets selected product interface objects
Created in NX9.0.0.



License requirements : None

Parameters
selectedObjectsitems in list
void NXOpen::Features::MirrorBodyBuilder::GetSourcePartOccurrences ( std::vector< NXOpen::TaggedObject * > &  sourcePartOccurrences)

Gets source part occurrences
Created in NX10.0.0.



License requirements : None

Parameters
sourcePartOccurrencessourcepartoccurrences
void NXOpen::Features::MirrorBodyBuilder::GetWaveLinkInformation ( NXString info,
bool *  xformExists,
NXOpen::Point3d xformOrigin,
NXOpen::Matrix3x3 xformOrientation,
double *  xformScale 
)

Prints wave browser type information about link
Created in NX6.0.0.



License requirements : wave ("WAVE FUNCTIONALITY")

Parameters
infoqueried wave information
xformExiststrue if there is a transform
xformOrigintransformation origin
xformOrientationtransformation matrix
xformScaletransformation scale
bool NXOpen::Features::MirrorBodyBuilder::InheritDisplayProperties ( )

Returns the inherit display properties from source option
Created in NX6.0.0.



License requirements : None

bool NXOpen::Features::MirrorBodyBuilder::MakePositionIndependent ( )

Returns the make position independent
Created in NX5.0.0.



License requirements : None

NXOpen::ScCollector* NXOpen::Features::MirrorBodyBuilder::MirrorBodyCollector ( )

Returns a collection of bodies to mirror
Created in NX9.0.0.



License requirements : None

NXOpen::SelectBodyList* NXOpen::Features::MirrorBodyBuilder::MirrorBodyList ( )

Returns the mirror body list.

For KF, only one parent body should be selected for this attribute.


Deprecated:
Deprecated in NX9.0.0. Use NXOpen::Features::MirrorBodyBuilder::MirrorBodyCollector instead.


Created in NX5.0.0.

License requirements : None

NXOpen::Features::MirrorBodyBuilder::ParentPart NXOpen::Features::MirrorBodyBuilder::ParentPartType ( )

Returns the parent part type
Created in NX5.0.0.



License requirements : None

NXOpen::SelectDatumPlane* NXOpen::Features::MirrorBodyBuilder::Plane ( )

Returns the mirror plane.


Created in NX5.0.0.

License requirements : None

NXOpen::GeometricUtilities::ReplAsstBuilder* NXOpen::Features::MirrorBodyBuilder::ReplacementAssistant ( )

Returns the Replacement Assistant builder.

Call Enter() to enter or re-enter into the mapping environment. Enter() needs to be executed before invoking any map creation or automatic matching APIs. The matches inferred internally (internal identifier reuse, inherited from parent and siblings) will be populated when Enter() is executed for the first time after selecting a replacement entity. Call Exit() to exit the mapping environment.
Created in NX6.0.0.

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

bool NXOpen::Features::MirrorBodyBuilder::ReverseDirection ( )

Returns the reverse direction.


Created in NX5.0.0.

License requirements : None

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

Sets the associative.


Created in NX5.0.0.

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

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

Sets the copy threads option
Created in NX8.0.0.



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

Parameters
copyThreadscopythreads
void NXOpen::Features::MirrorBodyBuilder::SetFeatureOption ( NXOpen::Features::MirrorBodyBuilder::FeatureOptionType  featureOptionType)

Sets the feature option type
Created in NX9.0.3.



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

Parameters
featureOptionTypefeatureoptiontype
void NXOpen::Features::MirrorBodyBuilder::SetFixAtCurrentTimestamp ( bool  atTimeStamp)

Sets the fix at current timestamp
Created in NX5.0.0.



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

Parameters
atTimeStampattimestamp
void NXOpen::Features::MirrorBodyBuilder::SetFrecAtTimeStamp ( NXOpen::Features::Feature terminalFrec)

Sets the frec at time stamp
Created in NX5.0.0.



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

Parameters
terminalFrecterminal frec
void NXOpen::Features::MirrorBodyBuilder::SetInheritDisplayProperties ( bool  inheritDisplayProperties)

Sets the inherit display properties from source option
Created in NX6.0.0.



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

Parameters
inheritDisplayPropertiesinheritdisplayproperties
void NXOpen::Features::MirrorBodyBuilder::SetMakePositionIndependent ( bool  makePositionIndependent)

Sets the make position independent
Created in NX5.0.0.



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

Parameters
makePositionIndependentmakepositionindependent
void NXOpen::Features::MirrorBodyBuilder::SetParentPartType ( NXOpen::Features::MirrorBodyBuilder::ParentPart  sourceType)

Sets the parent part type
Created in NX5.0.0.



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

Parameters
sourceTypesourcetype
void NXOpen::Features::MirrorBodyBuilder::SetProductInterfaceObjects ( const std::vector< NXOpen::Assemblies::ProductInterface::InterfaceObject * > &  selectedObjects)

Sets selected product interface objects
Created in NX9.0.0.



License requirements : None

Parameters
selectedObjectsitems in list
void NXOpen::Features::MirrorBodyBuilder::SetReverseDirection ( bool  reverse)

Sets the reverse direction.


Created in NX5.0.0.

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

Parameters
reversereverse
void NXOpen::Features::MirrorBodyBuilder::SetSourcePartOccurrence ( NXOpen::TaggedObject sourcePartOcc)

Sets the source part occurrence
Created in NX9.0.0.



License requirements : None

Parameters
sourcePartOccsourcepartocc
void NXOpen::Features::MirrorBodyBuilder::SetSourcePartOccurrences ( const std::vector< NXOpen::TaggedObject * > &  sourcePartOccurrences)

Sets source part occurrences
Created in NX10.0.0.



License requirements : None

Parameters
sourcePartOccurrencessourcepartoccurrences
NXOpen::TaggedObject* NXOpen::Features::MirrorBodyBuilder::SourcePartOccurrence ( )

Returns the source part occurrence
Created in NX9.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.