NXOpen::Tooling::TraverseLoopBuilder Class Reference

The builder class for Traverse Loop component which assists you to select or traverse a string of adjacent curves or edges. More...

Inheritance diagram for NXOpen::Tooling::TraverseLoopBuilder:

Public Member Functions
void	ActAccept ()
	Accept current path.
void	ActBack ()
	Traverse back action.
void	ActClose ()
	Close current loop.
void	ActCycle ()
	Cycle candidate path.
void	ActEdgeSelection (const std::vector< NXOpen::NXObject * > &pTolSelObject, const std::vector< NXOpen::NXObject * > &selections, const std::vector< NXOpen::NXObject * > &deselections, const NXOpen::Point3d &cpoint, bool selectEndEdge)
	Start traverse after selecting edges or curve.
void	ActExit ()
	Exit current loop.
bool	BridgeGap ()
	Returns the option to bridge gap or not.
bool	ByColor ()
	Returns a Traverse loop by following face color or not.
double	CheckGap (const std::vector< NXOpen::NXObject * > &selections, NXOpen::Point3d *nearPoint)
	Calculate the gap between last selected objects and existing loop string, and find out the nearest end point.
bool	EndEdge ()
	Returns a Traverse loop by using start edge/end edge or not.
bool	ExitLoop ()
	Returns the option to exit the current loop.
void	MoveCurves (const std::vector< NXOpen::NXObject * > &pPartingLines)
	Move extract curves that are not parting lines to the invisible layer.
void	ResetTraverseData ()
	Reset traverse data after one loop closed.
NXOpen::ScCollector *	SelectEdge ()
	Returns the selected edges and curves which will form the loop.
void	SetBridgeGap (bool bridgeGap)
	Sets the option to bridge gap or not.
void	SetByColor (bool byColor)
	Sets a Traverse loop by following face color or not.
void	SetEndEdge (bool endEdge)
	Sets a Traverse loop by using start edge/end edge or not.
void	SetExitLoop (bool isExitLoop)
	Sets the option to exit the current loop.
void	SetTolSetting (double tolSetting)
	Sets the chaining tolerance.
void	SetTraverseStartEndPoint (NXOpen::NXObject *candidate, const NXOpen::Point3d &pointCloseCursor, const std::vector< NXOpen::NXObject * > &selections)
	Set start and end points for traversal.
void	SwitchToPartinglineLayer ()
	Make parting layer as the work layer.
double	TolSetting ()
	Returns the chaining tolerance.
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
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

The builder class for Traverse Loop component which assists you to select or traverse a string of adjacent curves or edges.

To create a new instance of this class, use Tooling::TraverseLoopCollection::CreateBuilder
Default values.

Property	Value
BridgeGap	0
ByColor	0
EndEdge	0
TolSetting	0.0254

Created in NX7.5.0.

Member Function Documentation

void NXOpen::Tooling::TraverseLoopBuilder::ActAccept

(

)

Accept current path.

Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::TraverseLoopBuilder::ActBack

(

)

Traverse back action.

Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::TraverseLoopBuilder::ActClose

(

)

Close current loop.

Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::TraverseLoopBuilder::ActCycle

(

)

Cycle candidate path.

Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::TraverseLoopBuilder::ActEdgeSelection	(	const std::vector< NXOpen::NXObject * > &	pTolSelObject,
		const std::vector< NXOpen::NXObject * > &	selections,
		const std::vector< NXOpen::NXObject * > &	deselections,
		const NXOpen::Point3d &	cpoint,
		bool	selectEndEdge
	)

Start traverse after selecting edges or curve.

Created in NX7.5.0.

License requirements : None

Parameters

pTolSelObject	Total selected objects.
selections	Last selected objects.
deselections	Last deselected objects.
cpoint	Cursor point position when selecting one edge first time.
selectEndEdge	Whether last selected object is the end edge.

void NXOpen::Tooling::TraverseLoopBuilder::ActExit

