DeformDefinitionBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DeformDefinitionBuilder Class

class `NXOpen.Features.``DeformDefinitionBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Used as a place holder for selected member features, expressions and external references for a deform definition feature record that is to be created.

  To create a new instance of this class, use `NXOpen.Features.FeatureCollection.CreateDeformDefinitionBuilder()`

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetExpressionsData | Sets data of single expression for deform definition feature.
SetExternalReferences | Sets external references for deform definition feature.
SetHelpUrl | Sets help url on deform definition feature.
SetMemberFeatures | Sets the list of member feature records for deform definition feature.
SetName | Sets name for deform definition feature.
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

DeformDefinitionBuilderExpressionType Enumeration | Specifies the way of providing input to expression during deform instantiation.
DeformDefinitionBuilderRangeType Enumeration | Specifies type of range of input values when `NXOpen.Features.DeformDefinitionBuilderExpressionType` is `NXOpen.Features.DeformDefinitionBuilderExpressionType.Range`.

# Structs

DeformDefinitionBuilderJaDeformDefinitionExpData_Struct Struct |

# Method Detail

## SetExpressionsData

`DeformDefinitionBuilder.``SetExpressionsData`

  Sets data of single expression for deform definition feature.

  For multiple expressions, this needs to be called multiple times.

  Signature `SetExpressionsData(expData, defineValues)`

  Parameters:

  - expData (`NXOpen.Features.DeformDefinitionBuilderJaDeformDefinitionExpData_Struct`) –
  - defineValues (list of str) –

  New in version NX12.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SetExternalReferences

`DeformDefinitionBuilder.``SetExternalReferences`

  Sets external references for deform definition feature.

  Signature `SetExternalReferences(extRefs, refPrompts)`

  Parameters:

  - extRefs (list of `NXOpen.DisplayableObject`) –
  - refPrompts (list of str) –

  New in version NX12.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SetHelpUrl

`DeformDefinitionBuilder.``SetHelpUrl`

  Sets help url on deform definition feature.

  Signature `SetHelpUrl(helpUrl)`

  Parameters: | helpUrl (str) –

  New in version NX12.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SetMemberFeatures

`DeformDefinitionBuilder.``SetMemberFeatures`

  Sets the list of member feature records for deform definition feature.

  Signature `SetMemberFeatures(memberFrecs)`

  Parameters: | memberFrecs (list of `NXOpen.Features.Feature`) –

  New in version NX12.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SetName

`DeformDefinitionBuilder.``SetName`

  Sets name for deform definition feature.

  Signature `SetName(name)`

  Parameters: | name (str) –

  New in version NX12.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Validate

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