NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAM::FBM::FeatureGeometry Class Reference

Represents a feature geometry builder
This is an abstract class and cannot be instantiated. More...

Inheritance diagram for NXOpen::CAM::FBM::FeatureGeometry:
NXOpen::CAM::Geometry NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::CAM::FBM::MachiningFeatureGeometry NXOpen::CAM::FBM::ThreadFeatureGeometry NXOpen::CAM::OptimizeFeatureGeometry

Public Types

enum  SequenceDirectionType { SequenceDirectionTypeXm, SequenceDirectionTypeYm, SequenceDirectionTypeZm, SequenceDirectionTypeVector }
 the direction types
Created in NX9.0.2. More...
 
enum  SequencePatternType { SequencePatternTypeZig, SequencePatternTypeZigZag }
 the pattern types
Created in NX9.0.2. More...
 
enum  SortOrder { SortOrderClosest, SortOrderShortestPath, SortOrderPrimaryDirection }
 the optimization types
Created in NX9.0.1. More...
 

Public Member Functions

NXOpen::CAM::FBM::FeatureSetAddFeatureSet (NXOpen::CAM::CAMFeature *tagMachiningFeature, const NXString &featureType)
 Creates a feature geometry set. More...
 
NXOpen::CAM::FBM::FeatureSetAddFeatureSet (NXOpen::CAM::CAMFeature *tagMachiningFeature, const char *featureType)
 Creates a feature geometry set. More...
 
std::vector
< NXOpen::CAM::FBM::Feature * > 
CreateFeatures (const std::vector< NXOpen::NXObject * > &objects, const NXString &featureType)
 Create a series of (in process) features. More...
 
std::vector
< NXOpen::CAM::FBM::Feature * > 
CreateFeatures (const std::vector< NXOpen::NXObject * > &objects, const char *featureType)
 Create a series of (in process) features. More...
 
NXOpen::CAM::FBM::FeatureSetCreateFeatureSet ()
 Create a new empty feature editor. More...
 
NXOpen::CAM::FBM::FeatureSetGetFeatureSet (int nIndex)
 Get the in process feature editor at the specified index. More...
 
NXString GetMachiningArea ()
 Returns the machining area. More...
 
void ReloadList ()
 Reload list from parent
Created in NX9.0.2. More...
 
void ReorderFeatures (NXOpen::CAM::FBM::FeatureGeometry::SortOrder sortType)
 Reorders the features according to a predefined algorithm
Created in NX9.0.1. More...
 
void ReorderFeaturesByDirection (NXOpen::CAM::FBM::FeatureGeometry::SequenceDirectionType direction, NXOpen::CAM::FBM::FeatureGeometry::SequencePatternType pattern, const NXOpen::Vector3d &vecValue)
 Reorders the features according to primary direction
Created in NX9.0.2. More...
 
void ReorderFeaturesByDirection (NXOpen::CAM::FBM::FeatureGeometry::SequenceDirectionType direction, NXOpen::CAM::FBM::FeatureGeometry::SequencePatternType pattern, const NXOpen::Vector3d &vecValue, double bandWidth)
 Reorders the features according to primary direction with band width
Created in NX9.0.3. More...
 
void ReverseFeatures ()
 Reverse the features
Created in NX9.0.2. More...
 
void SetDefaultAttribute (const NXString &attributeName, double dValue)
 Sets a default attribute value
Created in NX9.0.1. More...
 
void SetDefaultAttribute (const char *attributeName, double dValue)
 Sets a default attribute value
Created in NX9.0.1. More...
 
void SetDefaultAttribute (const NXString &attributeName, const NXString &strValue)
 Sets a default attribute value
Created in NX9.0.1. More...
 
void SetDefaultAttribute (const char *attributeName, const char *strValue)
 Sets a default attribute value
Created in NX9.0.1. More...
 
void SetDefaultAttribute (const NXString &attributeName, int nValue)
 Sets a default attribute value
Created in NX9.0.1. More...
 
void SetDefaultAttribute (const char *attributeName, int nValue)
 Sets a default attribute value
Created in NX9.0.1. More...
 
void SetDefaultAttribute (const NXString &attributeName, bool bValue)
 Sets a default attribute value
Created in NX9.0.1. More...
 
void SetDefaultAttribute (const char *attributeName, bool bValue)
 Sets a default attribute value
Created in NX9.0.1. More...
 
void SetMachiningArea (const NXString &machiningArea)
 Change machining area
Created in NX9.0.2. More...
 
void SetMachiningArea (const char *machiningArea)
 Change machining area
Created in NX9.0.2. More...
 
void SetUseModelDepth (bool flag)
 Sets the use model depth flag
