NX Open C++ Reference Guide
Public Member Functions
NXOpen::Routing::EditLineSegmentBuilder Class Reference

Builder for the "Edit Line Segment" operation. More...

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

List of all members.

Public Member Functions

bool ConvertEccentricSegment ()
 Returns the conversion flag.
void DetachActiveRcp ()
 Detachs 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.
NXOpen::Point3d GetActiveRcpPositon ()
 Determines the active RCP for the line selected by the user.
bool GetOrientation (NXOpen::Point3d *startPoint, NXOpen::Vector3d *direction)
 Determines the orienation information for the line selected by the user.
void InitializeFromLine (NXOpen::Routing::LineSegment *line)
 Initializes (or resets) the builder based off of the input line segment.
NXOpen::ExpressionLength ()
 Returns the length expression.
NXOpen::Routing::SelectLineSegmentLineSelection ()
 Returns the line selection.
bool 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.
bool ReverseDirection ()
 Returns the reverse direction flag.
void SetConvertEccentricSegment (bool convertEccentricSegment)
 Sets the conversion flag.
void SetLockLength (bool lockLength)
 Sets the lock length flag.
void SetReverseDirection (bool reverse)
 Sets the reverse direction flag.
void StopDrag ()
 Stop the drag operation if it has begun.

Detailed Description

Builder for the "Edit Line Segment" operation.

Sets (and locks or unlocks) the length of Routing::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 Routing::RouteManager::CreateEditLineSegmentBuilder

Created in NX6.0.0.


Member Function Documentation

Returns the conversion flag.

Forces the commit method to convert line segment to eccentric line segment if set to true. Otherwise convert it to viceversa
Created in NX8.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Detachs 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.
Created in NX8.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

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).
Created in NX6.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

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 dragged along the segment.

Returns:
End point other than the start point of line segment.
Created in NX8.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Determines the orienation information for the line selected by the user.

Returns false if there is no line currently stored in the builder.

Returns:
True if there is a line associated with this builder.
Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
startPointThe start of the line.
directionThe direction of the line (unit vector).

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


Created in NX6.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Parameters:
lineLine object, may be NULL

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.
Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the line selection.

Stores the line segment selected by the user.
Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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.
Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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.
Created in NX6.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Restart a line drag operation.

This routine should only be called if Routing::EditLineSegmentBuilder::StopDrag . was previously called to stop a line drag operation.
Created in NX7.5.1.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Returns the reverse direction flag.

Flips the direction that the extends towards (or shirinks along). This flips the origin of the line as well as the direction.
Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Sets the conversion flag.

Forces the commit method to convert line segment to eccentric line segment if set to true. Otherwise convert it to viceversa
Created in NX8.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Parameters:
convertEccentricSegmentconverteccentricsegment

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.
Created in NX6.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Parameters:
lockLengthlocklength

Sets the reverse direction flag.

Flips the direction that the extends towards (or shirinks along). This flips the origin of the line as well as the direction.
Created in NX6.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Parameters:
reversereverse

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 Routing::EditLineSegmentBuilder::RestartDrag .
Created in NX7.5.1.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")


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