Represents a NXOpen::Routing::SplinePathBuilder object. More...

Inheritance diagram for NXOpen::Routing::SplinePathBuilder:

Public Types
enum	DefiningPointMethod { DefiningPointMethodCreatePoint, DefiningPointMethodUseExisting }
	Specifies if a new point should be created when adding a point to the spline. More...

enum	DefiningTypes { DefiningTypesUnsupported, DefiningTypesInterpolation, DefiningTypesParametric, DefiningTypesBezier, DefiningTypesBezierSlack, DefiningTypesBezierMaxCurvature }
	Specifies how the spline points define the shape of the spline. More...

enum	DragMode { DragModeActive, DragModeInactive }
	Specifies if drag network is active when updating the position of a defining point. More...

enum	SplinePathAttributeOptions { SplinePathAttributeOptionsRadius, SplinePathAttributeOptionsRatioToDiameter }
	Describes user attribute methods options. More...

enum	SplinePathRadiusSource { SplinePathRadiusSourceExpression, SplinePathRadiusSourceRatioToDiameter, SplinePathRadiusSourceAttribute }
	Describes the method for the constrained curvature spline to be defined as. More...

enum	SplinePathSlackType { SplinePathSlackTypePercentLength, SplinePathSlackTypeAdditionalLength, SplinePathSlackTypeLockLength, SplinePathSlackTypeUndefined }
	Describes the type of slack to be applied to the spline. More...

Public Member Functions
void	AddDefiningPointAtAbsoluteCoords (const NXOpen::Point3d &point)
	Adds a point to the spline. More...

int	AddDefiningPointToSpline (NXOpen::Point *point, bool createNewPoint)
	Adds a defining point to the current spline or creates the first point of the new spline. More...

void	AddSlackToSpline (NXOpen::Routing::SplinePathBuilder::SplinePathSlackType slackType, NXOpen::Expression slackValue, NXOpen::Direction slackDirection)
	Created in NX6.0.0. More...

void	AskDefiningData (std::vector< NXOpen::Point * > &points)
	When a spline is selected for editing, the builder will analyze the spline and gather all of the defining data. More...

void	AssignExtension (int pointIndex, NXOpen::Direction direction, NXOpen::Expression forwardLength, NXOpen::Expression *backwardLength)
	Assigns an extension to the point at pointIndex. More...

void	AssignExtension (int pointIndex, NXOpen::Direction direction, NXOpen::Expression forwardLength, NXOpen::Expression *backwardLength, bool forceDeleteOnZeroExpression)
	Assigns an extension to the point at pointIndex. More...

void	AssignHealPathExtension (int pointIndex, NXOpen::Direction direction, NXOpen::Expression forwardLength, NXOpen::Expression *backwardLength)
	Assigns an extension to the point at pointIndex for Heal Path. More...

void	AssignTangentExtensionForPointAtIndex (int index, NXOpen::Expression forwardLength, NXOpen::Expression backwardLength, NXOpen::Vector3d tangent, NXOpen::Vector3d normal, NXOpen::Direction **extensionDir)
	Assigns the extension direction and expressions tangent to the spline path at the given point index. More...

NXOpen::Routing::Stock *	BlankStockAndGetLargestDia ()
	Blanks all the stocks on the current segment and returns the stock with the largest diameter. More...

bool	BoundedCurvature ()
	Returns whether the spline maximum bounded radius value should be used. More...

NXOpen::Expression *	BoundedCurvatureRadius ()
	Returns the minimum radius allowed for this spline. More...

NXOpen::Expression *	BoundedCurvatureRatio ()
	Returns the minimum radius allowed for this spline as a ratio to diameter. More...

void	CommitDrag (NXOpen::Point *definingPoint)
	Clears the current drag network. More...

NXOpen::Routing::AssignTangencyBuilder *	CreateAssignTangencyBuilder ()
	Creates a NXOpen::Routing::AssignTangencyBuilder object. More...

NXOpen::Routing::SplinePathBuilder::DefiningTypes	DefiningType ()
	Returns the type which specifies the shape of the spline. More...

void	DeleteDefiningPointAtIndex (int index)
	Deletes a defining point from the spline. More...

void	DetachPoint (int index)
	Detaches the point at the selected index from all objects its attached to using a Touch constraint. More...

