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

Builder class for clock part object
To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateClockPartBuilder
Default values. More...

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

Public Member Functions

void DragByTransform (const NXOpen::Vector3d &translation, const NXOpen::Matrix3x3 &rotation)
 Drag the selected objects by the given translation and rotation. More...
 
void InitializeFromPort (NXOpen::Routing::Port *port)
 Initializes (or resets) the builder based off of the input line segment. More...
 
NXOpen::SelectNXObjectPortSelection ()
 Returns the user selected NXOpen::Routing::Port for rotation of compoent
Created in NX7.5.0. More...
 
NXOpen::ExpressionRotationAngle ()
 Returns the rotation angle applied to the component for rotation
Created in NX7.5.0. More...
 
void SetLockEngagement (bool lockEngagement)
 Set EngagementLock of builder attribute
Created in NX7.5.3. More...
 
void SetLockRotation (bool lockRotation)
 Set RotationLock of builder attribute
Created in NX7.5.3. More...
 
void StartDrag ()
 Begin a drag operation. More...
 
void StopDrag ()
 End a drag operation. More...
 
void SuppressPortConstraint (NXOpen::Routing::Port *portTag, bool suppress)
 Suppress the constraind applied to the selected NXOpen::Routing::Port
Created in NX7.5.0. More...
 
void UpdateRotationAngle (double angle)
 Suppress the constraind applied to the selected NXOpen::Routing::Port
Created in NX7.5.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

Builder class for clock part object
To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateClockPartBuilder
Default values.

Property Value

RotationAngle.Value

0


Created in NX7.5.0.

Member Function Documentation

void NXOpen::Routing::ClockPartBuilder::DragByTransform ( const NXOpen::Vector3d translation,
const NXOpen::Matrix3x3 rotation 
)

Drag the selected objects by the given translation and rotation.

Only call after invoking the Routing::ClockPartBuilder::StartDrag method. After finished dragging, call Routing::ClockPartBuilder::StopDrag .
Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

Parameters
translationThe translation to be applied.
rotationThe rotation to be applied
void NXOpen::Routing::ClockPartBuilder::InitializeFromPort ( NXOpen::Routing::Port port)

Initializes (or resets) the builder based off of the input line segment.


Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

Parameters
portport object, may be NULL
NXOpen::SelectNXObject* NXOpen::Routing::ClockPartBuilder::PortSelection ( )

Returns the user selected NXOpen::Routing::Port for rotation of compoent
Created in NX7.5.0.



License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::Routing::ClockPartBuilder::RotationAngle ( )

Returns the rotation angle applied to the component for rotation
Created in NX7.5.0.



License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::ClockPartBuilder::SetLockEngagement ( bool  lockEngagement)

Set EngagementLock of builder attribute
Created in NX7.5.3.



License requirements : routing_base ("Routing Basic")

Parameters
lockEngagementLock Engagement
void NXOpen::Routing::ClockPartBuilder::SetLockRotation ( bool  lockRotation)

Set RotationLock of builder attribute
Created in NX7.5.3.



License requirements : routing_base ("Routing Basic")

Parameters
lockRotationLock Rotation
void NXOpen::Routing::ClockPartBuilder::StartDrag ( )

Begin a drag operation.


Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::ClockPartBuilder::StopDrag ( )

End a drag operation.


Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::ClockPartBuilder::SuppressPortConstraint ( NXOpen::Routing::Port portTag,
bool  suppress 
)

Suppress the constraind applied to the selected NXOpen::Routing::Port
Created in NX7.5.0.



License requirements : routing_base ("Routing Basic")

Parameters
portTagRouting Port whose constraint is to be suppressed
suppresstrue to suppress , false to unsuppress
void NXOpen::Routing::ClockPartBuilder::UpdateRotationAngle ( double  angle)

Suppress the constraind applied to the selected NXOpen::Routing::Port
Created in NX7.5.0.



License requirements : routing_base ("Routing Basic")

Parameters
angletrue to suppress , false to unsuppress

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