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

Represents a FeatureRecognition Builder
To create a new instance of this class, use NXOpen::CAM::CAMSetup::CreateFeatureRecognitionBuilder

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::CAM::FeatureRecognitionBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  GeometrySearch { GeometrySearchWorkpiece, GeometrySearchAllGeometry, GeometrySearchSelected }
 the geometry search type More...
 
enum  RecognitionEnum {
  RecognitionEnumIdentify, RecognitionEnumParametric, RecognitionEnumLegacy, RecognitionEnumGeneric,
  RecognitionEnumManual
}
 the type of feature search More...
 

Public Member Functions

bool AddCadFeatureAttributes ()
 Returns the flag indicating whether features will get attributes added of enclosed modeling features
Created in NX7.5.2. More...
 
bool AssignColor ()
 Returns the flag indicating whether features will get a color assigned if their faces have a unique color that is different from the body color
Created in NX6.0.0. More...
 
NXOpen::CAM::ManualFeatureBuilderCreateManualFeatureBuilder ()
 Creates a new manual feature builder. More...
 
void DeleteFeature (NXOpen::CAM::CAMFeature *feature)
 Deletes a manufacturing feature that was created through this builder instance
Created in NX7.5.0. More...
 
bool FeatureMapperEnabled ()
 Returns the flag indicating if mapping is enabled. More...
 
std::vector
< NXOpen::CAM::CAMFeature * > 
FindFeatures ()
 Finds manufacturing features. More...
 
NXOpen::ScCollectorFloorFaces ()
 Returns the floor faces
Created in NX6.0.0. More...
 
NXOpen::CAM::FeatureRecognitionBuilder::GeometrySearch GeometrySearchType ()
 Returns the method of geometry search
Created in NX7.5.0. More...
 
std::vector
< NXOpen::CAM::CAMFeature * > 
GetFoundFeatures ()
 Returns the found features. More...
 
void GetModelingFeatureTypes (std::vector< NXString > &featureTypes)
 Gets the modeling feature types from the bodies currently set in this builder
Created in NX7.5.0. More...
 
void GetRegisteredFeatureTypes (std::vector< NXString > &featureTypes)
 Gets the registered feature types
Created in NX6.0.0. More...
 
std::vector
< NXOpen::DisplayableObject * > 
GetSearchGeometry ()
 Returns the geometry search. More...
 
bool IgnoreExistingFeatures ()
 Returns the flag indicating whether found features are checked agains existing features. More...
 
bool IgnoreWarnings ()
 Returns the flag indicating whether to ignore warnings while finding features. More...
 
NXOpen::ScCollectorLimitFaces ()
 Returns the limited set of faces to search in
Created in NX6.0.0. More...
 
NXOpen::CAM::ManualFeatureBuilderListLstManualFeatures ()
 Returns the manual feature builder list
Created in NX6.0.0. More...
 
NXOpen::CAM::CAMFeatureMakeFeature (const NXString &featureName, const std::vector< NXOpen::Face * > &faces, const std::vector< NXOpen::Face * > &wallFaces, bool deleteFeatures)
 Creates a feature based on name, floor and wall faces. More...
 
NXOpen::CAM::CAMFeatureMakeFeature (const char *featureName, const std::vector< NXOpen::Face * > &faces, const std::vector< NXOpen::Face * > &wallFaces, bool deleteFeatures)
 Creates a feature based on name, floor and wall faces. More...
 
bool MapFeatures ()
 Returns the flag indicating whether features will be mapped to other features if possible
Created in NX6.0.0. More...
 
NXOpen::CAM::FeatureRecognitionBuilder::RecognitionEnum RecognitionType ()
 Returns the type of feature search
Created in NX6.0.0. More...
 
void SetAddCadFeatureAttributes (bool addCadAttributes)
 Sets the flag indicating whether features will get attributes added of enclosed modeling features
Created in NX7.5.2. More...
 
void SetAssignColor (bool assignColor)
 Sets the flag indicating whether features will get a color assigned if their faces have a unique color that is different from the body color
Created in NX6.0.0. More...
 
void SetFeatureTypes (std::vector< NXString > &featureTypes)
 Sets the feature types used by the recognizer
Created in NX6.0.0. More...
 
void SetGeometrySearchType (NXOpen::CAM::FeatureRecognitionBuilder::GeometrySearch geometrySearch)
 Sets the method of geometry search
