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:

Public Types
enum	ExtremityType { ExtremityTypeStart, ExtremityTypeEnd }
	This enum represents the type of edge extremity. More...

Public Member Functions
void	GetEdgeSelectors (std::vector< NXOpen::Face * > &entities)
	The input target or tool edges used to identify the region Created in NX8.5.0.
void	GetFaceSelectors (std::vector< NXOpen::Face * > &entities)
	The input target or tool faces used to identify the region Created in NX8.5.0.
void	GetVertexSelectors (std::vector< NXOpen::Edge * > &entities, std::vector< NXOpen::GeometricUtilities::RegionTracker::ExtremityType > &extremities)
	The input target or tool vertices (edge extremities) used to identify the region Created in NX8.5.0.
bool	OnTool ()
	Returns a flag indicating if the region belongs to the tool (true) or to the target (false) Created in NX8.5.0.
void	SetEdgeSelectors (const std::vector< NXOpen::Edge * > &entities)
	The input target or tool edges used to identify the region Created in NX8.5.0.
void	SetFaceSelectors (const std::vector< NXOpen::Face * > &entities)
	The input target or tool faces used to identify the region Created in NX8.5.0.
void	SetOneEdgeSelector (NXOpen::Edge *entity)
	An input target or tool edge used to identify the region Created in NX8.5.0.
void	SetOneFaceSelector (NXOpen::Face *entity)
	An input target or tool face used to identify the region Created in NX8.5.0.
void	SetOnePointSelector (const NXOpen::Point3d &location)
	The input point location (x,y,z) used to identify the region Created in NX8.5.0.
void	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.
void	SetOnTool (bool isOnTool)
	Sets a flag indicating if the region belongs to the tool (true) or to the target (false) Created in NX8.5.0.
void	SetVertexSelectors (const std::vector< NXOpen::Edge * > &entities, const std::vector< NXOpen::GeometricUtilities::RegionTracker::ExtremityType > &extremities)
	The input target or tool vertices (edge extremities) used to identify the region Created in NX8.5.0.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

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

enum NXOpen::GeometricUtilities::RegionTracker::ExtremityType

This enum represents the type of edge extremity.

This is used to track vertices.

Enumerator:

ExtremityTypeStart	start
ExtremityTypeEnd	end

Member Function Documentation

void NXOpen::GeometricUtilities::RegionTracker::GetEdgeSelectors

(

std::vector< NXOpen::Face * > &

entities

)

The input target or tool edges used to identify the region
Created in NX8.5.0.

License requirements : None

Parameters

entities

Entities to use as selector

void NXOpen::GeometricUtilities::RegionTracker::GetFaceSelectors

(

std::vector< NXOpen::Face * > &

entities

)

The input target or tool faces used to identify the region
Created in NX8.5.0.

License requirements : None

Parameters

entities

Entities to use as selector

void NXOpen::GeometricUtilities::RegionTracker::GetVertexSelectors	(	std::vector< NXOpen::Edge * > &	entities,
		std::vector< 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

entities	Edges associated with the vertex
extremities	Extremity (false : start, true : end) of the edge corresponding to vertex

bool NXOpen::GeometricUtilities::RegionTracker::OnTool

(

)

Returns a flag indicating if the region belongs to the tool (true) or to the target (false)
Created in NX8.5.0.

License requirements : None

void NXOpen::GeometricUtilities::RegionTracker::SetEdgeSelectors

(

const std::vector< 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

entities

Entities to use as selector

void NXOpen::GeometricUtilities::RegionTracker::SetFaceSelectors

(

const std::vector< 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

entities

Entities to use as selector

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

entity

Entity to use as selector

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

entity

Entity to use as selector

void NXOpen::GeometricUtilities::RegionTracker::SetOnePointSelector

(

const 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

location

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

entity	Entity to use as selector
extremity	Extremity (false : start, true : end) of the edge corresponding to vertex

void NXOpen::GeometricUtilities::RegionTracker::SetOnTool

(

bool

isOnTool

)

Sets a flag indicating if the region belongs to the tool (true) or to the target (false)
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

isOnTool

isontool

void NXOpen::GeometricUtilities::RegionTracker::SetVertexSelectors	(	const std::vector< NXOpen::Edge * > &	entities,
		const std::vector< 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

entities	Entities to use as selector
extremities	Extremity (false : start, true : end) of the edge corresponding to vertex

virtual bool NXOpen::GeometricUtilities::RegionTracker::Validate ( )

virtual

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.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

---

The documentation for this class was generated from the following file:

• GeometricUtilities_RegionTracker.hxx