NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.GeometricUtilities.RegionTracker Class Reference

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

Inheritance diagram for NXOpen.GeometricUtilities.RegionTracker:
NXOpen.GeometricUtilities.IComponentBuilder

Public Types

enum  ExtremityType { Start, End }
 This enum represents the type of edge extremity. More...
 

Public Member Functions

unsafe void GetFaceSelectors (out NXOpen.Face[] entities)
 The input target or tool faces used to identify the region More...
 
unsafe void SetFaceSelectors (NXOpen.Face[] entities)
 The input target or tool faces used to identify the region More...
 
unsafe void SetOneFaceSelector (NXOpen.Face entity)
 An input target or tool face used to identify the region More...
 
unsafe void GetEdgeSelectors (out NXOpen.Face[] entities)
 The input target or tool edges used to identify the region More...
 
unsafe void SetEdgeSelectors (NXOpen.Edge[] entities)
 The input target or tool edges used to identify the region More...
 
unsafe void SetOneEdgeSelector (NXOpen.Edge entity)
 An input target or tool edge used to identify the region More...
 
unsafe void GetVertexSelectors (out NXOpen.Edge[] entities, out NXOpen.GeometricUtilities.RegionTracker.ExtremityType[] extremities)
 The input target or tool vertices (edge extremities) used to identify the region More...
 
unsafe void SetOneVertexSelector (NXOpen.Edge entity, NXOpen.GeometricUtilities.RegionTracker.ExtremityType extremity)
 One input target or tool vertex (edge extremity) used to identify the region More...
 
unsafe void SetVertexSelectors (NXOpen.Edge[] entities, NXOpen.GeometricUtilities.RegionTracker.ExtremityType[] extremities)
 The input target or tool vertices (edge extremities) used to identify the region More...
 
unsafe void SetOnePointSelector (NXOpen.Point3d location)
 The input point location (x,y,z) used to identify the region More...
 
unsafe NXOpen.Body GetOwningBody ()
 The owning body where the region is located onto More...
 
unsafe void SetOwningBody (NXOpen.Body owningBodyEid)
 The owning body where the region is located onto More...
 
unsafe void AppendOneBoundaryBody (NXOpen.Body boundaryBodyEid, bool sideness)
 Append one new region boundary body to the region tracker More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 

Properties

unsafe bool OnTool [get, set]
 Returns or sets a flag indicating if the region belongs to the tool (true) or to the target (false) More...
 

Detailed Description

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

Created in NX8.5.0

Member Enumeration Documentation

This enum represents the type of edge extremity.

This is used to track vertices.

Enumerator
Start 

start

End 

end

Member Function Documentation

unsafe void NXOpen.GeometricUtilities.RegionTracker.AppendOneBoundaryBody ( NXOpen.Body  boundaryBodyEid,
bool  sideness 
)

Append one new region boundary body to the region tracker

Created in NX11.0.1

License requirements: solid_modeling ("SOLIDS MODELING")

Parameters
boundaryBodyEidregion boundary body
sidenessregion boundary sideness
unsafe void NXOpen.GeometricUtilities.RegionTracker.GetEdgeSelectors ( out NXOpen.Face[]  entities)

The input target or tool edges used to identify the region

Created in NX8.5.0

License requirements: None.

Parameters
entitiesEntities to use as selector
unsafe void NXOpen.GeometricUtilities.RegionTracker.GetFaceSelectors ( out NXOpen.Face[]  entities)

The input target or tool faces used to identify the region

Created in NX8.5.0

License requirements: None.

Parameters
entitiesEntities to use as selector
unsafe NXOpen.Body NXOpen.GeometricUtilities.RegionTracker.GetOwningBody ( )

The owning body where the region is located onto

Created in NX11.0.1

License requirements: None.

Returns
region owning entity
unsafe void NXOpen.GeometricUtilities.RegionTracker.GetVertexSelectors ( out NXOpen.Edge[]  entities,
out NXOpen.GeometricUtilities.RegionTracker.ExtremityType[]  extremities 
)

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

Created in NX8.5.0

License requirements: None.

Parameters
entitiesEdges associated with the vertex
extremitiesExtremity (false : start, true : end) of the edge corresponding to vertex
unsafe void NXOpen.GeometricUtilities.RegionTracker.SetEdgeSelectors ( NXOpen.Edge[]  entities)

The input target or tool edges used to identify the region

Created in NX8.5.0

License requirements: solid_modeling ("SOLIDS MODELING")

Parameters
entitiesEntities to use as selector
unsafe void NXOpen.GeometricUtilities.RegionTracker.SetFaceSelectors ( NXOpen.Face[]  entities)

The input target or tool faces used to identify the region

Created in NX8.5.0

License requirements: solid_modeling ("SOLIDS MODELING")

Parameters
entitiesEntities to use as selector
unsafe void NXOpen.GeometricUtilities.RegionTracker.SetOneEdgeSelector ( NXOpen.Edge  entity)

An input target or tool edge used to identify the region

Created in NX8.5.0

License requirements: solid_modeling ("SOLIDS MODELING")

Parameters
entityEntity to use as selector
unsafe void NXOpen.GeometricUtilities.RegionTracker.SetOneFaceSelector ( NXOpen.Face  entity)

An input target or tool face used to identify the region

Created in NX8.5.0

License requirements: solid_modeling ("SOLIDS MODELING")

Parameters
entityEntity to use as selector
unsafe void NXOpen.GeometricUtilities.RegionTracker.SetOnePointSelector ( NXOpen.Point3d  location)

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

Created in NX8.5.0

License requirements: solid_modeling ("SOLIDS MODELING")

Parameters
location
unsafe void NXOpen.GeometricUtilities.RegionTracker.SetOneVertexSelector ( NXOpen.Edge  entity,
NXOpen.GeometricUtilities.RegionTracker.ExtremityType  extremity 
)

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

Created in NX8.5.0

License requirements: solid_modeling ("SOLIDS MODELING")

Parameters
entityEntity to use as selector
extremityExtremity (false : start, true : end) of the edge corresponding to vertex
unsafe void NXOpen.GeometricUtilities.RegionTracker.SetOwningBody ( NXOpen.Body  owningBodyEid)

The owning body where the region is located onto

Created in NX11.0.1

License requirements: solid_modeling ("SOLIDS MODELING")

Parameters
owningBodyEidregion owning body
unsafe void NXOpen.GeometricUtilities.RegionTracker.SetVertexSelectors ( NXOpen.Edge[]  entities,
NXOpen.GeometricUtilities.RegionTracker.ExtremityType[]  extremities 
)

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

Created in NX8.5.0

License requirements: solid_modeling ("SOLIDS MODELING")

Parameters
entitiesEntities to use as selector
extremitiesExtremity (false : start, true : end) of the edge corresponding to vertex
unsafe bool NXOpen.GeometricUtilities.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.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe bool NXOpen.GeometricUtilities.RegionTracker.OnTool
getset

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

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.