Created in NX7.5.0. More...
 
void SetIgnoreExistingFeatures (bool ignoreExistingFeatures)
 Sets the flag indicating whether found features are checked agains existing features. More...
 
void SetIgnoreWarnings (bool ignoreWarnings)
 Sets the flag indicating whether to ignore warnings while finding features. More...
 
void SetMachiningAccessDirection (const std::vector< NXOpen::Direction * > &vecDirections, double dTolerance)
 Set the machining access direction to exact or approximate vectors
Created in NX8.0.1. More...
 
void SetMachiningAccessDirection (NXOpen::Point *tagPoint, NXOpen::Direction *tagAxis, bool bIsTowardAxis)
 Set the machining access direction to toward or away from an axis defined by a point and a vector
Created in NX8.5.0. More...
 
void SetMachiningAccessDirection (NXOpen::Point *focalPt, bool bIsTowardPt)
 Set the machining access direction to toward or away from a point
Created in NX8.0.1. More...
 
void SetMapFeatures (bool mapFeatures)
 Sets the flag indicating whether features will be mapped to other features if possible
Created in NX6.0.0. More...
 
void SetRecognitionType (NXOpen::CAM::FeatureRecognitionBuilder::RecognitionEnum recognitionType)
 Sets the type of feature search
Created in NX6.0.0. More...
 
void SetSearchGeometry (const std::vector< NXOpen::DisplayableObject * > &objects)
 Sets the geometry to search
Created in NX7.5.0. More...
 
void SetUseFeatureNameAsType (bool useFeatureNameAsType)
 Sets the flag indicating whether the feature name will be used as feature type
Created in NX6.0.0. More...
 
void SetVecDirection (NXOpen::Direction *vecDirection)
 Sets the machining access direction vector
More...
 
bool UseFeatureNameAsType ()
 Returns the flag indicating whether the feature name will be used as feature type
Created in NX6.0.0. More...
 
NXOpen::DirectionVecDirection ()
 Returns the machining access direction vector
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 FeatureRecognition Builder
To create a new instance of this class, use NXOpen::CAM::CAMSetup::CreateFeatureRecognitionBuilder

Created in NX6.0.0.


Member Enumeration Documentation

the geometry search type

Enumerator
GeometrySearchWorkpiece 

Search for features in workpiece.

GeometrySearchAllGeometry 

Search for features in all geometry.

GeometrySearchSelected 

Search for features in user-selected geometry.

the type of feature search

Enumerator
RecognitionEnumIdentify 

Feature Identification from modeling features.

RecognitionEnumParametric 

Parametric Feature Recognition.

RecognitionEnumLegacy 

Legacy Hole Feature Recognition.

RecognitionEnumGeneric 

Legacy Face and Pocket Feature Recognition.

RecognitionEnumManual 

Manual Feature Recognition.

Member Function Documentation

bool NXOpen::CAM::FeatureRecognitionBuilder::AddCadFeatureAttributes ( )

Returns the flag indicating whether features will get attributes added of enclosed modeling features
Created in NX7.5.2.



License requirements : None

bool NXOpen::CAM::FeatureRecognitionBuilder::AssignColor ( )

Returns the flag indicating whether features will get a color assigned if their faces have a unique color that is different from the body color
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::ManualFeatureBuilder* NXOpen::CAM::FeatureRecognitionBuilder::CreateManualFeatureBuilder ( )

Creates a new manual feature builder.

Returns
feature builder
Created in NX6.0.0.

License requirements : None
void NXOpen::CAM::FeatureRecognitionBuilder::DeleteFeature ( NXOpen::CAM::CAMFeature feature)

Deletes a manufacturing feature that was created through this builder instance
Created in NX7.5.0.



License requirements : None

Parameters
featurefeature
bool NXOpen::CAM::FeatureRecognitionBuilder::FeatureMapperEnabled ( )

Returns the flag indicating if mapping is enabled.

Only when a valid mapping module is loaded the feature mapper is enabled
Created in NX6.0.0.

License requirements : None

std::vector<NXOpen::CAM::CAMFeature *> NXOpen::CAM::FeatureRecognitionBuilder::FindFeatures ( )

Finds manufacturing features.

Returns
The found features
Created in NX7.5.0.

