FeatureGeometry Class — NXOpen Python API Reference 12.0.0 documentation

# FeatureGeometry Class

class `NXOpen.CAM.FBM.``FeatureGeometry`

  Bases: `NXOpen.CAM.Geometry`

  Represents a feature geometry builder

  This is an abstract class and cannot be instantiated.

  New in version NX9.0.1.

# Properties

Property | Description
--- | ---
GeometryList | Returns the geometry list
Tag | Returns the Tag for this object.
Topology | Returns the topology builder
UseModelDepth | Returns or sets the use model depth flag

# Methods

Method | Description
--- | ---
AddFeatureSet | Creates a feature geometry set
AppendGeometrySet | Append an geometry set with dumb rules
AppendNamedGeometry | Append named geometry
CreateFeatureSet | Create a new empty feature editor
CreateFeatures | Create a series of (in process) features.
CreateGeometrySet | Create an empty geometry set
ExpandSets | Expanding the geometry sets
GetFeatureSet | Get the in process feature editor at the specified index
GetMachiningArea | Returns the machining area
InitializeData | Prepare and update geometry data
PreselectGeometry | Pre-select the wall geometry
ReloadList | Reload list from parent
ReorderFeatures | Reorders the features according to a predefined algorithm
ReorderFeaturesByDirection | Reorders the features according to primary direction
ReverseFeatures | Reverse the features
SetDefaultAttribute | Sets a default attribute value
SetMachiningArea | Change machining area
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

FeatureGeometrySequenceDirectionType Enumeration | the direction types
FeatureGeometrySequencePatternType Enumeration | the pattern types
FeatureGeometrySortOrder Enumeration | the optimization types

# Property Detail

## UseModelDepth

`FeatureGeometry.``UseModelDepth`

  Returns or sets the use model depth flag

  `-------------------------------------`

  Getter Method

  Signature `UseModelDepth`

  Returns: | the use model depth flag
  Return type: | bool

  New in version NX11.0.2.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `UseModelDepth`

  Parameters: | flag (bool) –

  New in version NX11.0.2.

  License requirements: cam_base (“CAM BASE”)

# Method Detail

## AddFeatureSet

`FeatureGeometry.``AddFeatureSet`

  Creates a feature geometry set

  Signature `AddFeatureSet(tagMachiningFeature, featureType)`

  Parameters:

  - tagMachiningFeature (`NXOpen.CAM.CAMFeature`) – the machining feature
  - featureType (str) – the in process feature type

  Returns: | the new in process feature set
  Return type: | `NXOpen.CAM.FBM.FeatureSet`

  New in version NX9.0.1.

  License requirements: cam_base (“CAM BASE”)

## CreateFeatureSet

`FeatureGeometry.``CreateFeatureSet`

  Create a new empty feature editor

  Signature `CreateFeatureSet()`

  Returns: | the new in process feature set
  Return type: | `NXOpen.CAM.FBM.FeatureSet`

  New in version NX9.0.1.

  License requirements: cam_base (“CAM BASE”)

## CreateFeatures

`FeatureGeometry.``CreateFeatures`

  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

  Signature `CreateFeatures(objects, featureType)`

  Parameters:

  - objects (list of `NXOpen.NXObject`) – the geometry objects, can also be machining features
  - featureType (str) – the machining feature type of the implictly created features when feature recognition fails

  Returns: |
  Return type: | list of `NXOpen.CAM.FBM.Feature`

  New in version NX10.0.3.

  License requirements: cam_base (“CAM BASE”)

## GetFeatureSet

`FeatureGeometry.``GetFeatureSet`

  Get the in process feature editor at the specified index

  Signature `GetFeatureSet(nIndex)`

  Parameters: | nIndex (int) – the index of the feature set editor
  Returns: | the in process feature set
  Return type: | `NXOpen.CAM.FBM.FeatureSet`

  New in version NX9.0.1.

  License requirements: cam_base (“CAM BASE”)

## GetMachiningArea

`FeatureGeometry.``GetMachiningArea`

  Returns the machining area

  Signature `GetMachiningArea()`

  Returns: | the machining area
  Return type: | str

  New in version NX9.0.2.

  License requirements: None.

## ReloadList