NXOpen::Routing::AssignTangencyBuilder *	GetAssignTangencyBuilder ()
	Get a NXOpen::Routing::AssignTangencyBuilder object. More...

void	GetDefiningPointPositions (std::vector< double > &pointPositions)
	Gets the positions of the defining points as an array of doubles. More...

void	GetDefiningPointPositionsAsPoints (std::vector< NXOpen::Point3d > &pointPositions)
	Gets the positions of the defining points as an array of Point3d coordinates. More...

void	GetExtensionDataForPointAtIndex (int index, NXOpen::Expression forwardLength, NXOpen::Expression backwardLength, NXOpen::Vector3d *extDirection)
	Get the extension expressions at the given index. More...

NXOpen::Routing::Stock *	GetLargestDiameterStock ()
	Returns the stock with the largest on the current segment. More...

double	GetLockedSplineMinimumLength ()
	Returns the minimum length of the spline. More...

void	GetOffsetData (int index, int method, NXOpen::Point basePoint, NXOpen::Direction offDir, NXString exp)
	Returns the Stock Offset data associated with a given point. More...

NXOpen::Curve *	GetRouteSegment ()
	Gets the routing segment managed by the builder, if it exists. More...

double	GetSplineLength ()
	Gets the current length of the spline. More...

double	GetSplineLengthNoShaping ()
	Gets the current length of the spline without shaping applied. More...

NXOpen::Routing::ControlPoint *	GetStartAndEndRcp (NXOpen::Routing::ControlPoint **startRcp)
	Gets the RCPs managed by the builder, if they exist. More...

void	InitializeDrag (int index)
	Initialize the D-Cubed dragging functionality for the point at index. More...

void	IsLengthLocked (NXOpen::Expression *length, bool isLocked, NXOpen::Direction **slackDirection)
	Is the spline length locked? Created in NX6.0.0. More...

void	IsSplineSlacked (bool slacked, NXOpen::Routing::SplinePathBuilder::SplinePathSlackType slackType, NXOpen::Expression slackValue, NXOpen::Direction downDir)
	Created in NX6.0.0. More...

void	LockSplineLengthNoShaping (NXOpen::Expression *length)
	Locks the length of the current spline. More...

void	LockSplineLengthWithShaping (NXOpen::Expression length, NXOpen::Direction slackDirection)
	Locks the length of the current spline. More...

NXOpen::Expression *	MinimumCheckingAllowableRatio ()
	Returns the minimum ratio allowed for this spline Created in NX9.0.1. More...

NXOpen::Expression *	MinimumCheckingAllowableValue ()
	Returns the minimum radius allowed for this spline. More...

NXOpen::Routing::SplinePathBuilder::SplinePathAttributeOptions	MinimumCheckingMethod ()
	Returns the minimum checking method for this spline. More...

NXOpen::Routing::SplinePathBuilder::SplinePathRadiusSource	RadiusSource ()
	Returns the driving expression, value, or attribute of the bounded radius. More...

void	RemoveAllShaping ()
	Removes all shaping applied to the spline (Lock length, slacking). More...

void	SetAddPointsOnSubdivideFlag (bool addPoints)
	Sets whether or not additional points will be added to a spline which is created as the result of a subdivide. More...

void	SetBoundedCurvature (bool useBoundedCurvature)
	Sets whether the spline maximum bounded radius value should be used. More...

void	SetCreateTangencyFlag (bool createTangency)
	Sets whether or not additional the newly created spline will be made tangent to connecting splines. More...

void	SetDefaultPortExtensionLength (double value)
	Sets the default port extension length to be used when creating or editing points at port locations that do not already have an extension . More...

void	SetDefiningType (NXOpen::Routing::SplinePathBuilder::DefiningTypes definingType)
	Sets the type which specifies the shape of the spline. More...

void	SetLockToSelectedFlag (bool lockSelected)
	Sets whether the spline will attempt to lock points to selected object. More...

void	SetMinimumCheckingMethod (NXOpen::Routing::SplinePathBuilder::SplinePathAttributeOptions routeCheckingMethod)
	Sets the minimum checking method for this spline. More...

void	SetRadiusSource (NXOpen::Routing::SplinePathBuilder::SplinePathRadiusSource source)
	Sets the driving expression, value, or attribute of the bounded radius. More...

