NXOpen::CAM::FeatureRecognitionBuilder Class Reference

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

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::CAM::FeatureRecognitionBuilder:

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.
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.
NXOpen::CAM::ManualFeatureBuilder *	CreateManualFeatureBuilder ()
	Creates a new manual feature builder.
void	DeleteFeature (NXOpen::CAM::CAMFeature *feature)
	Deletes a manufacturing feature that was created through this builder instance Created in NX7.5.0.
bool	FeatureMapperEnabled ()
	Returns the flag indicating if mapping is enabled.
std::vector < NXOpen::CAM::CAMFeature * >	FindFeatures ()
	Finds manufacturing features.
NXOpen::ScCollector *	FloorFaces ()
	Returns the floor faces Created in NX6.0.0.
NXOpen::CAM::FeatureRecognitionBuilder::GeometrySearch	GeometrySearchType ()
	Returns the method of geometry search Created in NX7.5.0.
std::vector < NXOpen::CAM::CAMFeature * >	GetFoundFeatures ()
	Returns the found features.
void	GetModelingFeatureTypes (std::vector< NXString > &featureTypes)
	Gets the modeling feature types from the bodies currently set in this builder Created in NX7.5.0.
void	GetRegisteredFeatureTypes (std::vector< NXString > &featureTypes)
	Gets the registered feature types Created in NX6.0.0.
std::vector < NXOpen::DisplayableObject * >	GetSearchGeometry ()
	Returns the geometry search.
bool	IgnoreExistingFeatures ()
	Returns the flag indicating whether found features are checked agains existing features.
bool	IgnoreWarnings ()
	Returns the flag indicating whether to ignore warnings while finding features.
NXOpen::ScCollector *	LimitFaces ()
	Returns the limited set of faces to search in Created in NX6.0.0.
NXOpen::CAM::ManualFeatureBuilderList *	LstManualFeatures ()
	Returns the manual feature builder list Created in NX6.0.0.
NXOpen::CAM::CAMFeature *	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.
NXOpen::CAM::CAMFeature *	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.
bool	MapFeatures ()
	Returns the flag indicating whether features will be mapped to other features if possible Created in NX6.0.0.
NXOpen::CAM::FeatureRecognitionBuilder::RecognitionEnum	RecognitionType ()
	Returns the type of feature search Created in NX6.0.0.
void	SetAddCadFeatureAttributes (bool addCadAttributes)
	Sets the flag indicating whether features will get attributes added of enclosed modeling features Created in NX7.5.2.
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.
void	SetFeatureTypes (std::vector< NXString > &featureTypes)
	Sets the feature types used by the recognizer Created in NX6.0.0.
void	SetGeometrySearchType (NXOpen::CAM::FeatureRecognitionBuilder::GeometrySearch geometrySearch)
	Sets the method of geometry search Created in NX7.5.0.
void	SetIgnoreExistingFeatures (bool ignoreExistingFeatures)
	Sets the flag indicating whether found features are checked agains existing features.
void	SetIgnoreWarnings (bool ignoreWarnings)
	Sets the flag indicating whether to ignore warnings while finding features.
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.
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.
void	SetMachiningAccessDirection (NXOpen::Point *focalPt, bool bIsTowardPt)
	Set the machining access direction to toward or away from a point Created in NX8.0.1.
void	SetMapFeatures (bool mapFeatures)
	Sets the flag indicating whether features will be mapped to other features if possible Created in NX6.0.0.
void	SetRecognitionType (NXOpen::CAM::FeatureRecognitionBuilder::RecognitionEnum recognitionType)
	Sets the type of feature search Created in NX6.0.0.
void	SetSearchGeometry (const std::vector< NXOpen::DisplayableObject * > &objects)
	Sets the geometry to search Created in NX7.5.0.
void	SetUseFeatureNameAsType (bool useFeatureNameAsType)
	Sets the flag indicating whether the feature name will be used as feature type Created in NX6.0.0.
void	SetVecDirection (NXOpen::Direction *vecDirection)
	Sets the machining access direction vector
bool	UseFeatureNameAsType ()
	Returns the flag indicating whether the feature name will be used as feature type Created in NX6.0.0.
NXOpen::Direction *	VecDirection ()
	Returns the machining access direction vector
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

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

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::FeatureRecognitionBuilder::GeometrySearch

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.

enum NXOpen::CAM::FeatureRecognitionBuilder::RecognitionEnum

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

feature

feature

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

featureTypes

feature types

void NXOpen::CAM::FeatureRecognitionBuilder::GetRegisteredFeatureTypes

(

std::vector< NXString > &

featureTypes

)

Gets the registered feature types
Created in NX6.0.0.

License requirements : None

Parameters

featureTypes

feature 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

featureName	name of new feature NOTE: The full Unicode character set is not supported for this parameter.
faces	floor faces of new feature
wallFaces	wall faces of new feature
deleteFeatures	Deletes 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

featureName	name of new feature NOTE: The full Unicode character set is not supported for this parameter.
faces	floor faces of new feature
wallFaces	wall faces of new feature
deleteFeatures	Deletes 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

addCadAttributes

add 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

assignColor

assign 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

geometrySearch

geometry 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

ignoreExistingFeatures

ignore 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

ignoreWarnings

ignore 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

vecDirections	vecdirections
dTolerance	dtolerance

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

tagPoint	tagpoint
tagAxis	tagaxis
bIsTowardAxis	bistowardaxis

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

focalPt	focalpt
bIsTowardPt	bistowardpt

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

mapFeatures

map 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

recognitionType

recognition 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

objects

objects

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

useFeatureNameAsType

use 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

vecDirection

vecdirection

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:

• CAM_FeatureRecognitionBuilder.hxx