`FeatureGeometry.``ReloadList`

  Reload list from parent

  Signature `ReloadList()`

  New in version NX9.0.2.

  License requirements: cam_base (“CAM BASE”)

## ReorderFeatures

`FeatureGeometry.``ReorderFeatures`

  Reorders the features according to a predefined algorithm

  Signature `ReorderFeatures(sortType)`

  Parameters: | sortType (`NXOpen.CAM.FBM.FeatureGeometrySortOrder`) –

  New in version NX9.0.1.

  License requirements: cam_base (“CAM BASE”)

## ReorderFeaturesByDirection

`FeatureGeometry.``ReorderFeaturesByDirection`

  Overloaded method ReorderFeaturesByDirection

  - `ReorderFeaturesByDirection(direction, pattern, vecValue)`
  - `ReorderFeaturesByDirection(direction, pattern, vecValue, bandWidth)`

  `-------------------------------------`

  Reorders the features according to primary direction

  Signature `ReorderFeaturesByDirection(direction, pattern, vecValue)`

  Parameters:

  - direction (`NXOpen.CAM.FBM.FeatureGeometrySequenceDirectionType`) –
  - pattern (`NXOpen.CAM.FBM.FeatureGeometrySequencePatternType`) –
  - vecValue (`NXOpen.Vector3d`) –

  New in version NX9.0.2.

  License requirements: cam_base (“CAM BASE”)

  `-------------------------------------`

  Reorders the features according to primary direction with band width

  Signature `ReorderFeaturesByDirection(direction, pattern, vecValue, bandWidth)`

  Parameters:

  - direction (`NXOpen.CAM.FBM.FeatureGeometrySequenceDirectionType`) –
  - pattern (`NXOpen.CAM.FBM.FeatureGeometrySequencePatternType`) –
  - vecValue (`NXOpen.Vector3d`) –
  - bandWidth (float) –

  New in version NX9.0.3.

  License requirements: cam_base (“CAM BASE”)

  `-------------------------------------`

## ReverseFeatures

`FeatureGeometry.``ReverseFeatures`

  Reverse the features

  Signature `ReverseFeatures()`

  New in version NX9.0.2.

  License requirements: cam_base (“CAM BASE”)

## SetDefaultAttribute

`FeatureGeometry.``SetDefaultAttribute`

  Overloaded method SetDefaultAttribute

  - `SetDefaultAttribute(attributeName, dValue)`
  - `SetDefaultAttribute(attributeName, strValue)`
  - `SetDefaultAttribute(attributeName, nValue)`
  - `SetDefaultAttribute(attributeName, bValue)`

  `-------------------------------------`

  Sets a default attribute value

  Signature `SetDefaultAttribute(attributeName, dValue)`

  Parameters:

  - attributeName (str) – the attribute name
  - dValue (float) – the attribute value

  New in version NX9.0.1.

  License requirements: cam_base (“CAM BASE”)

  `-------------------------------------`

  Sets a default attribute value

  Signature `SetDefaultAttribute(attributeName, strValue)`

  Parameters:

  - attributeName (str) – the attribute name
  - strValue (str) – the attribute value

  New in version NX9.0.1.

  License requirements: cam_base (“CAM BASE”)

  `-------------------------------------`

  Sets a default attribute value

  Signature `SetDefaultAttribute(attributeName, nValue)`

  Parameters:

  - attributeName (str) – the attribute name
  - nValue (int) – the attribute value

  New in version NX9.0.1.

  License requirements: cam_base (“CAM BASE”)

  `-------------------------------------`

  Sets a default attribute value

  Signature `SetDefaultAttribute(attributeName, bValue)`

  Parameters:

  - attributeName (str) – the attribute name
  - bValue (bool) – the attribute value

  New in version NX9.0.1.

  License requirements: cam_base (“CAM BASE”)

  `-------------------------------------`

## SetMachiningArea

`FeatureGeometry.``SetMachiningArea`

  Change machining area

  Signature `SetMachiningArea(machiningArea)`

  Parameters: | machiningArea (str) – the machining area

  New in version NX9.0.2.

  License requirements: cam_base (“CAM BASE”)

## Validate

`FeatureGeometry.``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.