void	SetShowSplineMinimumRadius (bool allowDisplay)
	Sets whether the spline minimum radius value should be displayed or not. More...

void	SetSplineMethod (NXOpen::Positioning::Constraint::SplineType splineMethod)
	Sets the defining method of the spline. More...

void	SetStockBoundedDiameter (double value)
	Sets the driving diameter of the current stock for the ratio-to-diameter bounded curvature. More...

void	SetUseMinimumCheckingValue (bool useMinRadius)
	Sets whether the spline minimum radius value should be checked or not on this spline. More...

bool	ShowSplineMinimumRadius ()
	Returns whether the spline minimum radius value should be displayed or not. More...

void	UnblankStocks ()
	Unblanks stocks which were blanked by calling BlankStockAndGetLargestDia More...

void	UpdateDefiningPoint (int index, NXOpen::Point *point, bool inDrag, const NXOpen::Vector3d &translation)
	Updates the position of a point on the spline. More...

void	UpdateDefiningPointPositionAtIndex (int index, NXOpen::Point *point, bool inDrag)
	Updates the position of a point on the spline. More...

void	UpdateExtensionDirectionAtIndex (int index, const NXOpen::Vector3d &direction)
	Update the extension orientation at the point index. More...

void	UpdateExtensionDirectionForPointAtIndex (int index, const NXOpen::Vector3d &deltaTrans, const NXOpen::Matrix3x3 &orientation, bool inDrag)
	Update the extension orientation at the point index. More...

bool	UseMinimumCheckingValue ()
	Returns whether the spline minimum radius value should be checked or not on this spline. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a NXOpen::Routing::SplinePathBuilder object.

The builder allows for creating and editing D-Cubed constrained splines, adding extensions, adding stock offset points, adding stock, locking length, adding slack, and locking to other D-Cubed constrained objects.
To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateSplinePathBuilder

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Routing::SplinePathBuilder::DefiningPointMethod

Specifies if a new point should be created when adding a point to the spline.

Enumerator
DefiningPointMethodCreatePoint	create point
DefiningPointMethodUseExisting	use existing

enum NXOpen::Routing::SplinePathBuilder::DefiningTypes

Specifies how the spline points define the shape of the spline.

Enumerator
DefiningTypesUnsupported	The defining type is unsupported.
DefiningTypesInterpolation	The defining type represents a C1-continuous, interpolation spline.
DefiningTypesParametric	The defining type represents a G1-continuous, parametric curve.
DefiningTypesBezier	The defining type represents a G1-continuous, piecewise cubic Bezier.
DefiningTypesBezierSlack	The defining type represents a G1-continuous, piecewise cubic Bezier with pseudo gravity slack.
DefiningTypesBezierMaxCurvature	The defining type represents a G1-continuous, piecewise cubic Bezier with bounded maximum curvature.

enum NXOpen::Routing::SplinePathBuilder::DragMode

Specifies if drag network is active when updating the position of a defining point.

Enumerator
DragModeActive	The drag network is active.
DragModeInactive	The drag network is inactive.

enum NXOpen::Routing::SplinePathBuilder::SplinePathAttributeOptions

Describes user attribute methods options.

These value are used to set minimum checking method. If checking method is ratio to diameter than allowable radius will be computed by ratioToDiameter x Stock Diameter.

Enumerator
SplinePathAttributeOptionsRadius	A radius method option for spline user attribute.
SplinePathAttributeOptionsRatioToDiameter	A ratio to diameter method option for spline user attribute.

enum NXOpen::Routing::SplinePathBuilder::SplinePathRadiusSource

Describes the method for the constrained curvature spline to be defined as.

Enumerator
SplinePathRadiusSourceExpression	Specify radius by value.
SplinePathRadiusSourceRatioToDiameter	Specify radius by ratio to stock.
SplinePathRadiusSourceAttribute	Specify radius by attribute.

enum NXOpen::Routing::SplinePathBuilder::SplinePathSlackType

Describes the type of slack to be applied to the spline.

Enumerator
SplinePathSlackTypePercentLength	The length of the spline is increased by a percentage of the spline length.
SplinePathSlackTypeAdditionalLength	The length of the spline is increased by an additional length.
SplinePathSlackTypeLockLength	The length of the spline is slacking to a specified and locked length.
SplinePathSlackTypeUndefined	Slack length is undefined.

