MWDefineRegionsBuilder Class

class NXOpen.Tooling.MWDefineRegionsBuilder

Bases: NXOpen.Builder

The MWDefineRegions builder

To create a new instance of this class, use NXOpen.Tooling.MWDefineRegionsCollection.CreateBuilder()

Default values.

Property Value
CreatePartingLinesToggle 0
CreateRegionsToggle 0
TranslucencyOption SelectedFaces
TranslucencyValueScale 0

New in version NX6.0.0.

Properties

Property Description
CreatePartingLinesToggle Returns or sets the create parting lines toggle
CreateRegionsToggle Returns or sets the create regions toggle
FaceColor Returns or sets the face color for the selected region faces
SelectRegionFaces Returns the region faces for defining region
Tag Returns the Tag for this object.
TranslucencyOption Returns or sets the translucency option for the selected or non-selected region faces
TranslucencyValueScale Returns or sets the translucency value for the selected or non-selected region faces

Methods

Method Description
ChangeCurrentRegionName Change the region name for the current region
ChangeEntitiesColor Change the color of displayable entities
ChangeRegionFacesColor Change the color of the faces of a region
ChangeRegionLayer Change the layer of the region
Commit Commits any edits that have been applied to the builder.
CreateNewRegion Create a new region
CreateNewRegionButton Button to create a new empty region
DeleteAllExistingRegions Delete all existing regions
DeleteRegion Delete a region
Destroy Deletes the builder, and cleans up any objects created by the builder.
DisplayProductBody Display the product body in the part file
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.
GetOrCreateEmptyRegion Get or create an empty region
HookupRegionUdoAndBodyForCavityAndCore Hook up cavity and core region UDO objects with the corresponding sheet bodies
SearchRegionButton Button to invoke searching region
SetCurrentRegion Set the current region
SetupRegionsInfo Setup the UI data for defining regions
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateUndefinedFaces Update the undefined faces
UpdateUnsewnBodiesNameAttribute Update name attribute for the unsew bodies of the cavity and core regions
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

MWDefineRegionsBuilderTranslucencyOptionType Enumeration This enum represents the translucency is to be performed on the selected or non-selected region faces

Property Detail

CreatePartingLinesToggle

MWDefineRegionsBuilder.CreatePartingLinesToggle

Returns or sets the create parting lines toggle

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

Getter Method

Signature CreatePartingLinesToggle

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature CreatePartingLinesToggle

Parameters:createPartingLinesToggle (bool) –

New in version NX6.0.0.

License requirements: None.

CreateRegionsToggle

MWDefineRegionsBuilder.CreateRegionsToggle

Returns or sets the create regions toggle

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

Getter Method

Signature CreateRegionsToggle

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature CreateRegionsToggle

Parameters:createRegionsToggle (bool) –

New in version NX6.0.0.

License requirements: None.

FaceColor

MWDefineRegionsBuilder.FaceColor

Returns or sets the face color for the selected region faces

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

Getter Method

Signature FaceColor

Returns:
Return type:Id

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature FaceColor

Parameters:faceColor (Id) –

New in version NX6.0.0.

License requirements: None.

SelectRegionFaces

MWDefineRegionsBuilder.SelectRegionFaces

Returns the region faces for defining region

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

Getter Method

Signature SelectRegionFaces

Returns:
Return type:NXOpen.ScCollector

New in version NX6.0.0.

License requirements: None.

TranslucencyOption

MWDefineRegionsBuilder.TranslucencyOption

Returns or sets the translucency option for the selected or non-selected region faces

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

Getter Method

Signature TranslucencyOption

Returns:
Return type:NXOpen.Tooling.MWDefineRegionsBuilderTranslucencyOptionType

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature TranslucencyOption

Parameters:translucencyOption (NXOpen.Tooling.MWDefineRegionsBuilderTranslucencyOptionType) –

New in version NX6.0.0.

License requirements: None.

TranslucencyValueScale

MWDefineRegionsBuilder.TranslucencyValueScale

Returns or sets the translucency value for the selected or non-selected region faces

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

Getter Method

Signature TranslucencyValueScale

Returns:
Return type:int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature TranslucencyValueScale

Parameters:translucencyValueScale (int) –

New in version NX6.0.0.

License requirements: None.

Method Detail

ChangeCurrentRegionName

MWDefineRegionsBuilder.ChangeCurrentRegionName

