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

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

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

Public Member Functions

bool AllowCutElbow ()
 Returns a flag indicating whether or not to allow cut elbow placement
Created in NX8.0.0. More...
 
bool AssignDefaultCorner ()
 Returns the preference to assign the current default corner to new segments. More...
 
bool AssignDefaultElbow ()
 Returns the preference to find and assign a default elbow to new segments. More...
 
bool LockAngle ()
 Returns the preference to determine if the angle between segments should be constrained. More...
 
bool LockLength ()
 Returns the preference to determine if the length of new segments should be constrained. More...
 
bool LockToSelectedObject ()
 Returns the preference to determine if the new segments and control points should be constrained to the objects selected by the user. More...
 
void SetAllowCutElbow (bool assign)
 Sets a flag indicating whether or not to allow cut elbow placement
Created in NX8.0.0. More...
 
void SetAssignDefaultCorner (bool assign)
 Sets the preference to assign the current default corner to new segments. More...
 
void SetAssignDefaultElbow (bool assign)
 Sets the preference to find and assign a default elbow to new segments. More...
 
void SetLockAngle (bool lock)
 Sets the preference to determine if the angle between segments should be constrained. More...
 
void SetLockLength (bool lock)
 Sets the preference to determine if the length of new segments should be constrained. More...
 
void SetLockToSelectedObject (bool lock)
 Sets the preference to determine if the new segments and control points should be constrained to the objects selected by the user. 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 Routing::LinearPathBuilder builder.

Determines various settings to be applied when the path is created.
To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateLinearPathSettings
Default values.

Property Value

LockToSelectedObject

True


Created in NX5.0.0.

Member Function Documentation

bool NXOpen::Routing::LinearPathSettings::AllowCutElbow ( )

Returns a flag indicating whether or not to allow cut elbow placement
Created in NX8.0.0.



License requirements : routing_pipetube ("Routing Piping and Tubing")

bool NXOpen::Routing::LinearPathSettings::AssignDefaultCorner ( )

Returns the preference to assign the current default corner to new segments.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

bool NXOpen::Routing::LinearPathSettings::AssignDefaultElbow ( )

Returns the preference to find and assign a default elbow to new segments.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

bool NXOpen::Routing::LinearPathSettings::LockAngle ( )

Returns the preference to determine if the angle between segments should be constrained.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

bool NXOpen::Routing::LinearPathSettings::LockLength ( )

Returns the preference to determine if the length of new segments should be constrained.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

bool NXOpen::Routing::LinearPathSettings::LockToSelectedObject ( )

Returns the preference to determine if the new segments and control points should be constrained to the objects selected by the user.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::LinearPathSettings::SetAllowCutElbow ( bool  assign)

Sets a flag indicating whether or not to allow cut elbow placement
Created in NX8.0.0.



License requirements : routing_pipetube ("Routing Piping and Tubing")

Parameters
assignassign
void NXOpen::Routing::LinearPathSettings::SetAssignDefaultCorner ( bool  assign)

Sets the preference to assign the current default corner to new segments.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
assignassign
void NXOpen::Routing::LinearPathSettings::SetAssignDefaultElbow ( bool  assign)

Sets the preference to find and assign a default elbow to new segments.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
assignassign
void NXOpen::Routing::LinearPathSettings::SetLockAngle ( bool  lock)

Sets the preference to determine if the angle between segments should be constrained.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
locklock
void NXOpen::Routing::LinearPathSettings::SetLockLength ( bool  lock)

Sets the preference to determine if the length of new segments should be constrained.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
locklock
void NXOpen::Routing::LinearPathSettings::SetLockToSelectedObject ( bool  lock)

Sets the preference to determine if the new segments and control points should be constrained to the objects selected by the user.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
locklock

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