Member Function Documentation

void NXOpen::Routing::SplinePathBuilder::AddDefiningPointAtAbsoluteCoords ( const NXOpen::Point3d & point )

Adds a point to the spline.

The point will be the new endpoint of the spline.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

point The Point to add.

int NXOpen::Routing::SplinePathBuilder::AddDefiningPointToSpline	(	NXOpen::Point *	point,
		bool	createNewPoint
	)

Adds a defining point to the current spline or creates the first point of the new spline.

Returns: Returns the index the point was added along the spline. For example, if 3 points exist on the spline and the new point was added between points 0 and 1 this variable would be set to 1.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

point	Point to add.
createNewPoint	Should the builder create a new point based on the one provided?

void NXOpen::Routing::SplinePathBuilder::AddSlackToSpline	(	NXOpen::Routing::SplinePathBuilder::SplinePathSlackType	slackType,
		NXOpen::Expression *	slackValue,
		NXOpen::Direction *	slackDirection
	)

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

slackType	The type of slack to add.
slackValue	The amount of slack to add.
slackDirection	The direction to apply slack.

void NXOpen::Routing::SplinePathBuilder::AskDefiningData ( std::vector< NXOpen::Point * > & points )

When a spline is selected for editing, the builder will analyze the spline and gather all of the defining data.

The dialog will use this function to retrieve the defining data from the builder to populate its fields.
Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

points Defining points of the spline.

void NXOpen::Routing::SplinePathBuilder::AssignExtension	(	int	pointIndex,
		NXOpen::Direction *	direction,
		NXOpen::Expression *	forwardLength,
		NXOpen::Expression *	backwardLength
	)

Assigns an extension to the point at pointIndex.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

pointIndex	Index of the point to assing extension.
direction	Direction of the extension.
forwardLength	Forward Length of the extension.
backwardLength	Backward Length of the extension.

void NXOpen::Routing::SplinePathBuilder::AssignExtension	(	int	pointIndex,
		NXOpen::Direction *	direction,
		NXOpen::Expression *	forwardLength,
		NXOpen::Expression *	backwardLength,
		bool	forceDeleteOnZeroExpression
	)

Assigns an extension to the point at pointIndex.

Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

pointIndex	Index of the point to assign extension.
direction	Direction of extension.
forwardLength	Forward length of extension.
backwardLength	Backward length of extension.
forceDeleteOnZeroExpression	forcedeleteonzeroexpression

void NXOpen::Routing::SplinePathBuilder::AssignHealPathExtension	(	int	pointIndex,
		NXOpen::Direction *	direction,
		NXOpen::Expression *	forwardLength,
		NXOpen::Expression *	backwardLength
	)

Assigns an extension to the point at pointIndex for Heal Path.

Created in NX6.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

pointIndex	Index of the point to assing extension.
direction	Direction of the extension.
forwardLength	Length of the forward extension.
backwardLength	Length of the backward extension.

void NXOpen::Routing::SplinePathBuilder::AssignTangentExtensionForPointAtIndex	(	int	index,
		NXOpen::Expression *	forwardLength,
		NXOpen::Expression *	backwardLength,
		NXOpen::Vector3d *	tangent,
		NXOpen::Vector3d *	normal,
		NXOpen::Direction **	extensionDir
	)

Assigns the extension direction and expressions tangent to the spline path at the given point index.

Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

index	Index of the point to use.
forwardLength	Length of the forward extension.
backwardLength	Length of the backward extension.
tangent	Extension direction.
normal	Curve normal.
extensionDir	Direction object.

NXOpen::Routing::Stock* NXOpen::Routing::SplinePathBuilder::BlankStockAndGetLargestDia ( )

Blanks all the stocks on the current segment and returns the stock with the largest diameter.

Returns: The stock with the largest diameter.

Deprecated:: Deprecated in NX12.0.0. Use Routing::SplinePathBuilder::GetLargestDiameterStock instead.

Created in NX7.5.1.

License requirements : routing_base ("Routing Basic")

bool NXOpen::Routing::SplinePathBuilder::BoundedCurvature ( )

Returns whether the spline maximum bounded radius value should be used.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced")

