DefineWorkRegionBuilder Class

class NXOpen.Features.Subdivision.DefineWorkRegionBuilder

Bases: NXOpen.Builder

Represents a Features.Subdivision.DefineWorkRegionBuilder builder.

To create a new instance of this class, use NXOpen.Features.Subdivision.SubdivisionBodyCollection.CreateDefineWorkRegionBuilder()

New in version NX11.0.0.

Properties

Property Description
FrozenColor Returns or sets the frozen region color
FrozenRegionDefinitionMethod Returns or sets the frozen region method
Tag Returns the Tag for this object.
WorkRegionDefinitionMethod Returns or sets the work region definition method
WorkRegionObjects Returns the work region objects

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

FrozenColor

DefineWorkRegionBuilder.FrozenColor

Returns or sets the frozen region color

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

Getter Method

Signature FrozenColor

Returns:
Return type:Id

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature FrozenColor

Parameters:frozenColor (Id) –

New in version NX11.0.0.

License requirements: nx_subdivision (” NX SUBDIVISION”)

FrozenRegionDefinitionMethod

DefineWorkRegionBuilder.FrozenRegionDefinitionMethod

Returns or sets the frozen region method

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

Getter Method

Signature FrozenRegionDefinitionMethod

Returns:
Return type:NXOpen.Features.Subdivision.DefineWorkRegionBuilderFrozenRegionDefinitionMethods

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature FrozenRegionDefinitionMethod

Parameters:frozenRegionDefinitionMethod (NXOpen.Features.Subdivision.DefineWorkRegionBuilderFrozenRegionDefinitionMethods) –

New in version NX11.0.0.

License requirements: nx_subdivision (” NX SUBDIVISION”)

WorkRegionDefinitionMethod

DefineWorkRegionBuilder.WorkRegionDefinitionMethod

Returns or sets the work region definition method

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

Getter Method

Signature WorkRegionDefinitionMethod

Returns:
Return type:NXOpen.Features.Subdivision.DefineWorkRegionBuilderWorkRegionDefinitionMethods

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature WorkRegionDefinitionMethod

Parameters:workRegionDefinitionMethod (NXOpen.Features.Subdivision.DefineWorkRegionBuilderWorkRegionDefinitionMethods) –

New in version NX11.0.0.

License requirements: nx_subdivision (” NX SUBDIVISION”)

WorkRegionObjects

DefineWorkRegionBuilder.WorkRegionObjects

Returns the work region objects

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

Getter Method

Signature WorkRegionObjects

Returns:
Return type:NXOpen.Features.Subdivision.SelectCageObjectData

New in version NX11.0.0.

License requirements: None.

Method Detail

Validate

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