TrimSheetBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# TrimSheetBuilder Class

class `NXOpen.Features.``TrimSheetBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.TrimSheet` builder.

  Inputs to this class can be convergent objects.

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

  Default values.

  Property | Value
  --- | ---
  ImprintBothSide | True
  KeepDiscardMethod | Keep

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
AllowTargetEdgesAsToolObjects | Returns or sets the allow target edges as tool objects
ApplyToCopyOfSheets | Returns or sets the apply to copy of sheets
BoundaryObjects | Returns the boundry objects
ExtendBoundaryObject | Returns or sets the extend boundary object to target laminar edges
ImprintBothSide | Returns or sets the imprint both side
KeepDiscardMethod | Returns or sets the keep discard method
OutputExactGeometry | Returns or sets the output exact geometry
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
ProjectionDirection | Returns the projection direction
Regions | Returns the regions
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
TargetBodies | Returns the target bodies
Tolerance | Returns or sets the tolerance

# 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.
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

TrimSheetBuilderKeepDiscardOption Enumeration | Represents the keep discard options for selected region

# Property Detail

## AllowTargetEdgesAsToolObjects

`TrimSheetBuilder.``AllowTargetEdgesAsToolObjects`

  Returns or sets the allow target edges as tool objects

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

  Getter Method

  Signature `AllowTargetEdgesAsToolObjects`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AllowTargetEdgesAsToolObjects`

  Parameters: | allowTargetEdgesAsToolObjects (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## ApplyToCopyOfSheets

`TrimSheetBuilder.``ApplyToCopyOfSheets`

  Returns or sets the apply to copy of sheets

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

  Getter Method

  Signature `ApplyToCopyOfSheets`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ApplyToCopyOfSheets`

  Parameters: | applyToCopyOfSheets (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## BoundaryObjects

`TrimSheetBuilder.``BoundaryObjects`

  Returns the boundry objects

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

  Getter Method

  Signature `BoundaryObjects`

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

  New in version NX5.0.0.

  License requirements: None.

## ExtendBoundaryObject

`TrimSheetBuilder.``ExtendBoundaryObject`

  Returns or sets the extend boundary object to target laminar edges

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

  Getter Method

  Signature `ExtendBoundaryObject`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ExtendBoundaryObject`

  Parameters: | extendBoundaryObject (bool) –

  New in version NX10.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## ImprintBothSide

`TrimSheetBuilder.``ImprintBothSide`

  Returns or sets the imprint both side

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

  Getter Method

  Signature `ImprintBothSide`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ImprintBothSide`

  Parameters: | imprintBothSide (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## KeepDiscardMethod

`TrimSheetBuilder.``KeepDiscardMethod`

  Returns or sets the keep discard method

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

  Getter Method

  Signature `KeepDiscardMethod`

  Returns: |
  Return type: | `NXOpen.Features.TrimSheetBuilderKeepDiscardOption`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `KeepDiscardMethod`

  Parameters: | keepDiscardMethod (`NXOpen.Features.TrimSheetBuilderKeepDiscardOption`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## OutputExactGeometry

`TrimSheetBuilder.``OutputExactGeometry`

  Returns or sets the output exact geometry

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

  Getter Method

  Signature `OutputExactGeometry`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputExactGeometry`

  Parameters: | outputExactGeometry (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## ProjectionDirection

`TrimSheetBuilder.``ProjectionDirection`

  Returns the projection direction

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

  Getter Method

  Signature `ProjectionDirection`

  Returns: | Projection Options data
  Return type: | `NXOpen.GeometricUtilities.ProjectionOptions`

  New in version NX5.0.0.

  License requirements: None.

## Regions

`TrimSheetBuilder.``Regions`

  Returns the regions

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

  Getter Method

  Signature `Regions`

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

  New in version NX5.0.0.

  License requirements: None.

## TargetBodies

`TrimSheetBuilder.``TargetBodies`

  Returns the target bodies

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

  Getter Method

  Signature `TargetBodies`

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

  New in version NX5.0.0.

  License requirements: None.

## Tolerance

`TrimSheetBuilder.``Tolerance`

  Returns or sets the tolerance

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

  Getter Method

  Signature `Tolerance`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Tolerance`

  Parameters: | tolerance (float) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

# Method Detail

## Validate

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