RegionTracker Class

class NXOpen.GeometricUtilities.RegionTracker

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

a class which collects all the geometric entities used to identify a region of faces during a boolean feature.

New in version NX8.5.0.

Properties

Property Description
OnTool Returns or sets a flag indicating if the region belongs to the tool (true) or to the target (false)
Tag Returns the Tag for this object.

Methods

Method Description
AppendOneBoundaryBody Append one new region boundary body to the region tracker
GetEdgeSelectors The input target or tool edges used to identify the region
GetFaceSelectors The input target or tool faces used to identify the region
GetOwningBody The owning body where the region is located onto
GetVertexSelectors The input target or tool vertices (edge extremities) used to identify the region
SetEdgeSelectors The input target or tool edges used to identify the region
SetFaceSelectors The input target or tool faces used to identify the region
SetOneEdgeSelector An input target or tool edge used to identify the region
SetOneFaceSelector An input target or tool face used to identify the region
SetOnePointSelector The input point location (x,y,z) used to identify the region
SetOneVertexSelector One input target or tool vertex (edge extremity) used to identify the region
SetOwningBody The owning body where the region is located onto
SetVertexSelectors The input target or tool vertices (edge extremities) used to identify the region
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

RegionTrackerExtremityType Enumeration This enum represents the type of edge extremity.

Property Detail

OnTool

RegionTracker.OnTool

Returns or sets a flag indicating if the region belongs to the tool (true) or to the target (false)

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

Getter Method

Signature OnTool

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature OnTool

Parameters:isOnTool (bool) –

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

Method Detail

AppendOneBoundaryBody

RegionTracker.AppendOneBoundaryBody

Append one new region boundary body to the region tracker

Signature AppendOneBoundaryBody(boundaryBodyEid, sideness)

Parameters:
  • boundaryBodyEid (NXOpen.Body) – region boundary body
  • sideness (bool) – region boundary sideness

New in version NX11.0.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

GetEdgeSelectors

RegionTracker.GetEdgeSelectors

The input target or tool edges used to identify the region

Signature GetEdgeSelectors()

Returns:Entities to use as selector
Return type:list of NXOpen.Face

New in version NX8.5.0.

License requirements: None.

GetFaceSelectors

RegionTracker.GetFaceSelectors

The input target or tool faces used to identify the region

Signature GetFaceSelectors()

Returns:Entities to use as selector
Return type:list of NXOpen.Face

New in version NX8.5.0.

License requirements: None.

GetOwningBody

RegionTracker.GetOwningBody

The owning body where the region is located onto

Signature GetOwningBody()

Returns:region owning entity
Return type:NXOpen.Body

New in version NX11.0.1.

License requirements: None.

GetVertexSelectors

RegionTracker.GetVertexSelectors

The input target or tool vertices (edge extremities) used to identify the region

Signature GetVertexSelectors()

Returns:a tuple
Return type:A tuple consisting of (entities, extremities). entities is a list of NXOpen.Edge. Edges associated with the vertex extremities is a list of NXOpen.GeometricUtilities.RegionTrackerExtremityType. Extremity (false : start, true : end) of the edge corresponding to vertex

New in version NX8.5.0.

License requirements: None.

SetEdgeSelectors

RegionTracker.SetEdgeSelectors

The input target or tool edges used to identify the region

Signature SetEdgeSelectors(entities)

Parameters:entities (list of NXOpen.Edge) – Entities to use as selector

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

SetFaceSelectors

RegionTracker.SetFaceSelectors

The input target or tool faces used to identify the region

Signature SetFaceSelectors(entities)

Parameters:entities (list of NXOpen.Face) – Entities to use as selector

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

SetOneEdgeSelector

RegionTracker.SetOneEdgeSelector

An input target or tool edge used to identify the region

Signature SetOneEdgeSelector(entity)

Parameters:entity (NXOpen.Edge) – Entity to use as selector

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

SetOneFaceSelector

RegionTracker.SetOneFaceSelector

An input target or tool face used to identify the region

Signature SetOneFaceSelector(entity)

Parameters:entity (NXOpen.Face) – Entity to use as selector

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

SetOnePointSelector

RegionTracker.SetOnePointSelector

The input point location (x,y,z) used to identify the region

Signature SetOnePointSelector(location)

Parameters:location (NXOpen.Point3d) –

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

SetOneVertexSelector

RegionTracker.SetOneVertexSelector

One input target or tool vertex (edge extremity) used to identify the region

Signature SetOneVertexSelector(entity, extremity)

Parameters:

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

SetOwningBody

RegionTracker.SetOwningBody

The owning body where the region is located onto

Signature SetOwningBody(owningBodyEid)

Parameters:owningBodyEid (NXOpen.Body) – region owning body

New in version NX11.0.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

SetVertexSelectors

RegionTracker.SetVertexSelectors

The input target or tool vertices (edge extremities) used to identify the region

Signature SetVertexSelectors(entities, extremities)

Parameters:

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

Validate

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