NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::MechanicalRouting::MovePathBuilder Class Reference

Represents NXOpen::MechanicalRouting::MovePathBuilder . More...

Inheritance diagram for NXOpen::MechanicalRouting::MovePathBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  DetachTypes { DetachTypesAlwaysMaintainConnections, DetachTypesAllowDetachOnConflict, DetachTypesDetachSelectedObjects }
 Specifies the options that will allow the user to enforce the transformation by detaching the routing objects (if necessary) from objects that stop the selected object from moving. More...
 

Public Member Functions

NXOpen::MechanicalRouting::MovePathBuilder::DetachTypes DetachType ()
 Returns the detach type setting. More...
 
void DragObjects ()
 Perform a drag operation. More...
 
bool MaintainLength ()
 Returns the maintain length setting. More...
 
NXOpen::GeometricUtilities::ModlMotionMotion ()
 Returns the transformation to apply to the selected routing objects. More...
 
NXOpen::Routing::RouteObjectCollectorPathSelection ()
 Returns the objects that make up the path that needs to be transformed. More...
 
bool Preview ()
 Returns the preview setting
Created in NX11.0.0. More...
 
void ResetDrag ()
 Reset a drag operation
Created in NX11.0.0. More...
 
void SetDetachType (NXOpen::MechanicalRouting::MovePathBuilder::DetachTypes detachType)
 Sets the detach type setting. More...
 
void SetMaintainLength (bool maintainLength)
 Sets the maintain length setting. More...
 
void SetPreview (bool preview)
 Sets the preview setting
Created in NX11.0.0. More...
 
void StartDrag ()
 Begin a drag operation. More...
 
void StopDrag ()
 End a drag operation
Created in NX11.0.0. 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

Represents NXOpen::MechanicalRouting::MovePathBuilder .

Allows the user to perform transform of routing objects. If run from a non-interactive session it will return NULL.
To create a new instance of this class, use NXOpen::MechanicalRouting::BuilderFactory::CreateMovePathBuilder
Default values.

Property Value

Motion.DeltaEnum

ReferenceWcsWorkPart

Motion.DeltaXc.Value

0.0

Motion.DeltaYc.Value

0.0

Motion.DeltaZc.Value

0.0


Created in NX11.0.0.

Member Enumeration Documentation

Specifies the options that will allow the user to enforce the transformation by detaching the routing objects (if necessary) from objects that stop the selected object from moving.

Enumerator
DetachTypesAlwaysMaintainConnections 

always maintain connections

DetachTypesAllowDetachOnConflict 

allow detach on conflict

DetachTypesDetachSelectedObjects 

detach selected objects

Member Function Documentation

NXOpen::MechanicalRouting::MovePathBuilder::DetachTypes NXOpen::MechanicalRouting::MovePathBuilder::DetachType ( )

Returns the detach type setting.

Allows the user to specify acceptable detach types for objects that prevent the transformation of the selected objects.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::MechanicalRouting::MovePathBuilder::DragObjects ( )

Perform a drag operation.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

bool NXOpen::MechanicalRouting::MovePathBuilder::MaintainLength ( )

Returns the maintain length setting.

This keeps the length of the selected segments constant through the transform operation. The adjacent segments will be modified and reconnected to the end of the moving segments as required. If this option is turned off, the segments that are moved may extend or trim back to connect to adjacent segments.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::GeometricUtilities::ModlMotion* NXOpen::MechanicalRouting::MovePathBuilder::Motion ( )

Returns the transformation to apply to the selected routing objects.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::RouteObjectCollector* NXOpen::MechanicalRouting::MovePathBuilder::PathSelection ( )

Returns the objects that make up the path that needs to be transformed.

The objects can be segments, routing control points and routing components that have properties that make them suitable to be moved by the routing application.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

bool NXOpen::MechanicalRouting::MovePathBuilder::Preview ( )

Returns the preview setting
Created in NX11.0.0.



License requirements : routing_base ("Routing Basic")

void NXOpen::MechanicalRouting::MovePathBuilder::ResetDrag ( )

Reset a drag operation
Created in NX11.0.0.



License requirements : routing_base ("Routing Basic")

void NXOpen::MechanicalRouting::MovePathBuilder::SetDetachType ( NXOpen::MechanicalRouting::MovePathBuilder::DetachTypes  detachType)

Sets the detach type setting.

Allows the user to specify acceptable detach types for objects that prevent the transformation of the selected objects.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
detachTypedetachtype
void NXOpen::MechanicalRouting::MovePathBuilder::SetMaintainLength ( bool  maintainLength)

Sets the maintain length setting.

This keeps the length of the selected segments constant through the transform operation. The adjacent segments will be modified and reconnected to the end of the moving segments as required. If this option is turned off, the segments that are moved may extend or trim back to connect to adjacent segments.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
maintainLengthmaintainlength
void NXOpen::MechanicalRouting::MovePathBuilder::SetPreview ( bool  preview)

Sets the preview setting
Created in NX11.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
previewpreview
void NXOpen::MechanicalRouting::MovePathBuilder::StartDrag ( )

Begin a drag operation.


Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::MechanicalRouting::MovePathBuilder::StopDrag ( )

End a drag operation
Created in NX11.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.