NX Open C++ Reference Guide
Public Member Functions | List of all members
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:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

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

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 NXOpen::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
pTolSelObjectTotal selected objects.
selectionsLast selected objects.
deselectionsLast deselected objects.
cpointCursor point position when selecting one edge first time.
selectEndEdgeWhether 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
selectionsLast selected objects.
nearPointEnd 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
pPartingLinesparting 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
bridgeGapbridgegap
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
byColorbycolor
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
endEdgeendedge
void NXOpen::Tooling::TraverseLoopBuilder::SetExitLoop ( bool  isExitLoop)

Sets the option to exit the current loop.


Created in NX7.5.0.

License requirements : None

Parameters
isExitLoopisexitloop
void NXOpen::Tooling::TraverseLoopBuilder::SetTolSetting ( double  tolSetting)

Sets the chaining tolerance.


Created in NX7.5.0.

License requirements : None

Parameters
tolSettingtolsetting
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
candidateFirst selected object.
pointCloseCursorEnd point of selected object used to start traverse.
selectionsAll 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:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.