public interface SplinePathBuilder extends Builder
RouteManager.createSplinePathBuilder(nxopen.Curve)
Modifier and Type | Interface and Description |
---|---|
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 These value are used to set minimum checking method.
|
static class |
SplinePathBuilder.SplinePathSlackType
Describes the method the spline is defined as.
|
static class |
SplinePathBuilder.StartAndEndRcpData
This class holds the data returned from
getStartAndEndRcp() |
Modifier and Type | Method and Description |
---|---|
void |
addDefiningPointAtAbsoluteCoords(Point3d point)
Adds a defining 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,
nxopen.Direction downDir)
License requirements: routing_base ("Routing Basic") . |
Point[] |
askDefiningData()
When a spline is selected for editing, the builder will anaylyze the spline
and gather all of the defining data.
|
void |
assignExtension(int pointIndex,
nxopen.Direction direction,
Expression forwardExtVal,
Expression backExtVal)
Assigns an extension to the point at pointIndex.
|
void |
assignHealPathExtension(int pointIndex,
nxopen.Direction direction,
Expression forwardExtVal,
Expression backExtVal)
Assigns an extension to the point at pointIndex for Heal Path.
|
Stock |
blankStockAndGetLargestDia()
Blanks all the stocks on the current segment and returns the stock with the largest diameter
License requirements: routing_base ("Routing Basic") . |
void |
commitDrag(Point definingPoint)
Clears the current drag network
License requirements: routing_base ("Routing Basic") . |
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.
|
double[] |
getDefiningPointPositions()
Gets the positions of the defining points.
|
SplinePathBuilder.ExtensionDataForPointAtIndexData |
getExtensionDataForPointAtIndex(int index)
Get the extension expressions at the given index.
|
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()
License requirements: routing_base ("Routing Basic") . |
SplinePathBuilder.IsSplineSlackedData |
isSplineSlacked()
License requirements: routing_base ("Routing Basic") . |
void |
lockSplineLengthNoShaping(Expression length)
Locks the length of the current spline.
|
void |
lockSplineLengthWithShaping(Expression length,
nxopen.Direction downDirection)
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.
|
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 |
setCreateTangencyFlag(boolean createTangency)
Sets whether or not additional the newly created spline will be made tangent to connecting splines.
|
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 |
setShowSplineMinimumRadius(boolean allowDisplay)
License requirements: routing_base ("Routing Basic") . |
void |
setSplineMethod(Constraint.SplineType sMethod)
Sets the splines method to points or poles.
|
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()
Unblanks stocks which were blanked by calling BlankStockAndGetLargestDia
License requirements: routing_base ("Routing Basic") . |
void |
updateDefiningPointPositionAtIndex(int index,
Point point,
boolean inDrag)
Updates the position of a point on the spline.
|
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
- Point to add.NXException
RemoteException
void updateDefiningPointPositionAtIndex(int index, Point point, boolean inDrag) throws NXException, RemoteException
index
- The index in the list of defining spline points to move.point
- Point representing the new position.inDrag
- True if the point is currently being dragged.NXException
RemoteException
void deleteDefiningPointAtIndex(int index) throws NXException, RemoteException
index
- Index of the point to delete.NXException
RemoteException
void setSplineMethod(Constraint.SplineType sMethod) throws NXException, RemoteException
sMethod
- Set 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, nxopen.Direction downDirection) throws NXException, RemoteException
length
- The length to lock the spline to.downDirection
- NXException
RemoteException
void lockSplineLengthNoShaping(Expression length) throws NXException, RemoteException
length
- Expression containing the desired length.NXException
RemoteException
void removeAllShaping() throws NXException, RemoteException
NXException
RemoteException
SplinePathBuilder.IsLengthLockedData isLengthLocked() throws NXException, RemoteException
NXException
RemoteException
void addSlackToSpline(SplinePathBuilder.SplinePathSlackType slackType, Expression slackValue, nxopen.Direction downDir) throws NXException, RemoteException
slackType
- slackValue
- downDir
- NXException
RemoteException
SplinePathBuilder.IsSplineSlackedData isSplineSlacked() throws NXException, RemoteException
NXException
RemoteException
void initializeDrag(int index) throws NXException, RemoteException
index
- Index of the point to dragNXException
RemoteException
void commitDrag(Point definingPoint) throws NXException, RemoteException
definingPoint
- Optional of UI point defining the position of the spline point.NXException
RemoteException
void assignExtension(int pointIndex, nxopen.Direction direction, Expression forwardExtVal, Expression backExtVal) throws NXException, RemoteException
pointIndex
- Index of the point to assing extensions to.direction
- Direction of the extension.forwardExtVal
- Length of the forward extension.backExtVal
- Length of the backward extension.NXException
RemoteException
void assignHealPathExtension(int pointIndex, nxopen.Direction direction, Expression forwardExtVal, Expression backExtVal) throws NXException, RemoteException
pointIndex
- Index of the point to assing extensions to.direction
- Direction of the extension.forwardExtVal
- Length of the forward extension.backExtVal
- 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 hte point to anaylzeNXException
RemoteException
double[] getDefiningPointPositions() 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 blankStockAndGetLargestDia() throws NXException, RemoteException
NXException
RemoteException
void unblankStocks() throws NXException, RemoteException
NXException
RemoteException
double getLockedSplineMinimumLength() throws NXException, RemoteException
NXException
RemoteException
void setUseMinimumCheckingValue(boolean useMinRadius) throws NXException, RemoteException
useMinRadius
- NXException
RemoteException
boolean useMinimumCheckingValue() throws NXException, RemoteException
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
void setShowSplineMinimumRadius(boolean allowDisplay) throws NXException, RemoteException
allowDisplay
- NXException
RemoteException
boolean showSplineMinimumRadius() throws NXException, RemoteException
NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.