Created in NX11.0.2. More...
 
bool UseModelDepth ()
 Returns the use model depth flag
Created in NX11.0.2. More...
 
- Public Member Functions inherited from NXOpen::CAM::Geometry
NXOpen::CAM::GeometrySetAppendGeometrySet (NXOpen::CAM::GeometrySet *templateSet, const std::vector< NXOpen::DisplayableObject * > &entities)
 Append an geometry set with dumb rules. More...
 
void AppendNamedGeometry (const std::vector< NXOpen::ScCollector * > &namedGeometry)
 Append named geometry
Created in NX9.0.3. More...
 
NXOpen::CAM::GeometrySetCreateGeometrySet ()
 Create an empty geometry set. More...
 
void ExpandSets (const std::vector< NXOpen::CAM::GeometrySet * > &sets)
 Expanding the geometry sets
Created in NX8.0.0. More...
 
NXOpen::CAM::GeometrySetListGeometryList ()
 Returns the geometry list
Created in NX8.0.0. More...
 
void InitializeData (bool reloadGeometry)
 Prepare and update geometry data
Created in NX8.0.0. More...
 
void PreselectGeometry ()
 Pre-select the wall geometry
Created in NX8.0.0. More...
 
NXOpen::CAM::TopologyTopology ()
 Returns the topology builder
Created in NX8.0.0. 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 feature geometry builder
This is an abstract class and cannot be instantiated.



Created in NX9.0.1.

Member Enumeration Documentation

the direction types
Created in NX9.0.2.


Enumerator
SequenceDirectionTypeXm 

Direction: XM.

SequenceDirectionTypeYm 

Direction: YM.

SequenceDirectionTypeZm 

Direction: ZM.

SequenceDirectionTypeVector 

Direction: Vector.

the pattern types
Created in NX9.0.2.


Enumerator
SequencePatternTypeZig 

Pattern: Zig.

SequencePatternTypeZigZag 

Pattern: Zig Zag.

the optimization types
Created in NX9.0.1.


Enumerator
SortOrderClosest 

Sort order: Closet.

SortOrderShortestPath 

Sort order: Shortest Path.

SortOrderPrimaryDirection 

Sort order: Primary Direction.

Member Function Documentation

NXOpen::CAM::FBM::FeatureSet* NXOpen::CAM::FBM::FeatureGeometry::AddFeatureSet ( NXOpen::CAM::CAMFeature tagMachiningFeature,
const NXString featureType 
)

Creates a feature geometry set.

Returns
the new in process feature set
Created in NX9.0.1.

License requirements : cam_base ("CAM BASE")
Parameters
tagMachiningFeaturethe machining feature
featureTypethe in process feature type
NXOpen::CAM::FBM::FeatureSet* NXOpen::CAM::FBM::FeatureGeometry::AddFeatureSet ( NXOpen::CAM::CAMFeature tagMachiningFeature,
const char *  featureType 
)

Creates a feature geometry set.

Returns
the new in process feature set
Created in NX9.0.1.

License requirements : cam_base ("CAM BASE")
Parameters
tagMachiningFeaturethe machining feature
featureTypethe in process feature type
std::vector<NXOpen::CAM::FBM::Feature *> NXOpen::CAM::FBM::FeatureGeometry::CreateFeatures ( const std::vector< NXOpen::NXObject * > &  objects,
const NXString featureType 
)

Create a series of (in process) features.

Depending on the input objects feature recognition is performed. When no known features can be recognized, tagged features are created of type featureType

Returns

Created in NX10.0.3.

License requirements : cam_base ("CAM BASE")
Parameters
objectsthe geometry objects, can also be machining features
featureTypethe machining feature type of the implictly created features when feature recognition fails
std::vector<NXOpen::CAM::FBM::Feature *> NXOpen::CAM::FBM::FeatureGeometry::CreateFeatures ( const std::vector< NXOpen::NXObject * > &  objects,
const char *  featureType 
)

Create a series of (in process) features.

Depending on the input objects feature recognition is performed. When no known features can be recognized, tagged features are created of type featureType

Returns

Created in NX10.0.3.

License requirements : cam_base ("CAM BASE")
Parameters
objectsthe geometry objects, can also be machining features
featureTypethe machining feature type of the implictly created features when feature recognition fails
NXOpen::CAM::FBM::FeatureSet* NXOpen::CAM::FBM::FeatureGeometry::CreateFeatureSet ( )

Create a new empty feature editor.

Returns
the new in process feature set
Created in NX9.0.1.

License requirements : cam_base ("CAM BASE")
NXOpen::CAM::FBM::FeatureSet* NXOpen::CAM::FBM::FeatureGeometry::GetFeatureSet ( int  nIndex)

