public interface SplinePathBuilder extends Builder
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.
RouteManager.createSplinePathBuilder(nxopen.Curve)
Modifier and Type | Interface and Description |
---|---|
static class |
SplinePathBuilder.AssignTangentExtensionForPointAtIndexData
This class holds the data returned from
assignTangentExtensionForPointAtIndex(int, nxopen.Expression, nxopen.Expression) |
static class |
SplinePathBuilder.DefiningPointMethod
Specifies if a new point should be created when adding a point to the spline.
|
static class |
SplinePathBuilder.DefiningTypes
Specifies how the spline points define the shape of the spline.
|
static class |
SplinePathBuilder.DragMode
Specifies if drag network is active when updating the position of a defining point.
|
static class |
SplinePathBuilder.ExtensionDataForPointAtIndexData
This class holds the data returned from
getExtensionDataForPointAtIndex(int) |
static class |
SplinePathBuilder.IsLengthLockedData
This class holds the data returned from
isLengthLocked() |
static class |
SplinePathBuilder.IsSplineSlackedData
This class holds the data returned from
isSplineSlacked() |
static class |
SplinePathBuilder.OffsetData
This class holds the data returned from
getOffsetData(int) |
static class |
SplinePathBuilder.SplinePathAttributeOptions
Describes user attribute methods options.
|
static class |
SplinePathBuilder.SplinePathRadiusSource
Describes the method for the constrained curvature spline to be defined as.
|
static class |
SplinePathBuilder.SplinePathSlackType
Describes the type of slack to be applied to the spline.
|
static class |
SplinePathBuilder.StartAndEndRcpData
This class holds the data returned from
getStartAndEndRcp() |
Modifier and Type | Method and Description |
---|---|
void |
addDefiningPointAtAbsoluteCoords(Point3d point)
Adds a point to the spline.
|
int |
addDefiningPointToSpline(Point point,
boolean createNewPoint)
Adds a defining point to the current spline or creates the first point of the new
spline.
|
void |
addSlackToSpline(SplinePathBuilder.SplinePathSlackType slackType,
Expression slackValue,
Direction slackDirection)
License requirements: routing_base ("Routing Basic") . |
Point[] |
askDefiningData()
When a spline is selected for editing, the builder will analyze the spline
and gather all of the defining data.
|
void |
assignExtension(int pointIndex,
Direction direction,
Expression forwardLength,
Expression backwardLength)
Assigns an extension to the point at pointIndex.
|
void |
assignExtension(int pointIndex,
Direction direction,
Expression forwardLength,
Expression backwardLength,
boolean forceDeleteOnZeroExpression)
Assigns an extension to the point at pointIndex.
|
void |
assignHealPathExtension(int pointIndex,
Direction direction,
Expression forwardLength,
Expression backwardLength)
Assigns an extension to the point at pointIndex for Heal Path.
|
SplinePathBuilder.AssignTangentExtensionForPointAtIndexData |
assignTangentExtensionForPointAtIndex(int index,
Expression forwardLength,
Expression backwardLength)
Assigns the extension direction and expressions tangent to the spline path at the given
point index.
|
Stock |
blankStockAndGetLargestDia()
Deprecated.
Deprecated in NX12.0.0. Use
getLargestDiameterStock() instead.
|
boolean |
boundedCurvature()
Returns whether the spline maximum bounded radius value should be used.
|
Expression |
boundedCurvatureRadius()
Returns the minimum radius allowed for this spline.
|
Expression |
boundedCurvatureRatio()
Returns the minimum radius allowed for this spline as a ratio to diameter.
|
void |
commitDrag(Point definingPoint)
Clears the current drag network.
|
AssignTangencyBuilder |
createAssignTangencyBuilder()
Creates a
AssignTangencyBuilder object. |
SplinePathBuilder.DefiningTypes |
definingType()
Returns the type which specifies the shape of the spline.
|
void |
deleteDefiningPointAtIndex(int index)
Deletes a defining point from the spline.
|
void |
detachPoint(int index)
Detaches the point at the selected index from all objects its attached to using a Touch
constraint.
|
AssignTangencyBuilder |
getAssignTangencyBuilder()
Get a
AssignTangencyBuilder object. |
double[] |
getDefiningPointPositions()
Gets the positions of the defining points as an array of doubles.
|
Point3d[] |
getDefiningPointPositionsAsPoints()
Gets the positions of the defining points as an array of Point3d coordinates.
|
SplinePathBuilder.ExtensionDataForPointAtIndexData |
getExtensionDataForPointAtIndex(int index)
Get the extension expressions at the given index.
|
Stock |
getLargestDiameterStock()
Returns the stock with the largest on the current segment.
|
double |
getLockedSplineMinimumLength()
Returns the minimum length of the spline.
|
SplinePathBuilder.OffsetData |
getOffsetData(int index)
Returns the Stock Offset data associated with a given point.
|
Curve |
getRouteSegment()
Gets the routing segment managed by the builder, if it exists.
|
double |
getSplineLength()
Gets the current length of the spline.
|
double |
getSplineLengthNoShaping()
Gets the current length of the spline without shaping applied.
|
SplinePathBuilder.StartAndEndRcpData |
getStartAndEndRcp()
Gets the RCPs managed by the builder, if they exist.
|
void |
initializeDrag(int index)
Initialize the D-Cubed dragging functionality for the point at index.
|
SplinePathBuilder.IsLengthLockedData |
isLengthLocked()
Is the spline length locked?
|
SplinePathBuilder.IsSplineSlackedData |
isSplineSlacked()
License requirements: routing_base ("Routing Basic") . |
void |
lockSplineLengthNoShaping(Expression length)
Locks the length of the current spline.
|
void |
lockSplineLengthWithShaping(Expression length,
Direction slackDirection)
Locks the length of the current spline.
|
Expression |
minimumCheckingAllowableRatio()
Returns the minimum ratio allowed for this spline
License requirements: routing_base ("Routing Basic") . |
Expression |
minimumCheckingAllowableValue()
Returns the minimum radius allowed for this spline.
|
SplinePathBuilder.SplinePathAttributeOptions |
minimumCheckingMethod()
Returns the minimum checking method for this spline.
|
SplinePathBuilder.SplinePathRadiusSource |
radiusSource()
Returns the driving expression, value, or attribute of the bounded radius.
|
void |
removeAllShaping()
Removes all shaping applied to the spline (Lock length, slacking).
|
void |
setAddPointsOnSubdivideFlag(boolean addPoints)
Sets whether or not additional points will be added to a spline which is created as the
result of a subdivide.
|
void |
setBoundedCurvature(boolean useBoundedCurvature)
License requirements: routing_advanced ("Routing Advanced") . |
void |
setCreateTangencyFlag(boolean createTangency)
Sets whether or not additional the newly created spline will be made tangent to
connecting splines.
|
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 .
|
void |
setDefiningType(SplinePathBuilder.DefiningTypes definingType)
License requirements: routing_base ("Routing Basic") . |
void |
setLockToSelectedFlag(boolean lockSelected)
Sets whether the spline will attempt to lock points to selected object.
|
void |
setMinimumCheckingMethod(SplinePathBuilder.SplinePathAttributeOptions routeCheckingMethod)
License requirements: routing_base ("Routing Basic") . |
void |
setRadiusSource(SplinePathBuilder.SplinePathRadiusSource source)
License requirements: routing_advanced ("Routing Advanced") . |
void |
setShowSplineMinimumRadius(boolean allowDisplay)
License requirements: routing_base ("Routing Basic") . |
void |
setSplineMethod(Constraint.SplineType splineMethod)
Deprecated.
Deprecated in NX11.0.2. Use
SplinePathBuilder.DefiningTypes instead.
|
void |
setStockBoundedDiameter(double value)
Sets the driving diameter of the current stock for the ratio-to-diameter bounded curvature.
|
void |
setUseMinimumCheckingValue(boolean useMinRadius)
License requirements: routing_base ("Routing Basic") . |
boolean |
showSplineMinimumRadius()
Returns whether the spline minimum radius value should be displayed or not.
|
void |
unblankStocks()
Deprecated.
Deprecated in NX12.0.0. There is no need for this method.
|
void |
updateDefiningPoint(int index,
Point point,
boolean inDrag,
Vector3d translation)
Updates the position of a point on the spline.
|
void |
updateDefiningPointPositionAtIndex(int index,
Point point,
boolean inDrag)
Updates the position of a point on the spline.
|
void |
updateExtensionDirectionAtIndex(int index,
Vector3d direction)
Update the extension orientation at the point index.
|
void |
updateExtensionDirectionForPointAtIndex(int index,
Vector3d deltaTrans,
Matrix3x3 orientation,
boolean inDrag)
Update the extension orientation at the point index.
|
boolean |
useMinimumCheckingValue()
Returns whether the spline minimum radius value should be checked or not on this spline.
|
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
int addDefiningPointToSpline(Point point, boolean createNewPoint) throws NXException, RemoteException
point
- Point to add.createNewPoint
- Should the builder create a new point based on the one provided?NXException
RemoteException
void addDefiningPointAtAbsoluteCoords(Point3d point) throws NXException, RemoteException
point
- The Point to add.NXException
RemoteException
void updateDefiningPointPositionAtIndex(int index, Point point, boolean inDrag) throws NXException, RemoteException
index
- The index of the point to update position..point
- The point representing the new position.inDrag
- Is the point currently being dragged?NXException
RemoteException
void updateDefiningPoint(int index, Point point, boolean inDrag, Vector3d translation) throws NXException, RemoteException
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.NXException
RemoteException
void deleteDefiningPointAtIndex(int index) throws NXException, RemoteException
index
- Index of the point to delete.NXException
RemoteException
void setSplineMethod(Constraint.SplineType splineMethod) throws NXException, RemoteException
SplinePathBuilder.DefiningTypes
instead.
splineMethod
- the defining method of the spline.
NXException
RemoteException
void setLockToSelectedFlag(boolean lockSelected) throws NXException, RemoteException
lockSelected
- True to lock to selected objects.NXException
RemoteException
void setAddPointsOnSubdivideFlag(boolean addPoints) throws NXException, RemoteException
addPoints
- True to add points to subdivided splines.NXException
RemoteException
void setCreateTangencyFlag(boolean createTangency) throws NXException, RemoteException
createTangency
- True to add tangency.NXException
RemoteException
double getSplineLength() throws NXException, RemoteException
NXException
RemoteException
double getSplineLengthNoShaping() throws NXException, RemoteException
NXException
RemoteException
void lockSplineLengthWithShaping(Expression length, Direction slackDirection) throws NXException, RemoteException
length
- The length to lock the spline.slackDirection
- The direction to apply slack.NXException
RemoteException
void lockSplineLengthNoShaping(Expression length) throws NXException, RemoteException
length
- The length to lock the spline.NXException
RemoteException
void removeAllShaping() throws NXException, RemoteException
NXException
RemoteException
SplinePathBuilder.IsLengthLockedData isLengthLocked() throws NXException, RemoteException
NXException
RemoteException
void addSlackToSpline(SplinePathBuilder.SplinePathSlackType slackType, Expression slackValue, Direction slackDirection) throws NXException, RemoteException
slackType
- The type of slack to add.slackValue
- The amount of slack to add.slackDirection
- The direction to apply slack.NXException
RemoteException
SplinePathBuilder.IsSplineSlackedData isSplineSlacked() throws NXException, RemoteException
NXException
RemoteException
void initializeDrag(int index) throws NXException, RemoteException
index
- Index of the point to drag.NXException
RemoteException
void commitDrag(Point definingPoint) throws NXException, RemoteException
definingPoint
- Optional UI point defining the position of the spline point.NXException
RemoteException
void assignExtension(int pointIndex, Direction direction, Expression forwardLength, Expression backwardLength) throws NXException, RemoteException
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.NXException
RemoteException
void assignHealPathExtension(int pointIndex, Direction direction, Expression forwardLength, Expression backwardLength) throws NXException, RemoteException
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.NXException
RemoteException
Point[] askDefiningData() throws NXException, RemoteException
NXException
RemoteException
SplinePathBuilder.ExtensionDataForPointAtIndexData getExtensionDataForPointAtIndex(int index) throws NXException, RemoteException
index
- Index of the defining point to query.NXException
RemoteException
double[] getDefiningPointPositions() throws NXException, RemoteException
NXException
RemoteException
Point3d[] getDefiningPointPositionsAsPoints() throws NXException, RemoteException
NXException
RemoteException
Curve getRouteSegment() throws NXException, RemoteException
NXException
RemoteException
SplinePathBuilder.StartAndEndRcpData getStartAndEndRcp() throws NXException, RemoteException
NXException
RemoteException
void detachPoint(int index) throws NXException, RemoteException
index
- Index of point to detach.NXException
RemoteException
SplinePathBuilder.OffsetData getOffsetData(int index) throws NXException, RemoteException
index
- Index of point to detach.NXException
RemoteException
Stock getLargestDiameterStock() throws NXException, RemoteException
NXException
RemoteException
Stock blankStockAndGetLargestDia() throws NXException, RemoteException
getLargestDiameterStock()
instead.
NXException
RemoteException
void unblankStocks() throws NXException, RemoteException
NXException
RemoteException
double getLockedSplineMinimumLength() throws NXException, RemoteException
NXException
RemoteException
boolean useMinimumCheckingValue() throws NXException, RemoteException
NXException
RemoteException
void setUseMinimumCheckingValue(boolean useMinRadius) throws NXException, RemoteException
useMinRadius
- NXException
RemoteException
SplinePathBuilder.SplinePathAttributeOptions minimumCheckingMethod() throws NXException, RemoteException
SplinePathBuilder.SplinePathAttributeOptions
for valid
options
NXException
RemoteException
void setMinimumCheckingMethod(SplinePathBuilder.SplinePathAttributeOptions routeCheckingMethod) throws NXException, RemoteException
routeCheckingMethod
- NXException
RemoteException
Expression minimumCheckingAllowableValue() throws NXException, RemoteException
NXException
RemoteException
Expression minimumCheckingAllowableRatio() throws NXException, RemoteException
NXException
RemoteException
boolean showSplineMinimumRadius() throws NXException, RemoteException
NXException
RemoteException
void setShowSplineMinimumRadius(boolean allowDisplay) throws NXException, RemoteException
allowDisplay
- NXException
RemoteException
void updateExtensionDirectionForPointAtIndex(int index, Vector3d deltaTrans, Matrix3x3 orientation, boolean inDrag) throws NXException, RemoteException
index
- Index of the point to analyze.deltaTrans
- Translation to transform.orientation
- Delta rotation transform.inDrag
- the geometry is currently being dragged?NXException
RemoteException
void updateExtensionDirectionAtIndex(int index, Vector3d direction) throws NXException, RemoteException
index
- Index of the point to analyze.direction
- Direction to assign the extension.NXException
RemoteException
SplinePathBuilder.AssignTangentExtensionForPointAtIndexData assignTangentExtensionForPointAtIndex(int index, Expression forwardLength, Expression backwardLength) throws NXException, RemoteException
index
- Index of the point to use.forwardLength
- Length of the forward extension.backwardLength
- Length of the backward extension.NXException
RemoteException
void assignExtension(int pointIndex, Direction direction, Expression forwardLength, Expression backwardLength, boolean forceDeleteOnZeroExpression) throws NXException, RemoteException
pointIndex
- Index of the point to assign extension.direction
- Direction of extension.forwardLength
- Forward length of extension.backwardLength
- Backward length of extension.forceDeleteOnZeroExpression
- NXException
RemoteException
Expression boundedCurvatureRadius() throws NXException, RemoteException
NXException
RemoteException
Expression boundedCurvatureRatio() throws NXException, RemoteException
NXException
RemoteException
boolean boundedCurvature() throws NXException, RemoteException
NXException
RemoteException
void setBoundedCurvature(boolean useBoundedCurvature) throws NXException, RemoteException
useBoundedCurvature
- NXException
RemoteException
SplinePathBuilder.DefiningTypes definingType() throws NXException, RemoteException
SplinePathBuilder.DefiningTypes
for valid options
NXException
RemoteException
void setDefiningType(SplinePathBuilder.DefiningTypes definingType) throws NXException, RemoteException
definingType
- NXException
RemoteException
AssignTangencyBuilder createAssignTangencyBuilder() throws NXException, RemoteException
AssignTangencyBuilder
object.
NXException
RemoteException
AssignTangencyBuilder getAssignTangencyBuilder() throws NXException, RemoteException
AssignTangencyBuilder
object.
NXException
RemoteException
SplinePathBuilder.SplinePathRadiusSource radiusSource() throws NXException, RemoteException
NXException
RemoteException
void setRadiusSource(SplinePathBuilder.SplinePathRadiusSource source) throws NXException, RemoteException
source
- The type of bounded curvature.NXException
RemoteException
void setStockBoundedDiameter(double value) throws NXException, RemoteException
value
- NXException
RemoteException
void setDefaultPortExtensionLength(double value) throws NXException, RemoteException
value
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.