NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Routing::ElbowSnapSettings Class Reference

Helper object used the by NXOpen::Routing::LinearPathBuilder builder. More...

Inheritance diagram for NXOpen::Routing::ElbowSnapSettings:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

double AngleTolerance ()
 Returns the tolerance within which to search for elbow angles. More...
 
void SetAngleTolerance (double tolerance)
 Sets the tolerance within which to search for elbow angles. More...
 
void SetSnapToElbowAngles (bool doSnap)
 Sets whether or not to snap control points to the nearest valid elbow angle. More...
 
bool SnapToElbowAngles ()
 Returns whether or not to snap control points to the nearest valid elbow angle. 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

Helper object used the by NXOpen::Routing::LinearPathBuilder builder.

Determines whether or not elbow snapping should occur in the "Create Linear Path" UI, and if so, what the angle tolerance should be.
To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateElbowSnapSettings
Default values.

Property Value

AngleTolerance

5.0

SnapToElbowAngles

True


Created in NX5.0.0.

Member Function Documentation

double NXOpen::Routing::ElbowSnapSettings::AngleTolerance ( )

Returns the tolerance within which to search for elbow angles.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::ElbowSnapSettings::SetAngleTolerance ( double  tolerance)

Sets the tolerance within which to search for elbow angles.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
tolerancetolerance
void NXOpen::Routing::ElbowSnapSettings::SetSnapToElbowAngles ( bool  doSnap)

Sets whether or not to snap control points to the nearest valid elbow angle.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
doSnapdo snap
bool NXOpen::Routing::ElbowSnapSettings::SnapToElbowAngles ( )

Returns whether or not to snap control points to the nearest valid elbow angle.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")


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