DesignTrimToolBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DesignTrimToolBuilder Class

class `NXOpen.Tooling.``DesignTrimToolBuilder`

  Bases: `NXOpen.Builder`

  Represents a builder to be used to create Mold Wizard design trim tool.

  To create a new instance of this class, use `NXOpen.Tooling.DesignTrimToolCollection.CreateDesignTrimToolBuilder()`

  Default values.

  Property | Value
  --- | ---
  NewSurfaceLayer | 32

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
NewSurfaceLayer | Returns or sets the layer where the new trim surface is created.
SourceObject | Returns the face or sheet body.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CreateDefaultSheet | Create a Moldwizard default trim surface, including CORE_TRIM_SHEET, CAVITY_TRIM_SHEET, CORE_MOLD_SURFACE, CAVITY_MOLD_SURFACE.
CreateNewComponent | Create a new trim part component in the work part.
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.
GetObject | Returns the object currently being edited by this builder.
SetTrimDataDetails | Set details of the trim data.
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.

# Property Detail

## NewSurfaceLayer

`DesignTrimToolBuilder.``NewSurfaceLayer`

  Returns or sets the layer where the new trim surface is created.

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

  Getter Method

  Signature `NewSurfaceLayer`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `NewSurfaceLayer`

  Parameters: | newSurfaceLayer (int) –

  New in version NX7.5.0.

  License requirements: None.

## SourceObject

`DesignTrimToolBuilder.``SourceObject`

  Returns the face or sheet body.

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

  Getter Method

  Signature `SourceObject`

  Returns: |
  Return type: | `NXOpen.SelectNXObject`

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## CreateDefaultSheet

`DesignTrimToolBuilder.``CreateDefaultSheet`

  Create a Moldwizard default trim surface, including CORE_TRIM_SHEET, CAVITY_TRIM_SHEET, CORE_MOLD_SURFACE, CAVITY_MOLD_SURFACE.

  Signature `CreateDefaultSheet(surfaceName, trimPart, sheetType, layer)`

  Parameters:

  - surfaceName (str) – the name for the default sheet to create.
  - trimPart (`NXOpen.NXObject`) – the trim part where to create the default trim surface feature.
  - sheetType (int) – the sheet type, parting sheet or mold surface.
  - layer (int) – the layer to put the new sheet feature.

  Returns: | the new sheet that is created.
  Return type: | `NXOpen.NXObject`

  New in version NX7.5.0.

  License requirements: None.

## CreateNewComponent

`DesignTrimToolBuilder.``CreateNewComponent`

  Create a new trim part component in the work part.

  Signature `CreateNewComponent(partName, instanceName)`

  Parameters:

  - partName (str) – the part name for the new component.
  - instanceName (str) – the instance name for the new component.

  Returns: | the new component that is created.
  Return type: | `NXOpen.Assemblies.Component`

  New in version NX7.5.0.

  License requirements: None.

## SetTrimDataDetails

`DesignTrimToolBuilder.``SetTrimDataDetails`

  Set details of the trim data.

  Signature `SetTrimDataDetails(trimPart, sourceObjectOcc, currentTrimSurfaceName, previousTrimSurfaceName)`

  Parameters:

  - trimPart (`NXOpen.NXObject`) – the trim part where to create or edit or trim surface feature.
  - sourceObjectOcc (`NXOpen.NXObject`) – the source object occurrence used to create a linked feature in the trim part.
  - currentTrimSurfaceName (str) – the name to set to the trim surface feature.
  - previousTrimSurfaceName (str) – the previous name of the trim surface feature.

  New in version NX7.5.0.

  License requirements: None.

## Validate

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