NXOpen::Expression* NXOpen::Routing::SplinePathBuilder::BoundedCurvatureRadius ( )

Returns the minimum radius allowed for this spline.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced")

NXOpen::Expression* NXOpen::Routing::SplinePathBuilder::BoundedCurvatureRatio ( )

Returns the minimum radius allowed for this spline as a ratio to diameter.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced")

void NXOpen::Routing::SplinePathBuilder::CommitDrag ( NXOpen::Point * definingPoint )

Clears the current drag network.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

definingPoint Optional UI point defining the position of the spline point.

NXOpen::Routing::AssignTangencyBuilder* NXOpen::Routing::SplinePathBuilder::CreateAssignTangencyBuilder ( )

Creates a NXOpen::Routing::AssignTangencyBuilder object.

Returns: Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::SplinePathBuilder::DefiningTypes NXOpen::Routing::SplinePathBuilder::DefiningType ( )

Returns the type which specifies the shape of the spline.

See NXOpen::Routing::SplinePathBuilder::DefiningTypes for valid options
Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::SplinePathBuilder::DeleteDefiningPointAtIndex ( int index )

Deletes a defining point from the spline.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

index Index of the point to delete.

void NXOpen::Routing::SplinePathBuilder::DetachPoint ( int index )

Detaches the point at the selected index from all objects its attached to using a Touch constraint.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

index Index of point to detach.

NXOpen::Routing::AssignTangencyBuilder* NXOpen::Routing::SplinePathBuilder::GetAssignTangencyBuilder ( )

Get a NXOpen::Routing::AssignTangencyBuilder object.

Returns: Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::SplinePathBuilder::GetDefiningPointPositions ( std::vector< double > & pointPositions )

Gets the positions of the defining points as an array of doubles.

Each point's XYZ coordinates are represented by three doubles. X1, Y1, Z1, X2, Y2, Z2, X3, Y3, Z3, ...

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

pointPositions array of doubles representing the defining points.

void NXOpen::Routing::SplinePathBuilder::GetDefiningPointPositionsAsPoints ( std::vector< NXOpen::Point3d > & pointPositions )

Gets the positions of the defining points as an array of Point3d coordinates.

Created in NX11.0.2.

License requirements : routing_base ("Routing Basic")

Parameters

pointPositions array of points representing the defining points.

void NXOpen::Routing::SplinePathBuilder::GetExtensionDataForPointAtIndex	(	int	index,
		NXOpen::Expression **	forwardLength,
		NXOpen::Expression **	backwardLength,
		NXOpen::Vector3d *	extDirection
	)

Get the extension expressions at the given index.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

index	Index of the defining point to query.
forwardLength	Forward extension length.
backwardLength	Backward extension length.
extDirection	Extension direction.

NXOpen::Routing::Stock* NXOpen::Routing::SplinePathBuilder::GetLargestDiameterStock ( )

Returns the stock with the largest on the current segment.

Returns: The stock with the largest diameter.
Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

double NXOpen::Routing::SplinePathBuilder::GetLockedSplineMinimumLength ( )

Returns the minimum length of the spline.

The minimum length is the straight line distance between all defining points, including extensions.

Returns: The minimum length of the spline.
Created in NX7.5.4.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::SplinePathBuilder::GetOffsetData	(	int	index,
		int *	method,
		NXOpen::Point **	basePoint,
		NXOpen::Direction **	offDir,
		NXString *	exp
	)

Returns the Stock Offset data associated with a given point.

Output can be NULL if the associated point is not a stock offset point.
Created in NX6.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

index	Index of point to detach.
method	The type of offset object. 0 = Not Offset, 1 = Stock Offset Point, 2 = Stock Offset Surface.
basePoint	The base point frim the offset object.
offDir	The offset direction.
exp	The expression defining the offset distance.

NXOpen::Curve* NXOpen::Routing::SplinePathBuilder::GetRouteSegment ( )

Gets the routing segment managed by the builder, if it exists.

Returns: Visible Routing BCurve Segment.
Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

double NXOpen::Routing::SplinePathBuilder::GetSplineLength ( )

Gets the current length of the spline.

Returns: The length of the current spline.
Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

double NXOpen::Routing::SplinePathBuilder::GetSplineLengthNoShaping ( )