License requirements : None
NXOpen::ScCollector* NXOpen::CAM::FeatureRecognitionBuilder::FloorFaces ( )

Returns the floor faces
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::FeatureRecognitionBuilder::GeometrySearch NXOpen::CAM::FeatureRecognitionBuilder::GeometrySearchType ( )

Returns the method of geometry search
Created in NX7.5.0.



License requirements : None

std::vector<NXOpen::CAM::CAMFeature *> NXOpen::CAM::FeatureRecognitionBuilder::GetFoundFeatures ( )

Returns the found features.

Returns

Created in NX7.5.0.

License requirements : None
void NXOpen::CAM::FeatureRecognitionBuilder::GetModelingFeatureTypes ( std::vector< NXString > &  featureTypes)

Gets the modeling feature types from the bodies currently set in this builder
Created in NX7.5.0.



License requirements : None

Parameters
featureTypesfeature types
void NXOpen::CAM::FeatureRecognitionBuilder::GetRegisteredFeatureTypes ( std::vector< NXString > &  featureTypes)

Gets the registered feature types
Created in NX6.0.0.



License requirements : None

Parameters
featureTypesfeature types
std::vector<NXOpen::DisplayableObject *> NXOpen::CAM::FeatureRecognitionBuilder::GetSearchGeometry ( )

Returns the geometry search.

Returns

Created in NX7.5.0.

License requirements : None
bool NXOpen::CAM::FeatureRecognitionBuilder::IgnoreExistingFeatures ( )

Returns the flag indicating whether found features are checked agains existing features.

If this flag is set then features are recognized even if they match existing features.
Created in NX7.5.0.

License requirements : None

bool NXOpen::CAM::FeatureRecognitionBuilder::IgnoreWarnings ( )

Returns the flag indicating whether to ignore warnings while finding features.


Created in NX7.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::CAM::FeatureRecognitionBuilder::LimitFaces ( )

Returns the limited set of faces to search in
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::ManualFeatureBuilderList* NXOpen::CAM::FeatureRecognitionBuilder::LstManualFeatures ( )

Returns the manual feature builder list
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::CAMFeature* NXOpen::CAM::FeatureRecognitionBuilder::MakeFeature ( const NXString featureName,
const std::vector< NXOpen::Face * > &  faces,
const std::vector< NXOpen::Face * > &  wallFaces,
bool  deleteFeatures 
)

Creates a feature based on name, floor and wall faces.

Returns

Created in NX7.5.0.

License requirements : None
Parameters
featureNamename of new feature
NOTE: The full Unicode character set is not supported for this parameter.
facesfloor faces of new feature
wallFaceswall faces of new feature
deleteFeaturesDeletes previous found features
NXOpen::CAM::CAMFeature* NXOpen::CAM::FeatureRecognitionBuilder::MakeFeature ( const char *  featureName,
const std::vector< NXOpen::Face * > &  faces,
const std::vector< NXOpen::Face * > &  wallFaces,
bool  deleteFeatures 
)

Creates a feature based on name, floor and wall faces.

Returns

Created in NX7.5.0.

License requirements : None
Parameters
featureNamename of new feature
NOTE: The full Unicode character set is not supported for this parameter.
facesfloor faces of new feature
wallFaceswall faces of new feature
deleteFeaturesDeletes previous found features
bool NXOpen::CAM::FeatureRecognitionBuilder::MapFeatures ( )

Returns the flag indicating whether features will be mapped to other features if possible
Created in NX6.0.0.



License requirements : None

NXOpen::CAM::FeatureRecognitionBuilder::RecognitionEnum NXOpen::CAM::FeatureRecognitionBuilder::RecognitionType ( )

Returns the type of feature search
Created in NX6.0.0.



License requirements : None

void NXOpen::CAM::FeatureRecognitionBuilder::SetAddCadFeatureAttributes ( bool  addCadAttributes)

Sets the flag indicating whether features will get attributes added of enclosed modeling features
Created in NX7.5.2.



License requirements : None

Parameters
addCadAttributesadd cad attributes
void NXOpen::CAM::FeatureRecognitionBuilder::SetAssignColor ( bool  assignColor)

Sets the flag indicating whether features will get a color assigned if their faces have a unique color that is different from the body color
Created in NX6.0.0.



License requirements : None