(

)

Exit current loop.

Created in NX7.5.0.

License requirements : None

bool NXOpen::Tooling::TraverseLoopBuilder::BridgeGap

(

)

Returns the option to bridge gap or not.

Created in NX7.5.0.

License requirements : None

bool NXOpen::Tooling::TraverseLoopBuilder::ByColor

(

)

Returns a Traverse loop by following face color or not.

Created in NX7.5.0.

License requirements : None

double NXOpen::Tooling::TraverseLoopBuilder::CheckGap	(	const std::vector< NXOpen::NXObject * > &	selections,
		NXOpen::Point3d *	nearPoint
	)

Calculate the gap between last selected objects and existing loop string, and find out the nearest end point.

Returns

The gap between nearPoint and end point of existing loop string.
Created in NX7.5.0.

License requirements : None

Parameters

selections	Last selected objects.
nearPoint	End point of last selected object near to end point of existing loop string.

bool NXOpen::Tooling::TraverseLoopBuilder::EndEdge

(

)

Returns a Traverse loop by using start edge/end edge or not.

Created in NX7.5.0.

License requirements : None

bool NXOpen::Tooling::TraverseLoopBuilder::ExitLoop

(

)

Returns the option to exit the current loop.

Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::TraverseLoopBuilder::MoveCurves

(

const std::vector< NXOpen::NXObject * > &

pPartingLines

)

Move extract curves that are not parting lines to the invisible layer.

Created in NX7.5.0.

License requirements : None

Parameters

pPartingLines

parting lines obtained by Traverse Loop which can be edges or curves.

void NXOpen::Tooling::TraverseLoopBuilder::ResetTraverseData

(

)

Reset traverse data after one loop closed.

Created in NX7.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Tooling::TraverseLoopBuilder::SelectEdge

(

)

Returns the selected edges and curves which will form the loop.

Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::TraverseLoopBuilder::SetBridgeGap

(

bool

bridgeGap

)

Sets the option to bridge gap or not.

Created in NX7.5.0.

License requirements : None

Parameters

bridgeGap

bridgegap

void NXOpen::Tooling::TraverseLoopBuilder::SetByColor

(

bool

byColor

)

Sets a Traverse loop by following face color or not.

Created in NX7.5.0.

License requirements : None

Parameters

byColor

bycolor

void NXOpen::Tooling::TraverseLoopBuilder::SetEndEdge

(

bool

endEdge

)

Sets a Traverse loop by using start edge/end edge or not.

Created in NX7.5.0.

License requirements : None

Parameters

endEdge

endedge

void NXOpen::Tooling::TraverseLoopBuilder::SetExitLoop

(

bool

isExitLoop

)

Sets the option to exit the current loop.

Created in NX7.5.0.

License requirements : None

Parameters

isExitLoop

isexitloop

void NXOpen::Tooling::TraverseLoopBuilder::SetTolSetting

(

double

tolSetting

)

Sets the chaining tolerance.

Created in NX7.5.0.

License requirements : None

Parameters

tolSetting

tolsetting

void NXOpen::Tooling::TraverseLoopBuilder::SetTraverseStartEndPoint	(	NXOpen::NXObject *	candidate,
		const NXOpen::Point3d &	pointCloseCursor,
		const std::vector< NXOpen::NXObject * > &	selections
	)

Set start and end points for traversal.

Created in NX7.5.0.

License requirements : None

Parameters

candidate	First selected object.
pointCloseCursor	End point of selected object used to start traverse.
selections	All selected objects to traverse.

void NXOpen::Tooling::TraverseLoopBuilder::SwitchToPartinglineLayer

(

)

Make parting layer as the work layer.

Created in NX7.5.0.

License requirements : None

double NXOpen::Tooling::TraverseLoopBuilder::TolSetting

(

)

Returns the chaining tolerance.

Created in NX7.5.0.

License requirements : None

---

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

• Tooling_TraverseLoopBuilder.hxx