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

Builder for creating routing linear paths. More...

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

List of all members.

Public Member Functions

NXOpen::Routing::ControlPointAddPreviewControlPoint (const NXOpen::Point3d &location)
 Add a new control point to the path.
NXOpen::Routing::ElbowSnapSettingsElbowSnapSettings ()
 Returns the elbow snapping settings for determining location of control points as the user drags their mouse.
NXOpen::Routing::ControlPointGetLastControlPoint ()
 Returns the last control point in the path.
NXOpen::Routing::ISegmentGetParentSegmentOfEccentricSegment ()
 Parent segment.
NXOpen::Routing::LinearPathSettingsLinearPathSettings ()
 Returns the settings that determine what constraints to apply to the new path.
NXOpen::Routing::PathStockBuilderPathStockBuilder ()
 Returns the builder for assigning stock to the new path.
void RemoveLastNonPreviewControlPoint ()
 Removes the last fully-defined control point in the path.
void SetControlPointDefiningObject (NXOpen::Routing::ControlPoint *previewRcp, const NXOpen::Point3d &position, NXOpen::NXObject *object)
 Fully defines a preview control point.
void SetControlPointDefiningPoint (NXOpen::Routing::ControlPoint *previewRcp, NXOpen::Point *point)
 Fully defines a preview control point using the given point.
void SetElbowSnapSettings (NXOpen::Routing::ElbowSnapSettings *snapSettings)
 Sets the elbow snapping settings for determining location of control points as the user drags their mouse.
void SetIsEccentricModeSelected (bool isEccentricModeSelected)
 Set the boolean value specifies that Eccentric mode selected or not
Created in NX8.0.0.
void SetIsNewControlPointRequired (bool isNewControlPointRequired)
 Set the boolean value specifies that new control point required or not
Created in NX8.0.0.
void SetLinearPathSettings (NXOpen::Routing::LinearPathSettings *settingsBuilder)
 Sets the settings that determine what constraints to apply to the new path.
void SetParentSegmentOfEccentricSegment (NXOpen::Routing::ISegment *parentSegment)
 
Created in NX8.0.0.
void SetPathStockBuilder (NXOpen::Routing::PathStockBuilder *stockBuilder)
 Sets the builder for assigning stock to the new path.
void SettingChanged ()
 Notifies the builder that some routing preferences have changed, and that the builder (and it's associated builders) must update their values to refelect those changes.

Detailed Description

Builder for creating routing linear paths.

These paths can include constrained line segments, bend corners and elbows. This fuctionality can only be used with the Assemblies Positioning functionality. The work part must have been converted to use Assemblies Positioning using the Convert Mating Conditions tool.

To create a control point (and it's associated segment) first create a preview control point, then define the control point using either a smart point (Routing::LinearPathBuilder::SetControlPointDefiningPoint ), or some other object (Routing::LinearPathBuilder::SetControlPointDefiningObject ).


To create a new instance of this class, use Routing::RouteManager::CreateLinearPathBuilder
Default values.

Property Value

ElbowSnapSettings.AngleTolerance

5.0

ElbowSnapSettings.SnapToElbowAngles

True

LinearPathSettings.LockToSelectedObject

True


Created in NX5.0.0.


Member Function Documentation

Add a new control point to the path.

This control point is considered to be a preview control point to show what the path will look like interactively. This control point will be deleted when the commit method is invoked unless the rcp has been fully defined.

Returns:
Preview control point, will be NULL if there is already a control point at the given location.
Created in NX5.0.0.

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

Returns the elbow snapping settings for determining location of control points as the user drags their mouse.

Only useful in the UI.
Created in NX5.0.0.

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

Returns the last control point in the path.

Returns:

Created in NX6.0.0.

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

Parent segment.

Returns:

Created in NX8.0.0.

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

Returns the settings that determine what constraints to apply to the new path.


Created in NX5.0.0.

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

Returns the builder for assigning stock to the new path.


Created in NX5.0.0.

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

Removes the last fully-defined control point in the path.

Also removes any preview control points.
Created in NX5.0.0.

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

Fully defines a preview control point.

The preview control point's location is set to the given position, and the control point is constrained to the given object (depending on the linear path settings).

A control point may only be defined once.
Created in NX5.0.0.

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

Parameters:
previewRcpMust be a control point created by Routing::LinearPathBuilder::AddPreviewControlPoint
positionposition
objectNULL allowed.

Fully defines a preview control point using the given point.

The control point is not made associative directly to the input point. The control point is made associative (depending on the linear path settings) to the objects that the input point is associative to.

A control point may only be defined once.
Created in NX5.0.0.

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

Parameters:
previewRcpMust be a control point created by Routing::LinearPathBuilder::AddPreviewControlPoint
pointNULL not allowed.

Sets the elbow snapping settings for determining location of control points as the user drags their mouse.

Only useful in the UI.
Created in NX5.0.0.

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

Parameters:
snapSettingssnap settings

Set the boolean value specifies that Eccentric mode selected or not
Created in NX8.0.0.



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

Parameters:
isEccentricModeSelectediseccentricmodeselected
void NXOpen::Routing::LinearPathBuilder::SetIsNewControlPointRequired ( bool  isNewControlPointRequired)

Set the boolean value specifies that new control point required or not
Created in NX8.0.0.



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

Parameters:
isNewControlPointRequiredisnewcontrolpointrequired

Sets the settings that determine what constraints to apply to the new path.


Created in NX5.0.0.

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

Parameters:
settingsBuildersettings builder


Created in NX8.0.0.



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

Parameters:
parentSegmentparentsegment

Sets the builder for assigning stock to the new path.


Created in NX5.0.0.

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

Parameters:
stockBuilderstock builder

Notifies the builder that some routing preferences have changed, and that the builder (and it's associated builders) must update their values to refelect those changes.


Created in NX5.0.0.

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


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