EditPointBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# EditPointBuilder Class

class `NXOpen.MechanicalRouting.``EditPointBuilder`

  Bases: `NXOpen.Builder`

  Represents `NXOpen.MechanicalRouting.EditPointBuilder`.

  To create a new instance of this class, use `NXOpen.MechanicalRouting.BuilderFactory.CreateEditPointBuilder()`

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
ActiveEditSegmentType | Returns or sets the edit segment type setting Allows you to specify the type of edit in edit segment motion.
ActiveMotionType | Returns or sets the motion type setting.
BendAngle | Returns or sets the bend angle setting.
IsDetachObject | Returns or sets the detach setting.
MaintainAngle | Returns or sets the maintain angle setting.
MaintainLength | Returns or sets the maintain length setting.
PointSelection | Returns the routing objects that are being edited.
Segment | Returns or sets the segment setting.
SegmentLength | Returns or sets the segment length setting.
Tag | Returns the Tag for this object.
TransformTool | Returns the transform tool.

# 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.
DragObjects | Perform a drag operation.
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.
ResetDrag | Reset a drag operation Resets the position of routing objects in constraint network back to their initial position.
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 Applies the transforms obtained from solving the constraint network on routing objects.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

EditPointBuilderEditsegmenttype Enumeration | Specifies the options available for Edit Segment motion.
EditPointBuilderMotiontype Enumeration | Specifies the options available for motion.

# Property Detail

## ActiveEditSegmentType

`EditPointBuilder.``ActiveEditSegmentType`

  Returns or sets the edit segment type setting Allows you to specify the type of edit in edit segment motion.

  `-------------------------------------`

  Getter Method

  Signature `ActiveEditSegmentType`

  Returns: |
  Return type: | `NXOpen.MechanicalRouting.EditPointBuilderEditsegmenttype`

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

  `-------------------------------------`

  Setter Method

  Signature `ActiveEditSegmentType`

  Parameters: | editSegmentType (`NXOpen.MechanicalRouting.EditPointBuilderEditsegmenttype`) –

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

## ActiveMotionType

`EditPointBuilder.``ActiveMotionType`

  Returns or sets the motion type setting.

  Allows you to specify the type of edit point motion to be applied.

  `-------------------------------------`

  Getter Method

  Signature `ActiveMotionType`

  Returns: |
  Return type: | `NXOpen.MechanicalRouting.EditPointBuilderMotiontype`

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

  `-------------------------------------`

  Setter Method

  Signature `ActiveMotionType`

  Parameters: | motionType (`NXOpen.MechanicalRouting.EditPointBuilderMotiontype`) –

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

## BendAngle

`EditPointBuilder.``BendAngle`

  Returns or sets the bend angle setting.

  Allows you to specify new angle for a segment connected at the RCP or Port being edited. Reference for angle measurement is the other segment connected at the RCP or Port being edited.

  Is applicable only when there are two segments connected at RCP or Port being edited.

  `-------------------------------------`

  Getter Method

  Signature `BendAngle`

  Returns: |
  Return type: | float

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

  `-------------------------------------`

  Setter Method

  Signature `BendAngle`

  Parameters: | bendAngle (float) –

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

## IsDetachObject

`EditPointBuilder.``IsDetachObject`

  Returns or sets the detach setting.

  Allows you to specify if the selected object has to be detached from the segment during transformation.

  `-------------------------------------`

  Getter Method

  Signature `IsDetachObject`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

  `-------------------------------------`

  Setter Method

  Signature `IsDetachObject`

  Parameters: | isDetachObject (bool) –

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

## MaintainAngle

`EditPointBuilder.``MaintainAngle`

  Returns or sets the maintain angle setting.

  Allows you to specify if the angles between segments connected at the RCP or Port being edited must be fixed during transformation.

  `-------------------------------------`

  Getter Method

  Signature `MaintainAngle`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

  `-------------------------------------`

  Setter Method

  Signature `MaintainAngle`

  Parameters: | maintainAngle (bool) –

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

## MaintainLength

`EditPointBuilder.``MaintainLength`

  Returns or sets the maintain length setting.

  Allows you to specify if the lengths of segments connected at the RCP or Port being edited must be fixed during transformation.

  `-------------------------------------`

  Getter Method

  Signature `MaintainLength`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

  `-------------------------------------`

  Setter Method

  Signature `MaintainLength`

  Parameters: | maintainLength (bool) –

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

## PointSelection

`EditPointBuilder.``PointSelection`

  Returns the routing objects that are being edited.

  The object can be a Routing Control Point or routing port or one of their occurences.

  `-------------------------------------`

  Getter Method

  Signature `PointSelection`

  Returns: |
  Return type: | `NXOpen.Routing.RouteObjectCollector`

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

## Segment

`EditPointBuilder.``Segment`

  Returns or sets the segment setting.

  Allows you to specify a segment connected at the RCP or Port being edited.

  `-------------------------------------`

  Getter Method

  Signature `Segment`

  Returns: |
  Return type: | `NXOpen.Line`

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

  `-------------------------------------`

  Setter Method

  Signature `Segment`

  Parameters: | segment (`NXOpen.Line`) –

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

## SegmentLength

`EditPointBuilder.``SegmentLength`

  Returns or sets the segment length setting.

  Allows you to specify new length for a segment connected at the RCP or Port being edited.

  New length is applied on the segment by moving the RCP or Port being edited.

  `-------------------------------------`

  Getter Method

  Signature `SegmentLength`

  Returns: |
  Return type: | float

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

  `-------------------------------------`

  Setter Method

  Signature `SegmentLength`

  Parameters: | segmentLength (float) –

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

## TransformTool

`EditPointBuilder.``TransformTool`

  Returns the transform tool.

  Allows you to access the transform block object.

  `-------------------------------------`

  Getter Method

  Signature `TransformTool`

  Returns: |
  Return type: | `NXOpen.MechanicalRouting.TransformBlockBuilder`

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

# Method Detail

## DragObjects

`EditPointBuilder.``DragObjects`

  Perform a drag operation.

  Solves the constraint network applying the transform required to move the routing object to a new position.

  Signature `DragObjects()`

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

## ResetDrag

`EditPointBuilder.``ResetDrag`

  Reset a drag operation

  Resets the position of routing objects in constraint network back to their initial position.

  Signature `ResetDrag()`

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

## StartDrag

`EditPointBuilder.``StartDrag`

  Begin a drag operation.

  Creates a constraint network of routing objects connected to the routing object that is being edited.

  Signature `StartDrag()`

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

## StopDrag

`EditPointBuilder.``StopDrag`

  End a drag operation

  Applies the transforms obtained from solving the constraint network on routing objects.

  Signature `StopDrag()`

  New in version NX11.0.0.

  License requirements: routing_base (“Routing Basic”)

## Validate

`EditPointBuilder.``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.