Get the in process feature editor at the specified index.

Returns
the in process feature set
Created in NX9.0.1.

License requirements : cam_base ("CAM BASE")
Parameters
nIndexthe index of the feature set editor
NXString NXOpen::CAM::FBM::FeatureGeometry::GetMachiningArea ( )

Returns the machining area.

Returns
the machining area
Created in NX9.0.2.

License requirements : None
void NXOpen::CAM::FBM::FeatureGeometry::ReloadList ( )

Reload list from parent
Created in NX9.0.2.



License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::FBM::FeatureGeometry::ReorderFeatures ( NXOpen::CAM::FBM::FeatureGeometry::SortOrder  sortType)

Reorders the features according to a predefined algorithm
Created in NX9.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
sortTypesorttype
void NXOpen::CAM::FBM::FeatureGeometry::ReorderFeaturesByDirection ( NXOpen::CAM::FBM::FeatureGeometry::SequenceDirectionType  direction,
NXOpen::CAM::FBM::FeatureGeometry::SequencePatternType  pattern,
const NXOpen::Vector3d vecValue 
)

Reorders the features according to primary direction
Created in NX9.0.2.



License requirements : cam_base ("CAM BASE")

Parameters
directiondirection
patternpattern
vecValuevecvalue
void NXOpen::CAM::FBM::FeatureGeometry::ReorderFeaturesByDirection ( NXOpen::CAM::FBM::FeatureGeometry::SequenceDirectionType  direction,
NXOpen::CAM::FBM::FeatureGeometry::SequencePatternType  pattern,
const NXOpen::Vector3d vecValue,
double  bandWidth 
)

Reorders the features according to primary direction with band width
Created in NX9.0.3.



License requirements : cam_base ("CAM BASE")

Parameters
directiondirection
patternpattern
vecValuevecvalue
bandWidthbandwidth
void NXOpen::CAM::FBM::FeatureGeometry::ReverseFeatures ( )

Reverse the features
Created in NX9.0.2.



License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::FBM::FeatureGeometry::SetDefaultAttribute ( const NXString attributeName,
double  dValue 
)

Sets a default attribute value
Created in NX9.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
dValuethe attribute value
void NXOpen::CAM::FBM::FeatureGeometry::SetDefaultAttribute ( const char *  attributeName,
double  dValue 
)

Sets a default attribute value
Created in NX9.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
dValuethe attribute value
void NXOpen::CAM::FBM::FeatureGeometry::SetDefaultAttribute ( const NXString attributeName,
const NXString strValue 
)

Sets a default attribute value
Created in NX9.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
strValuethe attribute value
void NXOpen::CAM::FBM::FeatureGeometry::SetDefaultAttribute ( const char *  attributeName,
const char *  strValue 
)

Sets a default attribute value
Created in NX9.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
strValuethe attribute value
void NXOpen::CAM::FBM::FeatureGeometry::SetDefaultAttribute ( const NXString attributeName,
int  nValue 
)

Sets a default attribute value
Created in NX9.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
nValuethe attribute value
void NXOpen::CAM::FBM::FeatureGeometry::SetDefaultAttribute ( const char *  attributeName,
int  nValue 
)

Sets a default attribute value
Created in NX9.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
nValuethe attribute value
void NXOpen::CAM::FBM::FeatureGeometry::SetDefaultAttribute ( const NXString attributeName,
bool  bValue 
)

Sets a default attribute value
Created in NX9.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
bValuethe attribute value
void NXOpen::CAM::FBM::FeatureGeometry::SetDefaultAttribute ( const char *  attributeName,
bool  bValue 
)

Sets a default attribute value
Created in NX9.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
attributeNamethe attribute name
bValuethe attribute value
void NXOpen::CAM::FBM::FeatureGeometry::SetMachiningArea ( const NXString machiningArea)

Change machining area
Created in NX9.0.2.



License requirements : cam_base ("CAM BASE")

Parameters
machiningAreathe machining area
void NXOpen::CAM::FBM::FeatureGeometry::SetMachiningArea ( const char *  machiningArea)

Change machining area
Created in NX9.0.2.



License requirements : cam_base ("CAM BASE")

Parameters
machiningAreathe machining area
void NXOpen::CAM::FBM::FeatureGeometry::SetUseModelDepth ( bool  flag)

Sets the use model depth flag
Created in NX11.0.2.



License requirements : cam_base ("CAM BASE")

Parameters
flagflag
bool NXOpen::CAM::FBM::FeatureGeometry::UseModelDepth ( )

Returns the use model depth flag
Created in NX11.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.