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

Represents a WaveSketchBuilder. More...

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

Public Types

enum  ParentPartType { ParentPartTypeWorkPart, ParentPartTypeOtherPart }
 enum for scope of part More...
 

Public Member Functions

bool Associative ()
 Returns the associative
Created in NX5.0.1. More...
 
NXOpen::Features::FeatureCommitCreateOnTheFly ()
 Commits the feature and set create on the fly flag. More...
 
bool DisplayReferenceGeometry ()
 Returns the setting that controls whether or not the reference geometry in the linked sketch are displayed
Created in NX11.0.1. 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 HideOriginal ()
 Returns the hide original option
Created in NX5.0.1. More...
 
bool InheritDisplayProperties ()
 Returns the inherit display property option
Created in NX6.0.0. More...
 
bool MakePositionIndependent ()
 Returns the make position independent option
Created in NX5.0.1. More...
 
NXOpen::Features::WaveSketchBuilder::ParentPartType ParentPart ()
 Returns the source part type
Created in NX11.0.1. More...
 
void SetAssociative (bool associative)
 Sets the associative
Created in NX5.0.1. More...
 
void SetDisplayReferenceGeometry (bool displayReferenceGeometry)
 Sets the setting that controls whether or not the reference geometry in the linked sketch are displayed
Created in NX11.0.1. More...
 
void SetHideOriginal (bool hideoriginal)
 Sets the hide original option
Created in NX5.0.1. More...
 
void SetInheritDisplayProperties (bool inheritDisplayProperties)
 Sets the inherit display property option
Created in NX6.0.0. More...
 
void SetMakePositionIndependent (bool makePositionIndependent)
 Sets the make position independent option
Created in NX5.0.1. More...
 
void SetParentPart (NXOpen::Features::WaveSketchBuilder::ParentPartType parentPart)
 Sets the source part type
Created in NX11.0.1. More...
 
void SetProductInterfaceObjects (const std::vector< NXOpen::Assemblies::ProductInterface::InterfaceObject * > &selectedObjects)
 Sets selected product interface objects
Created in NX9.0.0. 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::SelectTaggedObjectListSketches ()
 Returns the sketch to link
Created in NX5.0.1. 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 WaveSketchBuilder.


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

Property Value

Associative

True

DisplayReferenceGeometry

False

InheritDisplayProperties

False

ParentPart

OtherPart


Created in NX5.0.1.

Member Enumeration Documentation

enum for scope of part

Enumerator
ParentPartTypeWorkPart 

intra part mode

ParentPartTypeOtherPart 

inter part mode

Member Function Documentation

bool NXOpen::Features::WaveSketchBuilder::Associative ( )

Returns the associative
Created in NX5.0.1.



License requirements : None

NXOpen::Features::Feature* NXOpen::Features::WaveSketchBuilder::CommitCreateOnTheFly ( )

Commits the feature and set create on the fly flag.

Returns

Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")
bool NXOpen::Features::WaveSketchBuilder::DisplayReferenceGeometry ( )

Returns the setting that controls whether or not the reference geometry in the linked sketch are displayed
Created in NX11.0.1.



License requirements : None

void NXOpen::Features::WaveSketchBuilder::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::WaveSketchBuilder::GetSourcePartOccurrences ( std::vector< NXOpen::TaggedObject * > &  sourcePartOccurrences)

Gets source part occurrences
Created in NX10.0.0.



License requirements : None

Parameters
sourcePartOccurrencessourcepartoccurrences
void NXOpen::Features::WaveSketchBuilder::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::WaveSketchBuilder::HideOriginal ( )

Returns the hide original option
Created in NX5.0.1.



License requirements : None

bool NXOpen::Features::WaveSketchBuilder::InheritDisplayProperties ( )

Returns the inherit display property option
Created in NX6.0.0.



License requirements : None

bool NXOpen::Features::WaveSketchBuilder::MakePositionIndependent ( )

Returns the make position independent option
Created in NX5.0.1.



License requirements : None

NXOpen::Features::WaveSketchBuilder::ParentPartType NXOpen::Features::WaveSketchBuilder::ParentPart ( )

Returns the source part type
Created in NX11.0.1.



License requirements : None

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

Sets the associative
Created in NX5.0.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
associativeassociative
void NXOpen::Features::WaveSketchBuilder::SetDisplayReferenceGeometry ( bool  displayReferenceGeometry)

Sets the setting that controls whether or not the reference geometry in the linked sketch are displayed
Created in NX11.0.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
displayReferenceGeometrydisplayreferencegeometry
void NXOpen::Features::WaveSketchBuilder::SetHideOriginal ( bool  hideoriginal)

Sets the hide original option
Created in NX5.0.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
hideoriginalhideoriginal
void NXOpen::Features::WaveSketchBuilder::SetInheritDisplayProperties ( bool  inheritDisplayProperties)

Sets the inherit display property option
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

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

Sets the make position independent option
Created in NX5.0.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
makePositionIndependentmakepositionindependent
void NXOpen::Features::WaveSketchBuilder::SetParentPart ( NXOpen::Features::WaveSketchBuilder::ParentPartType  parentPart)

Sets the source part type
Created in NX11.0.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
parentPartparentpart
void NXOpen::Features::WaveSketchBuilder::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::WaveSketchBuilder::SetSourcePartOccurrence ( NXOpen::TaggedObject sourcePartOcc)

Sets the source part occurrence
Created in NX9.0.0.



License requirements : None

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

Sets source part occurrences
Created in NX10.0.0.



License requirements : None

Parameters
sourcePartOccurrencessourcepartoccurrences
NXOpen::SelectTaggedObjectList* NXOpen::Features::WaveSketchBuilder::Sketches ( )

Returns the sketch to link
Created in NX5.0.1.



License requirements : None

NXOpen::TaggedObject* NXOpen::Features::WaveSketchBuilder::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.