ClockPartBuilder Class¶
-
class
NXOpen.Routing.
ClockPartBuilder
¶ Bases:
NXOpen.Builder
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 New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
PortSelection | Returns the user selected NXOpen.Routing.Port for rotation of compoent |
RotationAngle | Returns the rotation angle applied to the component for rotation |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
DragByTransform | Drag the selected objects by the given translation and rotation. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
InitializeFromPort | Initializes (or resets) the builder based off of the input line segment. |
SetLockEngagement | Set EngagementLock of builder attribute |
SetLockRotation | Set RotationLock of builder attribute |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
StartDrag | Begin a drag operation. |
StopDrag | End a drag operation. |
SuppressPortConstraint | Suppress the constraind applied to the selected NXOpen.Routing.Port |
UpdateRotationAngle | Suppress the constraind applied to the selected NXOpen.Routing.Port |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
PortSelection¶
-
ClockPartBuilder.
PortSelection
¶ Returns the user selected
NXOpen.Routing.Port
for rotation of compoent-------------------------------------
Getter Method
Signature
PortSelection
Returns: Return type: NXOpen.SelectNXObject
New in version NX7.5.0.
License requirements: routing_base (“Routing Basic”)
RotationAngle¶
-
ClockPartBuilder.
RotationAngle
¶ Returns the rotation angle applied to the component for rotation
-------------------------------------
Getter Method
Signature
RotationAngle
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: routing_base (“Routing Basic”)
Method Detail¶
DragByTransform¶
-
ClockPartBuilder.
DragByTransform
¶ Drag the selected objects by the given translation and rotation.
Only call after invoking the
Routing.ClockPartBuilder.StartDrag()
method. After finished dragging, callRouting.ClockPartBuilder.StopDrag()
.Signature
DragByTransform(translation, rotation)
Parameters: - translation (
NXOpen.Vector3d
) – The translation to be applied. - rotation (
NXOpen.Matrix3x3
) – The rotation to be applied
New in version NX7.5.0.
License requirements: routing_base (“Routing Basic”)
- translation (
InitializeFromPort¶
-
ClockPartBuilder.
InitializeFromPort
¶ Initializes (or resets) the builder based off of the input line segment.
Signature
InitializeFromPort(port)
Parameters: port ( NXOpen.Routing.Port
) – port object, may be NoneNew in version NX7.5.0.
License requirements: routing_base (“Routing Basic”)
SetLockEngagement¶
-
ClockPartBuilder.
SetLockEngagement
¶ Set EngagementLock of builder attribute
Signature
SetLockEngagement(lockEngagement)
Parameters: lockEngagement (bool) – Lock Engagement New in version NX7.5.3.
License requirements: routing_base (“Routing Basic”)
SetLockRotation¶
-
ClockPartBuilder.
SetLockRotation
¶ Set RotationLock of builder attribute
Signature
SetLockRotation(lockRotation)
Parameters: lockRotation (bool) – Lock Rotation New in version NX7.5.3.
License requirements: routing_base (“Routing Basic”)
StartDrag¶
-
ClockPartBuilder.
StartDrag
¶ Begin a drag operation.
Signature
StartDrag()
New in version NX7.5.0.
License requirements: routing_base (“Routing Basic”)
StopDrag¶
-
ClockPartBuilder.
StopDrag
¶ End a drag operation.
Signature
StopDrag()
New in version NX7.5.0.
License requirements: routing_base (“Routing Basic”)
SuppressPortConstraint¶
-
ClockPartBuilder.
SuppressPortConstraint
¶ Suppress the constraind applied to the selected
NXOpen.Routing.Port
Signature
SuppressPortConstraint(portTag, suppress)
Parameters: - portTag (
NXOpen.Routing.Port
) – Routing Port whose constraint is to be suppressed - suppress (bool) – true to suppress , false to unsuppress
New in version NX7.5.0.
License requirements: routing_base (“Routing Basic”)
- portTag (
UpdateRotationAngle¶
-
ClockPartBuilder.
UpdateRotationAngle
¶ Suppress the constraind applied to the selected
NXOpen.Routing.Port
Signature
UpdateRotationAngle(angle)
Parameters: angle (float) – true to suppress , false to unsuppress New in version NX7.5.0.
License requirements: routing_base (“Routing Basic”)
Validate¶
-
ClockPartBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.