FeatureRecognitionBuilder Class¶
-
class
NXOpen.CAM.
FeatureRecognitionBuilder
¶ Bases:
NXOpen.Builder
Represents a FeatureRecognition Builder
To create a new instance of this class, use
NXOpen.CAM.CAMSetup.CreateFeatureRecognitionBuilder()
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AddCadFeatureAttributes | Returns or sets the flag indicating whether features will get attributes added of enclosed modeling features |
AssignColor | Returns or 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 |
FeatureMapperEnabled | Returns the flag indicating if mapping is enabled. |
FloorFaces | Returns the floor faces |
GeometrySearchType | Returns or sets the method of geometry search |
IgnoreExistingFeatures | Returns or sets the flag indicating whether found features are checked agains existing features. |
IgnoreWarnings | Returns or sets the flag indicating whether to ignore warnings while finding features. |
LimitFaces | Returns the limited set of faces to search in |
LstManualFeatures | Returns the manual feature builder list |
MapFeatures | Returns or sets the flag indicating whether features will be mapped to other features if possible |
RecognitionType | Returns or sets the type of feature search |
Tag | Returns the Tag for this object. |
UseFeatureNameAsType | Returns or sets the flag indicating whether the feature name will be used as feature type |
VecDirection | Returns or sets the machining access direction vector |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CreateManualFeatureBuilder | Creates a new manual feature builder @return feature builder |
DeleteFeature | Deletes a manufacturing feature that was created through this builder instance |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
FindFeatures | Finds manufacturing features @return The found features |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetFoundFeatures | Returns the found features @return |
GetModelingFeatureTypes | Gets the modeling feature types from the bodies currently set in this builder |
GetObject | Returns the object currently being edited by this builder. |
GetRegisteredFeatureTypes | Gets the registered feature types |
GetSearchGeometry | Returns the geometry search @return |
MakeFeature | Creates a feature based on name, floor and wall faces @return |
SetFeatureTypes | Sets the feature types used by the recognizer |
SetMachiningAccessDirection | Set the machining access direction to exact or approximate vectors |
SetSearchGeometry | Sets the geometry to search |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
FeatureRecognitionBuilderGeometrySearch Enumeration | the geometry search type |
FeatureRecognitionBuilderRecognitionEnum Enumeration | the type of feature search |
Property Detail¶
AddCadFeatureAttributes¶
-
FeatureRecognitionBuilder.
AddCadFeatureAttributes
¶ Returns or sets the flag indicating whether features will get attributes added of enclosed modeling features
-------------------------------------
Getter Method
Signature
AddCadFeatureAttributes()
Returns: Return type: bool New in version NX7.5.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
AddCadFeatureAttributes(addCadAttributes)
Parameters: addCadAttributes (bool) – New in version NX7.5.2.
License requirements: None.
AssignColor¶
-
FeatureRecognitionBuilder.
AssignColor
¶ Returns or 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
-------------------------------------
Getter Method
Signature
AssignColor()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AssignColor(assignColor)
Parameters: assignColor (bool) – New in version NX6.0.0.
License requirements: None.
FeatureMapperEnabled¶
-
FeatureRecognitionBuilder.
FeatureMapperEnabled
¶ Returns the flag indicating if mapping is enabled.
Only when a valid mapping module is loaded the feature mapper is enabled
-------------------------------------
Getter Method
Signature
FeatureMapperEnabled()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
FloorFaces¶
-
FeatureRecognitionBuilder.
FloorFaces
¶ Returns the floor faces
-------------------------------------
Getter Method
Signature
FloorFaces()
Returns: Return type: NXOpen.ScCollector
New in version NX6.0.0.
License requirements: None.
GeometrySearchType¶
-
FeatureRecognitionBuilder.
GeometrySearchType
¶ Returns or sets the method of geometry search
-------------------------------------
Getter Method
Signature
GeometrySearchType()
Returns: Return type: NXOpen.CAM.FeatureRecognitionBuilderGeometrySearch
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GeometrySearchType(geometrySearch)
Parameters: geometrySearch ( NXOpen.CAM.FeatureRecognitionBuilderGeometrySearch
) –New in version NX7.5.0.
License requirements: None.
IgnoreExistingFeatures¶
-
FeatureRecognitionBuilder.
IgnoreExistingFeatures
¶ Returns or 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.
-------------------------------------
Getter Method
Signature
IgnoreExistingFeatures()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IgnoreExistingFeatures(ignoreExistingFeatures)
Parameters: ignoreExistingFeatures (bool) – New in version NX7.5.0.
License requirements: None.
IgnoreWarnings¶
-
FeatureRecognitionBuilder.
IgnoreWarnings
¶ Returns or sets the flag indicating whether to ignore warnings while finding features.
-------------------------------------
Getter Method
Signature
IgnoreWarnings()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IgnoreWarnings(ignoreWarnings)
Parameters: ignoreWarnings (bool) – New in version NX7.5.0.
License requirements: None.
LimitFaces¶
-
FeatureRecognitionBuilder.
LimitFaces
¶ Returns the limited set of faces to search in
-------------------------------------
Getter Method
Signature
LimitFaces()
Returns: Return type: NXOpen.ScCollector
New in version NX6.0.0.
License requirements: None.
LstManualFeatures¶
-
FeatureRecognitionBuilder.
LstManualFeatures
¶ Returns the manual feature builder list
-------------------------------------
Getter Method
Signature
LstManualFeatures()
Returns: Return type: NXOpen.CAM.ManualFeatureBuilderList
New in version NX6.0.0.
License requirements: None.
MapFeatures¶
-
FeatureRecognitionBuilder.
MapFeatures
¶ Returns or sets the flag indicating whether features will be mapped to other features if possible
-------------------------------------
Getter Method
Signature
MapFeatures()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MapFeatures(mapFeatures)
Parameters: mapFeatures (bool) – New in version NX6.0.0.
License requirements: None.
RecognitionType¶
-
FeatureRecognitionBuilder.
RecognitionType
¶ Returns or sets the type of feature search
-------------------------------------
Getter Method
Signature
RecognitionType()
Returns: Return type: NXOpen.CAM.FeatureRecognitionBuilderRecognitionEnum
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RecognitionType(recognitionType)
Parameters: recognitionType ( NXOpen.CAM.FeatureRecognitionBuilderRecognitionEnum
) –New in version NX6.0.0.
License requirements: None.
UseFeatureNameAsType¶
-
FeatureRecognitionBuilder.
UseFeatureNameAsType
¶ Returns or sets the flag indicating whether the feature name will be used as feature type
-------------------------------------
Getter Method
Signature
UseFeatureNameAsType()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UseFeatureNameAsType(useFeatureNameAsType)
Parameters: useFeatureNameAsType (bool) – New in version NX6.0.0.
License requirements: None.
VecDirection¶
-
FeatureRecognitionBuilder.
VecDirection
¶ Returns or sets the machining access direction vector
-------------------------------------
Getter Method
Signature
VecDirection()
Returns: Return type: NXOpen.Direction
New in version NX6.0.0.
Deprecated since version NX8.5.0: This functionality is no longer supported.
License requirements: None.
-------------------------------------
Setter Method
Signature
VecDirection(vecDirection)
Parameters: vecDirection ( NXOpen.Direction
) –New in version NX6.0.0.
Deprecated since version NX8.5.0: Use
CAM.FeatureRecognitionBuilder.SetMachiningAccessDirection()
instead.License requirements: None.
Method Detail¶
CreateManualFeatureBuilder¶
-
FeatureRecognitionBuilder.
CreateManualFeatureBuilder
¶ Creates a new manual feature builder
Signature
CreateManualFeatureBuilder()
Returns: feature builder Return type: NXOpen.CAM.ManualFeatureBuilder
New in version NX6.0.0.
License requirements: None.
DeleteFeature¶
-
FeatureRecognitionBuilder.
DeleteFeature
¶ Deletes a manufacturing feature that was created through this builder instance
Signature
DeleteFeature(feature)
Parameters: feature ( NXOpen.CAM.CAMFeature
) –New in version NX7.5.0.
License requirements: None.
FindFeatures¶
-
FeatureRecognitionBuilder.
FindFeatures
¶ Finds manufacturing features
Signature
FindFeatures()
Returns: The found features Return type: list of NXOpen.CAM.CAMFeature
New in version NX7.5.0.
License requirements: None.
GetFoundFeatures¶
-
FeatureRecognitionBuilder.
GetFoundFeatures
¶ Returns the found features
Signature
GetFoundFeatures()
Returns: Return type: list of NXOpen.CAM.CAMFeature
New in version NX7.5.0.
License requirements: None.
GetModelingFeatureTypes¶
-
FeatureRecognitionBuilder.
GetModelingFeatureTypes
¶ Gets the modeling feature types from the bodies currently set in this builder
Signature
GetModelingFeatureTypes()
Returns: Return type: list of str New in version NX7.5.0.
License requirements: None.
GetRegisteredFeatureTypes¶
-
FeatureRecognitionBuilder.
GetRegisteredFeatureTypes
¶ Gets the registered feature types
Signature
GetRegisteredFeatureTypes()
Returns: Return type: list of str New in version NX6.0.0.
License requirements: None.
GetSearchGeometry¶
-
FeatureRecognitionBuilder.
GetSearchGeometry
¶ Returns the geometry search
Signature
GetSearchGeometry()
Returns: Return type: list of NXOpen.DisplayableObject
New in version NX7.5.0.
License requirements: None.
MakeFeature¶
-
FeatureRecognitionBuilder.
MakeFeature
¶ Creates a feature based on name, floor and wall faces
Signature
MakeFeature(featureName, faces, wallFaces, deleteFeatures)
Parameters: - featureName (str) – name of new feature
- faces (list of
NXOpen.Face
) – floor faces of new feature - wallFaces (list of
NXOpen.Face
) – wall faces of new feature - deleteFeatures (bool) – Deletes previous found features
Returns: Return type: New in version NX7.5.0.
License requirements: None.
SetFeatureTypes¶
-
FeatureRecognitionBuilder.
SetFeatureTypes
¶ Sets the feature types used by the recognizer
Signature
SetFeatureTypes(featureTypes)
Parameters: featureTypes (list of str) – New in version NX6.0.0.
License requirements: None.
SetMachiningAccessDirection¶
-
FeatureRecognitionBuilder.
SetMachiningAccessDirection
¶ Overloaded method SetMachiningAccessDirection
SetMachiningAccessDirection(vecDirections, dTolerance)
SetMachiningAccessDirection(tagPoint, tagAxis, bIsTowardAxis)
SetMachiningAccessDirection(focalPt, bIsTowardPt)
-------------------------------------
Set the machining access direction to exact or approximate vectors
Signature
SetMachiningAccessDirection(vecDirections, dTolerance)
Parameters: - vecDirections (list of
NXOpen.Direction
) – - dTolerance (float) –
New in version NX8.0.1.
License requirements: None.
-------------------------------------
Set the machining access direction to toward or away from an axis defined by a point and a vector
Signature
SetMachiningAccessDirection(tagPoint, tagAxis, bIsTowardAxis)
Parameters: - tagPoint (
NXOpen.Point
) – - tagAxis (
NXOpen.Direction
) – - bIsTowardAxis (bool) –
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Set the machining access direction to toward or away from a point
Signature
SetMachiningAccessDirection(focalPt, bIsTowardPt)
Parameters: - focalPt (
NXOpen.Point
) – - bIsTowardPt (bool) –
New in version NX8.0.1.
License requirements: None.
-------------------------------------
SetSearchGeometry¶
-
FeatureRecognitionBuilder.
SetSearchGeometry
¶ Sets the geometry to search
Signature
SetSearchGeometry(objects)
Parameters: objects (list of NXOpen.DisplayableObject
) –New in version NX7.5.0.
License requirements: None.
Validate¶
-
FeatureRecognitionBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.