nxopen.routing

Interface EditLineSegmentBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface EditLineSegmentBuilder
extends Builder

Builder for the "Edit Line Segment" operation. Sets (and locks or unlocks) the length of LineSegment objects. Also moves geometry attached to the line segment to ensure that the attached geometry has the correct shape after an edit.
To create a new instance of this class, use RouteManager.createEditLineSegmentBuilder(nxopen.routing.LineSegment)

Created in NX6.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EditLineSegmentBuilder.OrientationData This class holds the data returned from getOrientation()

Method Summary

Modifier and Type	Method and Description
void	addLineToSetOfAllEditedSegments() Adds the current line segment to the set of all line segments that have been edited by the user.
boolean	convertEccentricSegment() Returns the conversion flag.
void	detachActiveRcp() Detaches the line segment, stored in builder, at its active end RCP.
void	dragLineLength() Updates the line length based on the expression stored in this builder.
Point3d	getActiveRcpPositon() Determines the active RCP for the line selected by the user.
EditLineSegmentBuilder.OrientationData	getOrientation() Determines the orientation information for the line selected by the user.
void	initializeFromLine(LineSegment line) Initializes (or resets) the builder based off of the input line segment.
Expression	length() Returns the length expression.
SelectLineSegment	lineSelection() Returns the line selection.
boolean	lockLength() Returns the lock length flag.
void	modifiedLineLength() Updates the line length based on the expression stored in this builder.
void	restartDrag() Restart a line drag operation.
boolean	reverseDirection() Returns the reverse direction flag.
void	setConvertEccentricSegment(boolean convertEccentricSegment) Sets the conversion flag.
void	setLockLength(boolean lockLength) Sets the lock length flag.
void	setReverseDirection(boolean reverse) Sets the reverse direction flag.
void	stopDrag() Stop the drag operation if it has begun.

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

lineSelection

SelectLineSegment lineSelection()
                         throws NXException,
                                RemoteException

Returns the line selection. Stores the line segment selected by the user.
License requirements: routing_base ("Routing Basic")

Created in NX6.0.0

Throws:

NXException

RemoteException

length

Expression length()
           throws NXException,
                  RemoteException

Returns the length expression. This data from this expression is copied to (or from) the distance constraint applied to the ends of the line segment.
License requirements: routing_base ("Routing Basic")

Created in NX6.0.0

Throws:

NXException

RemoteException

reverseDirection

boolean reverseDirection()
                  throws NXException,
                         RemoteException

Returns the reverse direction flag. Flips the direction that the extends towards (or shrinks along). This flips the origin of the line as well as the direction.
License requirements: routing_base ("Routing Basic")

Created in NX6.0.0

Throws:

NXException

RemoteException

setReverseDirection

void setReverseDirection(boolean reverse)
                  throws NXException,
                         RemoteException

Sets the reverse direction flag. Flips the direction that the extends towards (or shrinks along). This flips the origin of the line as well as the direction.
License requirements: routing_base ("Routing Basic")

Created in NX6.0.0

Parameters:

reverse -

Throws:

NXException

RemoteException

lockLength

boolean lockLength()
            throws NXException,
                   RemoteException

Returns the lock length flag. Forces the commit method to lock the length to the specified value if set to true. Otherwise the length of the line segment is unconstrained after the commit method is invoked.
License requirements: routing_base ("Routing Basic")

Created in NX6.0.0

Throws:

NXException

RemoteException

setLockLength

void setLockLength(boolean lockLength)
            throws NXException,
                   RemoteException

Sets the lock length flag. Forces the commit method to lock the length to the specified value if set to true. Otherwise the length of the line segment is unconstrained after the commit method is invoked.
License requirements: routing_base ("Routing Basic")

Created in NX6.0.0

Parameters:

lockLength -

Throws:

NXException

RemoteException

getOrientation

EditLineSegmentBuilder.OrientationData getOrientation()
                                               throws NXException,
                                                      RemoteException

Determines the orientation information for the line selected by the user. Returns false if there is no line currently stored in the builder.
License requirements: routing_base ("Routing Basic")

Created in NX6.0.0

Returns:

a OrientationData object

Throws:

NXException

RemoteException

initializeFromLine

void initializeFromLine(LineSegment line)
                 throws NXException,
                        RemoteException

Initializes (or resets) the builder based off of the input line segment.
License requirements: routing_base ("Routing Basic")

Created in NX6.0.0

Parameters:

line - Line object, may be null

Throws:

NXException

RemoteException

dragLineLength

void dragLineLength()
             throws NXException,
                    RemoteException

Updates the line length based on the expression stored in this builder. The line is not fully updated only partially updated (i.e. solid bodies build on the line do not update). This method assumes the difference between the new length value and the previous length value is very small (e.g. a drag operation).
License requirements: routing_base ("Routing Basic")

Created in NX6.0.0

Throws:

NXException

RemoteException

modifiedLineLength

void modifiedLineLength()
                 throws NXException,
                        RemoteException

Updates the line length based on the expression stored in this builder. The line is not fully updated only partially updated (i.e. solid bodies build on the line do not update). This method doesn't assume anything about the new value. This method updates the line incrementally from the original length to the new length as this usually results in better looking geometry.
License requirements: routing_base ("Routing Basic")

Created in NX6.0.0

Throws:

NXException

RemoteException

stopDrag

void stopDrag()
       throws NXException,
              RemoteException

Stop the drag operation if it has begun. This will commit the drag and update the assembly. This will not remove the segment from the builder and dragging can be restarted by calling restartDrag() .
License requirements: routing_base ("Routing Basic")

Created in NX7.5.1

Throws:

NXException

RemoteException

restartDrag

void restartDrag()
          throws NXException,
                 RemoteException

Restart a line drag operation. This routine should only be called if stopDrag() . was previously called to stop a line drag operation.
License requirements: routing_base ("Routing Basic")

Created in NX7.5.1

Throws:

NXException

RemoteException

convertEccentricSegment

boolean convertEccentricSegment()
                         throws NXException,
                                RemoteException

Returns the conversion flag. Forces the commit method to convert line segment to eccentric line segment if set to true. Otherwise convert it to vice versa
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Throws:

NXException

RemoteException

setConvertEccentricSegment

void setConvertEccentricSegment(boolean convertEccentricSegment)
                         throws NXException,
                                RemoteException

Sets the conversion flag. Forces the commit method to convert line segment to eccentric line segment if set to true. Otherwise convert it to vice versa
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Parameters:

convertEccentricSegment -

Throws:

NXException

RemoteException

getActiveRcpPositon

Point3d getActiveRcpPositon()
                     throws NXException,
                            RemoteException

Determines the active RCP for the line selected by the user. This is end RCP other than the start point of line segment. This RCP could be dragged along the segment.
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Returns:

End point other than the start point of line segment.

Throws:

NXException

RemoteException

detachActiveRcp

void detachActiveRcp()
              throws NXException,
                     RemoteException

Detaches the line segment, stored in builder, at its active end RCP. By reversing the direction of line segment, user could make other end RCP as active RCP.
License requirements: routing_base ("Routing Basic")

Created in NX8.0.0

Throws:

NXException

RemoteException

addLineToSetOfAllEditedSegments

void addLineToSetOfAllEditedSegments()
                              throws NXException,
                                     RemoteException

Adds the current line segment to the set of all line segments that have been edited by the user.
License requirements: routing_base ("Routing Basic")

Created in NX9.0.2

Throws:

NXException

RemoteException