TrimRegionBuilder Class

class NXOpen.Tooling.TrimRegionBuilder

Bases: NXOpen.Builder

Mold Wizard trim region management builder, trims a body to a boundary of edges, curves or bodies.

Optionally creates output trimmed sheet body as a patch surface. To create a new instance of this class, use NXOpen.Tooling.TrimRegionCollection.CreateTrimRegionBuilder()

Default values.

Property Value
AsPatchSurface 1
BoundaryType BodyCurve
RegionType Keep

New in version NX7.5.0.

Properties

Property Description
AsPatchSurface Returns or sets the value of option, which specifies whether to set the result region as patch surface or not.
BodyColor Returns or sets the color value of patch surface body.
BoundaryBody Returns the selection of boundary body to extract region faces, which are used for create intersection curves with target.
BoundaryType Returns or sets the value of boundary type option, which specifies to use body or edge/curve as boundary object.
LoopCollector Returns the loop collector to collect the traverse loops.
RegionPoint Returns the selection of region point, which will be kept or discarded as the result of trim region.
RegionType Returns or sets the value of the option, which specifies to keep or discard the selected region.
Tag Returns the Tag for this object.
TargetBody Returns the selection of target to create trim region, body type only.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetColorValue Returns the value of surface patch color.
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.
SetColorValue Sets the value of surface patch color.
SetTraverseEdges Sets the edges from traverse loop to builder 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.

Enumerations

TrimRegionBuilderBoundaryOption Enumeration represents the boundary type option, body/curve type or traverse type.
TrimRegionBuilderRegionOption Enumeration represents the option to keep or discard the selected region.

Property Detail

AsPatchSurface

TrimRegionBuilder.AsPatchSurface

Returns or sets the value of option, which specifies whether to set the result region as patch surface or not.

-------------------------------------

Getter Method

Signature AsPatchSurface

Returns:
Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AsPatchSurface

Parameters:asPatchSurface (bool) –

New in version NX7.5.0.

License requirements: None.

BodyColor

TrimRegionBuilder.BodyColor

Returns or sets the color value of patch surface body.

-------------------------------------

Getter Method

Signature BodyColor

Returns:the color index
Return type:Id

New in version NX8.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature BodyColor

Parameters:patchColor (Id) – the color index

New in version NX8.0.1.

License requirements: None.

BoundaryBody

TrimRegionBuilder.BoundaryBody

Returns the selection of boundary body to extract region faces, which are used for create intersection curves with target.

-------------------------------------

Getter Method

Signature BoundaryBody

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX7.5.0.

License requirements: None.

BoundaryType

TrimRegionBuilder.BoundaryType

Returns or sets the value of boundary type option, which specifies to use body or edge/curve as boundary object.

-------------------------------------

Getter Method

Signature BoundaryType

Returns:
Return type:NXOpen.Tooling.TrimRegionBuilderBoundaryOption

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BoundaryType

Parameters:boundaryType (NXOpen.Tooling.TrimRegionBuilderBoundaryOption) –

New in version NX7.5.0.

License requirements: None.

LoopCollector

TrimRegionBuilder.LoopCollector

Returns the loop collector to collect the traverse loops.

-------------------------------------

Getter Method

Signature LoopCollector

Returns:
Return type:NXOpen.ScCollector

New in version NX8.0.0.

License requirements: None.

RegionPoint

TrimRegionBuilder.RegionPoint

Returns the selection of region point, which will be kept or discarded as the result of trim region.

-------------------------------------

Getter Method

Signature RegionPoint

Returns:
Return type:NXOpen.RegionPointList

New in version NX7.5.0.

License requirements: None.

RegionType

TrimRegionBuilder.RegionType

Returns or sets the value of the option, which specifies to keep or discard the selected region.

-------------------------------------

Getter Method

Signature RegionType

Returns:
Return type:NXOpen.Tooling.TrimRegionBuilderRegionOption

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RegionType

Parameters:regionType (NXOpen.Tooling.TrimRegionBuilderRegionOption) –

New in version NX7.5.0.

License requirements: None.

TargetBody

TrimRegionBuilder.TargetBody

Returns the selection of target to create trim region, body type only.

-------------------------------------

Getter Method

Signature TargetBody

Returns:
Return type:NXOpen.SelectBody

New in version NX7.5.0.

License requirements: None.

Method Detail

GetColorValue

TrimRegionBuilder.GetColorValue

Returns the value of surface patch color.

Signature GetColorValue()

Returns:a tuple
Return type:A tuple consisting of (redValue, greenValue, blueValue) redValue is a float. red value between 0 and 1 greenValue is a float. green value between 0 and 1 blueValue is a float. blue value between 0 and 1

New in version NX7.5.0.

License requirements: None.

SetColorValue

TrimRegionBuilder.SetColorValue

Sets the value of surface patch color.

Signature SetColorValue(redValue, greenValue, blueValue)

Parameters:
  • redValue (float) – red value between 0 and 1
  • greenValue (float) – green value between 0 and 1
  • blueValue (float) – blue value between 0 and 1

New in version NX7.5.0.

License requirements: None.

SetTraverseEdges

TrimRegionBuilder.SetTraverseEdges

Sets the edges from traverse loop to builder data.

Signature SetTraverseEdges(traverseEdges)

Parameters:traverseEdges (list of NXOpen.NXObject) – the selected edges

New in version NX7.5.0.

License requirements: None.

Validate

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