nxopen.geometricutilities

Interface RegionTracker

All Superinterfaces:

IComponentBuilder, Remote, TaggedObject

public interface RegionTracker
extends TaggedObject, IComponentBuilder

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RegionTracker.ExtremityType This enum represents the type of edge extremity.
static class	RegionTracker.VertexSelectorsData This class holds the data returned from getVertexSelectors()

Method Summary

Modifier and Type	Method and Description
void	appendOneBoundaryBody(Body boundaryBodyEid, boolean sideness) Append one new region boundary body to the region tracker License requirements: solid_modeling ("SOLIDS MODELING") .
Face[]	getEdgeSelectors() The input target or tool edges used to identify the region License requirements: None.
Face[]	getFaceSelectors() The input target or tool faces used to identify the region License requirements: None.
Body	getOwningBody() The owning body where the region is located onto License requirements: None.
RegionTracker.VertexSelectorsData	getVertexSelectors() The input target or tool vertices (edge extremities) used to identify the region License requirements: None.
boolean	onTool() Returns a flag indicating if the region belongs to the tool (true) or to the target (false) License requirements: None.
void	setEdgeSelectors(Edge[] entities) The input target or tool edges used to identify the region License requirements: solid_modeling ("SOLIDS MODELING") .
void	setFaceSelectors(Face[] entities) The input target or tool faces used to identify the region License requirements: solid_modeling ("SOLIDS MODELING") .
void	setOneEdgeSelector(Edge entity) An input target or tool edge used to identify the region License requirements: solid_modeling ("SOLIDS MODELING") .
void	setOneFaceSelector(Face entity) An input target or tool face used to identify the region License requirements: solid_modeling ("SOLIDS MODELING") .
void	setOnePointSelector(Point3d location) The input point location (x,y,z) used to identify the region License requirements: solid_modeling ("SOLIDS MODELING") .
void	setOneVertexSelector(Edge entity, RegionTracker.ExtremityType extremity) One input target or tool vertex (edge extremity) used to identify the region License requirements: solid_modeling ("SOLIDS MODELING") .
void	setOnTool(boolean isOnTool) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setOwningBody(Body owningBodyEid) The owning body where the region is located onto License requirements: solid_modeling ("SOLIDS MODELING") .
void	setVertexSelectors(Edge[] entities, RegionTracker.ExtremityType[] extremities) The input target or tool vertices (edge extremities) used to identify the region License requirements: solid_modeling ("SOLIDS MODELING") .

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

onTool

boolean onTool()
        throws NXException,
               RemoteException

Returns a flag indicating if the region belongs to the tool (true) or to the target (false)
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setOnTool

void setOnTool(boolean isOnTool)
        throws NXException,
               RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

isOnTool -

Throws:

NXException

RemoteException

getFaceSelectors

Face[] getFaceSelectors()
                 throws NXException,
                        RemoteException

The input target or tool faces used to identify the region
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setFaceSelectors

void setFaceSelectors(Face[] entities)
               throws NXException,
                      RemoteException

The input target or tool faces used to identify the region
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

entities - Entities to use as selector

Throws:

NXException

RemoteException

setOneFaceSelector

void setOneFaceSelector(Face entity)
                 throws NXException,
                        RemoteException

An input target or tool face used to identify the region
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

entity - Entity to use as selector

Throws:

NXException

RemoteException

getEdgeSelectors

Face[] getEdgeSelectors()
                 throws NXException,
                        RemoteException

The input target or tool edges used to identify the region
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setEdgeSelectors

void setEdgeSelectors(Edge[] entities)
               throws NXException,
                      RemoteException

The input target or tool edges used to identify the region
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

entities - Entities to use as selector

Throws:

NXException

RemoteException

setOneEdgeSelector

void setOneEdgeSelector(Edge entity)
                 throws NXException,
                        RemoteException

An input target or tool edge used to identify the region
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

entity - Entity to use as selector

Throws:

NXException

RemoteException

getVertexSelectors

RegionTracker.VertexSelectorsData getVertexSelectors()
                                              throws NXException,
                                                     RemoteException

The input target or tool vertices (edge extremities) used to identify the region
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setOneVertexSelector

void setOneVertexSelector(Edge entity,
                          RegionTracker.ExtremityType extremity)
                   throws NXException,
                          RemoteException

One input target or tool vertex (edge extremity) used to identify the region
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

entity - Entity to use as selector

extremity - Extremity (false : start, true : end) of the edge corresponding to vertex

Throws:

NXException

RemoteException

setVertexSelectors

void setVertexSelectors(Edge[] entities,
                        RegionTracker.ExtremityType[] extremities)
                 throws NXException,
                        RemoteException

The input target or tool vertices (edge extremities) used to identify the region
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

entities - Entities to use as selector

extremities - Extremity (false : start, true : end) of the edge corresponding to vertex

Throws:

NXException

RemoteException

setOnePointSelector

void setOnePointSelector(Point3d location)
                  throws NXException,
                         RemoteException

The input point location (x,y,z) used to identify the region
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Parameters:

location -

Throws:

NXException

RemoteException

getOwningBody

Body getOwningBody()
            throws NXException,
                   RemoteException

The owning body where the region is located onto
License requirements: None.

Created in NX11.0.1

Returns:

region owning entity

Throws:

NXException

RemoteException

setOwningBody

void setOwningBody(Body owningBodyEid)
            throws NXException,
                   RemoteException

The owning body where the region is located onto
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX11.0.1

Parameters:

owningBodyEid - region owning body

Throws:

NXException

RemoteException

appendOneBoundaryBody

void appendOneBoundaryBody(Body boundaryBodyEid,
                           boolean sideness)
                    throws NXException,
                           RemoteException

Append one new region boundary body to the region tracker
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX11.0.1

Parameters:

boundaryBodyEid - region boundary body

sideness - region boundary sideness

Throws:

NXException

RemoteException