Gets the current length of the spline without shaping applied.

Returns: The length of the current spline without shaping.
Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::ControlPoint* NXOpen::Routing::SplinePathBuilder::GetStartAndEndRcp ( NXOpen::Routing::ControlPoint ** startRcp )

Gets the RCPs managed by the builder, if they exist.

Returns: The target ControlPoint.
Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

startRcp The source ControlPoint.

void NXOpen::Routing::SplinePathBuilder::InitializeDrag ( int index )

Initialize the D-Cubed dragging functionality for the point at index.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

index Index of the point to drag.

void NXOpen::Routing::SplinePathBuilder::IsLengthLocked	(	NXOpen::Expression **	length,
		bool *	isLocked,
		NXOpen::Direction **	slackDirection
	)

Is the spline length locked?
Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

length	The locked length of the spline.
isLocked	Is the spline length locked?
slackDirection	The direction to apply slack.

void NXOpen::Routing::SplinePathBuilder::IsSplineSlacked	(	bool *	slacked,
		NXOpen::Routing::SplinePathBuilder::SplinePathSlackType *	slackType,
		NXOpen::Expression **	slackValue,
		NXOpen::Direction **	downDir
	)

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

slacked	Is slack applied to the spline?
slackType	The type of slack.
slackValue	The added amount of slack.
downDir	The slack direction.

void NXOpen::Routing::SplinePathBuilder::LockSplineLengthNoShaping ( NXOpen::Expression * length )

Locks the length of the current spline.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

length The length to lock the spline.

void NXOpen::Routing::SplinePathBuilder::LockSplineLengthWithShaping	(	NXOpen::Expression *	length,
		NXOpen::Direction *	slackDirection
	)

Locks the length of the current spline.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

length	The length to lock the spline.
slackDirection	The direction to apply slack.

NXOpen::Expression* NXOpen::Routing::SplinePathBuilder::MinimumCheckingAllowableRatio ( )

Returns the minimum ratio allowed for this spline
Created in NX9.0.1.

License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::Routing::SplinePathBuilder::MinimumCheckingAllowableValue ( )

Returns the minimum radius allowed for this spline.

Created in NX9.0.1.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::SplinePathBuilder::SplinePathAttributeOptions NXOpen::Routing::SplinePathBuilder::MinimumCheckingMethod ( )

Returns the minimum checking method for this spline.

See NXOpen::Routing::SplinePathBuilder::SplinePathAttributeOptions for valid options
Created in NX9.0.1.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::SplinePathBuilder::SplinePathRadiusSource NXOpen::Routing::SplinePathBuilder::RadiusSource ( )

Returns the driving expression, value, or attribute of the bounded radius.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced")

void NXOpen::Routing::SplinePathBuilder::RemoveAllShaping ( )

Removes all shaping applied to the spline (Lock length, slacking).

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::SplinePathBuilder::SetAddPointsOnSubdivideFlag ( bool addPoints )

Sets whether or not additional points will be added to a spline which is created as the result of a subdivide.

If true, new points will be added to maintain a shape similar to the original curve.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

addPoints True to add points to subdivided splines.

void NXOpen::Routing::SplinePathBuilder::SetBoundedCurvature ( bool useBoundedCurvature )

Sets whether the spline maximum bounded radius value should be used.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced")

Parameters

useBoundedCurvature useboundedcurvature

void NXOpen::Routing::SplinePathBuilder::SetCreateTangencyFlag ( bool createTangency )

Sets whether or not additional the newly created spline will be made tangent to connecting splines.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

createTangency True to add tangency.

void NXOpen::Routing::SplinePathBuilder::SetDefaultPortExtensionLength ( double value )

Sets the default port extension length to be used when creating or editing points at port locations that do not already have an extension .

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced")

Parameters

value value

void NXOpen::Routing::SplinePathBuilder::SetDefiningType ( NXOpen::Routing::SplinePathBuilder::DefiningTypes definingType )

Sets the type which specifies the shape of the spline.

See NXOpen::Routing::SplinePathBuilder::DefiningTypes for valid options
Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

definingType definingtype

void NXOpen::Routing::SplinePathBuilder::SetLockToSelectedFlag ( bool lockSelected )

Sets whether the spline will attempt to lock points to selected object.