Parameters
assignColorassign color
void NXOpen::CAM::FeatureRecognitionBuilder::SetFeatureTypes ( std::vector< NXString > &  featureTypes)

Sets the feature types used by the recognizer
Created in NX6.0.0.



License requirements : None

Parameters
featureTypes
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::CAM::FeatureRecognitionBuilder::SetGeometrySearchType ( NXOpen::CAM::FeatureRecognitionBuilder::GeometrySearch  geometrySearch)

Sets the method of geometry search
Created in NX7.5.0.



License requirements : None

Parameters
geometrySearchgeometry search
void NXOpen::CAM::FeatureRecognitionBuilder::SetIgnoreExistingFeatures ( bool  ignoreExistingFeatures)

Sets the flag indicating whether found features are checked agains existing features.

If this flag is set then features are recognized even if they match existing features.
Created in NX7.5.0.

License requirements : None

Parameters
ignoreExistingFeaturesignore existing features
void NXOpen::CAM::FeatureRecognitionBuilder::SetIgnoreWarnings ( bool  ignoreWarnings)

Sets the flag indicating whether to ignore warnings while finding features.


Created in NX7.5.0.

License requirements : None

Parameters
ignoreWarningsignore warnings
void NXOpen::CAM::FeatureRecognitionBuilder::SetMachiningAccessDirection ( const std::vector< NXOpen::Direction * > &  vecDirections,
double  dTolerance 
)

Set the machining access direction to exact or approximate vectors
Created in NX8.0.1.



License requirements : None

Parameters
vecDirectionsvecdirections
dTolerancedtolerance
void NXOpen::CAM::FeatureRecognitionBuilder::SetMachiningAccessDirection ( NXOpen::Point tagPoint,
NXOpen::Direction tagAxis,
bool  bIsTowardAxis 
)

Set the machining access direction to toward or away from an axis defined by a point and a vector
Created in NX8.5.0.



License requirements : None

Parameters
tagPointtagpoint
tagAxistagaxis
bIsTowardAxisbistowardaxis
void NXOpen::CAM::FeatureRecognitionBuilder::SetMachiningAccessDirection ( NXOpen::Point focalPt,
bool  bIsTowardPt 
)

Set the machining access direction to toward or away from a point
Created in NX8.0.1.



License requirements : None

Parameters
focalPtfocalpt
bIsTowardPtbistowardpt
void NXOpen::CAM::FeatureRecognitionBuilder::SetMapFeatures ( bool  mapFeatures)

Sets the flag indicating whether features will be mapped to other features if possible
Created in NX6.0.0.



License requirements : None

Parameters
mapFeaturesmap features
void NXOpen::CAM::FeatureRecognitionBuilder::SetRecognitionType ( NXOpen::CAM::FeatureRecognitionBuilder::RecognitionEnum  recognitionType)

Sets the type of feature search
Created in NX6.0.0.



License requirements : None

Parameters
recognitionTyperecognition type
void NXOpen::CAM::FeatureRecognitionBuilder::SetSearchGeometry ( const std::vector< NXOpen::DisplayableObject * > &  objects)

Sets the geometry to search
Created in NX7.5.0.



License requirements : None

Parameters
objectsobjects
void NXOpen::CAM::FeatureRecognitionBuilder::SetUseFeatureNameAsType ( bool  useFeatureNameAsType)

Sets the flag indicating whether the feature name will be used as feature type
Created in NX6.0.0.



License requirements : None

Parameters
useFeatureNameAsTypeuse feature name as type
void NXOpen::CAM::FeatureRecognitionBuilder::SetVecDirection ( NXOpen::Direction vecDirection)

Sets the machining access direction vector

Deprecated:
Deprecated in NX8.5.0.

Use CAM::FeatureRecognitionBuilder::SetMachiningAccessDirection instead.


Created in NX6.0.0.

License requirements : None

Parameters
vecDirectionvecdirection
bool NXOpen::CAM::FeatureRecognitionBuilder::UseFeatureNameAsType ( )

Returns the flag indicating whether the feature name will be used as feature type
Created in NX6.0.0.



License requirements : None

NXOpen::Direction* NXOpen::CAM::FeatureRecognitionBuilder::VecDirection ( )

Returns the machining access direction vector

Deprecated:
Deprecated in NX8.5.0.

This functionality is no longer supported.


Created in NX6.0.0.

License requirements : None


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