Change the region name for the current region

Signature ChangeCurrentRegionName(regionName)

Parameters:regionName (str) – region name
Returns:return status
Return type:int

New in version NX6.0.3.

License requirements: None.

ChangeEntitiesColor

MWDefineRegionsBuilder.ChangeEntitiesColor

Change the color of displayable entities

Signature ChangeEntitiesColor(entities, color)

Parameters:
  • entities (list of NXOpen.TaggedObject) – an array of entities
  • color (int) – color for entities

New in version NX6.0.3.

License requirements: None.

ChangeRegionFacesColor

MWDefineRegionsBuilder.ChangeRegionFacesColor

Change the color of the faces of a region

Signature ChangeRegionFacesColor(regionName, allOrUndefined, color)

Parameters:
  • regionName (str) – region name
  • allOrUndefined (int) – 1: All faces, 2: Undefined faces when regionUDO is 0
  • color (int) – color for region faces

New in version NX6.0.3.

License requirements: None.

ChangeRegionLayer

MWDefineRegionsBuilder.ChangeRegionLayer

Change the layer of the region

Signature ChangeRegionLayer(regionName, layer)

Parameters:
  • regionName (str) – region name
  • layer (int) – layer for region faces

New in version NX6.0.3.

License requirements: None.

CreateNewRegion

MWDefineRegionsBuilder.CreateNewRegion

Create a new region

Signature CreateNewRegion()

Returns:new region object created
Return type:str

New in version NX6.0.3.

License requirements: None.

CreateNewRegionButton

MWDefineRegionsBuilder.CreateNewRegionButton

Button to create a new empty region

Signature CreateNewRegionButton()

New in version NX6.0.0.

License requirements: None.

DeleteAllExistingRegions

MWDefineRegionsBuilder.DeleteAllExistingRegions

Delete all existing regions

Signature DeleteAllExistingRegions()

New in version NX6.0.3.

License requirements: None.

DeleteRegion

MWDefineRegionsBuilder.DeleteRegion

Delete a region

Signature DeleteRegion(regionName)

Parameters:regionName (str) – region object to be deleted

New in version NX6.0.3.

License requirements: None.

DisplayProductBody

MWDefineRegionsBuilder.DisplayProductBody

Display the product body in the part file

Signature DisplayProductBody()

New in version NX6.0.3.

License requirements: None.

GetOrCreateEmptyRegion

MWDefineRegionsBuilder.GetOrCreateEmptyRegion

Get or create an empty region

Signature GetOrCreateEmptyRegion()

Returns:a tuple
Return type:A tuple consisting of (regionName, created) regionName is a str. empty region object created is a int. Return flag indicating if an empty region UDO is created

New in version NX6.0.3.

License requirements: None.

HookupRegionUdoAndBodyForCavityAndCore

MWDefineRegionsBuilder.HookupRegionUdoAndBodyForCavityAndCore

Hook up cavity and core region UDO objects with the corresponding sheet bodies

Signature HookupRegionUdoAndBodyForCavityAndCore()

New in version NX6.0.3.

License requirements: None.

SearchRegionButton

MWDefineRegionsBuilder.SearchRegionButton

Button to invoke searching region

Signature SearchRegionButton()

New in version NX6.0.0.

License requirements: None.

SetCurrentRegion

MWDefineRegionsBuilder.SetCurrentRegion

Set the current region

Signature SetCurrentRegion(regionName)

Parameters:regionName (str) – current region name

New in version NX6.0.3.

License requirements: None.

SetupRegionsInfo

MWDefineRegionsBuilder.SetupRegionsInfo

Setup the UI data for defining regions

Signature SetupRegionsInfo()

New in version NX6.0.3.

License requirements: None.

UpdateUndefinedFaces

MWDefineRegionsBuilder.UpdateUndefinedFaces

Update the undefined faces

Signature UpdateUndefinedFaces(changeColor)

Parameters:changeColor (int) – indicator for changing color too

New in version NX6.0.3.

License requirements: None.

UpdateUnsewnBodiesNameAttribute

MWDefineRegionsBuilder.UpdateUnsewnBodiesNameAttribute

Update name attribute for the unsew bodies of the cavity and core regions

Signature UpdateUnsewnBodiesNameAttribute(unsewFeatureTag, cavityFaces)

Parameters:

New in version NX6.0.3.

License requirements: None.

Validate

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