This flag is only checked when adding a point to a spline by passing in a smart point to derive a new dumb spline point from. If the smart point is derived from a Port, ControlPoint, or other Routing Object, the new spline defining point will lock to that object. This flag is also checked during commit, where endpoint associativity is applied.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

lockSelected True to lock to selected objects.

void NXOpen::Routing::SplinePathBuilder::SetMinimumCheckingMethod ( NXOpen::Routing::SplinePathBuilder::SplinePathAttributeOptions routeCheckingMethod )

Sets the minimum checking method for this spline.

See NXOpen::Routing::SplinePathBuilder::SplinePathAttributeOptions for valid options
Created in NX9.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

routeCheckingMethod routecheckingmethod

void NXOpen::Routing::SplinePathBuilder::SetRadiusSource ( NXOpen::Routing::SplinePathBuilder::SplinePathRadiusSource source )

Sets the driving expression, value, or attribute of the bounded radius.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced")

Parameters

source The type of bounded curvature.

void NXOpen::Routing::SplinePathBuilder::SetShowSplineMinimumRadius ( bool allowDisplay )

Sets whether the spline minimum radius value should be displayed or not.

Created in NX9.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

allowDisplay allowdisplay

void NXOpen::Routing::SplinePathBuilder::SetSplineMethod ( NXOpen::Positioning::Constraint::SplineType splineMethod )

Sets the defining method of the spline.

Deprecated:: Deprecated in NX11.0.2. Use Routing::SplinePathBuilder::DefiningTypes instead.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

splineMethod the defining method of the spline.

void NXOpen::Routing::SplinePathBuilder::SetStockBoundedDiameter ( double value )

Sets the driving diameter of the current stock for the ratio-to-diameter bounded curvature.

Created in NX12.0.0.

License requirements : routing_advanced ("Routing Advanced")

Parameters

value value

void NXOpen::Routing::SplinePathBuilder::SetUseMinimumCheckingValue ( bool useMinRadius )

Sets whether the spline minimum radius value should be checked or not on this spline.

Created in NX9.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

useMinRadius useminradius

bool NXOpen::Routing::SplinePathBuilder::ShowSplineMinimumRadius ( )

Returns whether the spline minimum radius value should be displayed or not.

Created in NX9.0.1.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::SplinePathBuilder::UnblankStocks ( )

Unblanks stocks which were blanked by calling BlankStockAndGetLargestDia

Deprecated:: Deprecated in NX12.0.0.

There is no need for this method.

Created in NX7.5.1.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::SplinePathBuilder::UpdateDefiningPoint	(	int	index,
		NXOpen::Point *	point,
		bool	inDrag,
		const NXOpen::Vector3d &	translation
	)

Updates the position of a point on the spline.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

index	The index of the point to update position..
point	The point representing the new position.
inDrag	Is the point currently being dragged?
translation	Translation to redefine the point.

void NXOpen::Routing::SplinePathBuilder::UpdateDefiningPointPositionAtIndex	(	int	index,
		NXOpen::Point *	point,
		bool	inDrag
	)

Updates the position of a point on the spline.

Created in NX6.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

index	The index of the point to update position..
point	The point representing the new position.
inDrag	Is the point currently being dragged?

void NXOpen::Routing::SplinePathBuilder::UpdateExtensionDirectionAtIndex	(	int	index,
		const NXOpen::Vector3d &	direction
	)

Update the extension orientation at the point index.

Created in NX12.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

index	Index of the point to analyze.
direction	Direction to assign the extension.

void NXOpen::Routing::SplinePathBuilder::UpdateExtensionDirectionForPointAtIndex	(	int	index,
		const NXOpen::Vector3d &	deltaTrans,
		const NXOpen::Matrix3x3 &	orientation,
		bool	inDrag
	)

Update the extension orientation at the point index.

Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters

index	Index of the point to analyze.
deltaTrans	Translation to transform.
orientation	Delta rotation transform.
inDrag	the geometry is currently being dragged?

bool NXOpen::Routing::SplinePathBuilder::UseMinimumCheckingValue ( )

Returns whether the spline minimum radius value should be checked or not on this spline.

Created in NX9.0.1.

License requirements : routing_base ("Routing Basic")

The documentation for this class was generated from the following file:

Routing_SplinePathBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation