pw:: SourceCurve

SourceCurve type

Derives From

Summary

pw:: SourceCurve	SourceCurve type
Static Actions
create	This action creates a new source curve object.
join	This action joins as many of the given source curves together as possible.
getBestSegment	This action, given two point-lists, returns a segment type, a start point, an end point, and a ProjectToCommon state that represent the best segment for a source curve between the given points.
Instance Actions
getSegmentCount	This action gets the number of segments in this curve.
getSegment	This action gets the segment at the given index.
getSegments	This action gets the list of segments.
setSegment	This action sets the segment at the given index.
addSegment	This action adds the segment to the end of the segments in the curve.
insertSegment	This action inserts the segment at the given index.
removeSegment	This action removes a segment from the curve.
removeAllSegments	This action removes all of the segments from the curve.
replaceAllSegments	This action replaces all of the segments in the curve.
getPosition	This action gets a position on a curve in the defining space of the curve.
getXYZ	This action gets the model space position on a curve.
getParameter	This action gets a parameter value on a curve.
getTangent	This action gets the tangency vector on the source curve at a location.
getLength	This action gets the curve length from the beginning to a given location.
getParameters	This action gets the parameters at which the curve intersects the value.
getTotalLength	This action gets the total length of the curve.
spline	This action sets this source curve to a smooth interpolation of the control points of the given source curve.
fitLSQ	This action sets this source curve to a least squares fit approximation of the control points of the given source curve.
smoothC1	This action sets this source curve to a C1 continuous approximation of the shape of the given source curve.
split	This action splits the source curve at a given parameter value.
project	This action projects this source curve onto one or more database entities.
getDefaultProjectDirection	This action gets the default projection direction for this source curve.
setOrientation	This action sets the source curve orientation.
alignOrientation	This action aligns the U orientation of the given source curves with this source curve.
isClosed	This action checks if the source curve is closed.
isPole	This action check if the source curve is a pole.
getDiscontinuities	This action returns a list of parameters at discontinuities with a bend angle greater than the given angle.
closestPoint	This action gets the closest point on this source curve to the given point or ray.
closestControlPoint	This action gets the control point on this source curve closest to the given point.
getControlPointCount	This action gets the number of control points on this source curve.
removeInteriorControlPoints	This action removes the interior control points of each segment of this source curve.

create

pw::SourceCurve create

This action creates a new source curve object.

Parameters

This action has no parameters.

Returns

This action returns a new pw::SourceCurve object.

Example

This example shows how to create a source curve with two conic segments.

Code

set conic(1) [pw::SegmentConic create]
$conic(1) addPoint {-25 8 0}
$conic(1) addPoint {-8 8 0}
$conic(1) setIntersectPoint {-20 20 0}
set conic(2) [pw::SegmentConic create]
$conic(2) addPoint [$conic(1) getPoint [$conic(1) getPointCount]]
$conic(2) addPoint {10 16 0}
$conic(2) setShoulderPoint {8 8 0}
set srcCrv(1) [pw::SourceCurve create]
$srcCrv(1) addSegment $conic(1)
$srcCrv(1) addSegment $conic(2)

join

pw::SourceCurve join ?-reject rejectVar? ?-tolerance tol? curves

This action joins as many of the given source curves together as possible.

Parameters

-reject rejectVar	This optional parameter is the string name of a variable to receive a list of pw::SourceCurve objects that were not used in joining.
-tolerance tol	This optional parameter is the join tolerance, with the default value being the current fit tolerance.
curves	This parameter is a list of pw::SourceCurve objects to join.

Returns

This action returns a list of the pw::SourceCurve objects that were joined.

Information

This command supports progress updates.

getBestSegment

pw::SourceCurve getBestSegment ?-start startVar? ?-end endVar? ?-projectToCommon projectToCommonVar? start_points end_points

This action, given two point-lists, returns a segment type, a start point, an end point, and a ProjectToCommon state that represent the best segment for a source curve between the given points.

Parameters

-start startVar	This optional parameter is the string name of a variable to receive the best start integer index or point.
-end endVar	This optional parameter is the string name of a variable to receive the best end integer index or point.
-projectToCommon projectToCommonVar	This optional parameter is the string name of a variable to receive the ProjectToCommon <bool> state for the best segment.
start_points	This parameter is a list of points for the start of the segment.
end_points	This parameter is a list of points for the end of the segment.

Returns

This action returns a segment type string.

Example

This example shows how to find the best segment between two end points.

Code

puts [pw::Curve getBestSegment -start st -end en \
    [list {0 10 0} {10 10 0}]
puts $st; puts $en

Output

pw::SegmentSpline
0
0

getSegmentCount

$srcCrv getSegmentCount

This action gets the number of segments in this curve.

Parameters

This action has no parameters.

Returns

This action returns the integer number of segments.

Example

This example shows how to get the number of segments in a curve. $srcCrv(1) is referencing an existing source curve.

Code

puts [$srcCrv(1) getSegmentCount]

Output

getSegment

$srcCrv getSegment ?-copy? index

This action gets the segment at the given index.

Parameters

-copy	This optional flag is a notification that a copy of the segment is returned.
index	This parameter is the integer index of the segment to get with the range [1, number of segments].

Returns

This action returns a pw::Segment object.

Example

This example shows how to get the number of control points for a certain segment in a curve. $srcCrv(3) is referencing an existing source curve.

Code

puts "This segment has [[$srcCrv(3) getSegment 2] getPointCount] \
    control points."

Output

This segment has 5 control points.

getSegments

$srcCrv getSegments ?-copy?

This action gets the list of segments.

Parameters

-copy

This optional flag is a notification that a copy of the segments are returned.

Returns

This action returns a pw::Segment object list.

Example

This example shows how to get the number of control points for a certain segment in a curve. $srcCrv(3) is referencing an existing source curve.

Code

puts "This segment has [[lindex [$srcCrv(3) getSegments] 1] getPointCount] \
    control points."

Output

This segment has 5 control points.

setSegment

$srcCrv setSegment index segment

This action sets the segment at the given index.

Parameters

index	This parameter is the integer index of the segment to set with the range [1, number of segments].
segment	This parameter is the pw::Segment object to set.

Returns

This action returns nothing.

Example

This example shows how to set a segment at a certain index in a curve. $srcCrv(1) is referencing an existing source curve.

Code

set seg(1) [pw::SegmentSpline create]
$seg(1) addPoint [[$srcCrv(1) getSegment 1] getPoint 1]
$seg(1) addPoint "0 0 0"
$srcCrv(1) setSegment 1 $seg(1)

addSegment

$srcCrv addSegment segment

This action adds the segment to the end of the segments in the curve.

Parameters

segment

This parameter is the pw::Segment object to add.

Returns

This action returns nothing.

Information

An error will be raised if the segment already belongs to another curve or connector.

Example

This example shows how to add a segment to the end of a curve. $srcCrv(1) is referencing an existing source curve.

Code

set seg(1) [pw::SegmentSpline create]
$seg(1) addPoint [[$srcCrv(1) getSegment 2] getPoint 2]
$seg(1) addPoint "0 0 0"
$srcCrv(1) addSegment $seg(1)

insertSegment

$srcCrv insertSegment index segment

This action inserts the segment at the given index.

Parameters

index	This parameter is the integer index to insert the given segment at with the range [1, number of segments+1].
segment	This parameter is the pw::Segment object to insert.

Returns

This action returns nothing.

Information

An error will be raised if the segment already belongs to another curve or connector.

Inserting at an index of (number-of-segments + 1) will append the segment.

Example

This example shows how to insert a segment at the second index of a curve. $srcCrv(1) is referencing an existing source curve.

Code

set seg(1) [pw::SegmentSpline create]
$seg(1) addPoint [[$srcCrv(1) getSegment 1] getPoint 2]
$seg(1) addPoint "0 0 0"
$srcCrv(1) insertSegment 2 $seg(1)

removeSegment

$srcCrv removeSegment < index | segment >

This action removes a segment from the curve.

Parameters

index	This parameter is the integer index of the segment to remove with the range [1, number of segments].
segment	This parameter is the pw::Segment object to remove.

Returns

This action returns nothing.

Example

This example shows how to remove a segment from a curve according to its index. $srcCrv(1) is referencing an existing source curve.

Code

$srcCrv(1) removeSegment 3

removeAllSegments

$srcCrv removeAllSegments

This action removes all of the segments from the curve.

Parameters

This action has no parameters.

Returns

This action returns nothing.

Example

This example shows how to remove all segments from a curve. $srcCrv(1) is referencing an existing source curve.

Code

$srcCrv(1) removeAllSegments

replaceAllSegments

$srcCrv replaceAllSegments segments

This action replaces all of the segments in the curve.

Parameters

segments

This parameter is a list of pw::Segment objects that will be the new segments of this curve.

Returns

This action returns nothing.

Example

This example shows how to replace all the existing segments in a curve with new ones. $srcCrv(1) is referencing an existing source curve. $seg(1) and $seg(2) are referencing existing segments.

Code

$srcCrv(1) replaceAllSegments [list $seg(1) $seg(2)]

getPosition

$srcCrv getPosition ?< -parameter | -control | -arc | -X | -Y | -Z | -closest >? value

This action gets a position on a curve in the defining space of the curve.

Parameters

-parameter	This optional flag is the notification to get the position at a parameter. The value is a float with the range [0.0, 1.0] or a uv vector with v ignored. This is the default option.
-control	This optional flag is the notification to get the position at a control point. The value is an integer index with the range [1, number of control points].
-arc	This optional flag is the notification to get the position at an arc length. The value is a normalized float arc length from the start of the curve with the range [0.0, 1.0].
-X	This optional flag is the notification to get the position at a constant x; value is a float constant x coordinate value.
-Y	This optional flag is the notification to get the position at a constant y; value is a float constant y coordinate value.
-Z	This optional flag is the notification to get the position at a constant z; value is a float constant z coordinate value.
-closest	This optional flag is the notification to get the closest position; the value is an xyz point, or grid coord.
value	This parameter is the value to get the position.

Returns

This action returns a point giving the position on the curve which may be in the form “u v dbentity”.

Information

If the curve is defined in model space, an xyz vector will be returned. If the curve is defined by a database, the position will be returned in database parameter space.

Example

This example shows how to get the position at a constant X value on a curve. This curve was created on a database entity. $srcCrv(1) is referencing an existing source curve.

Code

puts [pw::Application getDescription \
    [$srcCrv(1) getPosition -X 3]]

Output

curve-1 (0.6,0)

getXYZ

$srcCrv getXYZ ?< -parameter | -control | -arc | -X | -Y | -Z | -closest >? value

This action gets the model space position on a curve.

Parameters

-parameter	This optional flag is the notification to get the position at a parameter. The value is a float with the range [0.0, 1.0] or a uv vector with v ignored. This is the default option.
-control	This optional flag is the notification to get the position at a control point. The value is an integer index with the range [1, number of control points].
-arc	This optional flag is the notification to get the position at an arc length. The value is a normalized float arc length from the start of the curve with the range [0.0, 1.0].
-X	This optional flag is the notification to get the position at a constant x; value is a float constant x coordinate value.
-Y	This optional flag is the notification to get the position at a constant y; value is a float constant y coordinate value.
-Z	This optional flag is the notification to get the position at a constant z; value is a float constant z coordinate value.
-closest	This optional flag is the notification to get the closest position; the value is an xyz point, or grid coord.
value	This parameter is the value to get the position.

Returns

This action returns an XYZ vector.

Example

This example shows how to get the model space position at 3/4 the the length of a curve. $srcCrv(1) is referencing an existing source curve.

Code

puts [$srcCrv(1) getXYZ -parameter [list 0.75]]

Output

3.75 2.0 0.0

getParameter

$srcCrv getParameter ?< -parameter | -control | -arc | -X | -Y | -Z | -closest >? value

This action gets a parameter value on a curve.

Parameters

-parameter	This optional flag is the notification to get the position at a parameter. The value is a float with the range [0.0, 1.0] or a uv vector with v ignored. This is the default option.
-control	This optional flag is the notification to get the position at a control point. The value is an integer index with the range [1, number of control points].
-arc	This optional flag is the notification to get the position at an arc length. The value is a normalized float arc length from the start of the curve with the range [0.0, 1.0].
-X	This optional flag is the notification to get the position at a constant x; value is a float constant x coordinate value.
-Y	This optional flag is the notification to get the position at a constant y; value is a float constant y coordinate value.
-Z	This optional flag is the notification to get the position at a constant z; value is a float constant z coordinate value.
-closest	This optional flag is the notification to get the closest position; the value is an xyz point, or grid coord.
value	This parameter is the value to get the position.

Returns

This action returns the float parameter of the curve.

Information

The -parameter value option only returns the given value clamped to [0.0, 1.0]. It is included for consistency with other commands.

Example

This example shows how to get the parameter value of a grid point on a curve. $srcCrv(1) is referencing an existing source curve.

Code

puts [$srcCrv(1) getParameter -grid 2]

Output

0.25

getTangent

$curve getTangent ?< -parameter | -control | -arc | -X | -Y | -Z | -closest >? value

This action gets the tangency vector on the source curve at a location.

Parameters

-parameter	This optional flag is notification to get the tangent vector at a parameter. The value is a float with the range [0.0, 1.0], or a uv vector with u having the range [0.0, 1.0] and v ignored. This is the default option.
-control	This optional flag denotes that value represents a control point index. value is an integer index with the range [1, number of control points]. See getControlPointCount.
-arc	This optional flag designates value as the normalized arc length from the start of the source curve. value is a float with the range [0.0, 1.0].
-X	This optional flag causes the routine to calculate the tangent vector at the singular point on the source curve at X = value. An error is returned if there is not a unique point.
-Y	This optional flag causes the routine to calculate the tangent vector at the singular point on the source curve at Y = value. An error is returned if there is not a unique point.
-Z	This optional flag causes the routine to calculate the tangent vector at the singular point on the source curve at Z = value. An error is returned if there is not a unique point.
-closest	This optional flag results in the routine calculating the tangent vector of the point on the source curve closest to the specified value. value is an xyz point, or grid coord.
value	This parameter is the value at which to get the tangent vector. Its interpretation is determined by the above flags. The default mode is the -parameter flag.

Returns

This action returns a normalized XYZ vector representing the tangency vector. The vector will be aligned with the parametric direction of the source curve.

getLength

$srcCrv getLength ?< -parameter | -control | -arc | -X | -Y | -Z | -closest >? value

This action gets the curve length from the beginning to a given location.

Parameters

-parameter	This optional flag is the notification to get the position at a parameter. The value is a float with the range [0.0, 1.0] or a uv vector with v ignored. This is the default option.
-control	This optional flag is the notification to get the position at a control point. The value is an integer index with the range [1, number of control points].
-arc	This optional flag is the notification to get the position at an arc length. The value is a normalized float arc length from the start of the curve with the range [0.0, 1.0].
-X	This optional flag is the notification to get the position at a constant x; value is a float constant x coordinate value.
-Y	This optional flag is the notification to get the position at a constant y; value is a float constant y coordinate value.
-Z	This optional flag is the notification to get the position at a constant z; value is a float constant z coordinate value.
-closest	This optional flag is the notification to get the closest position; the value is an xyz point, or grid coord.
value	This parameter is the value to get the position.

Returns

This action returns the float curve length.

Information

The -arc value option converts value from a normalized to a non-normalized length. It is included for consistency with other commands.

Example

This example shows how to get the length along a curve from the the point on the curve closest to the given point. $srcCrv(1) is referencing an existing source curve.

Code

puts [$srcCrv(1) getLength -closest "4.5 1 0"]

Output

6.985033540042618

getParameters

$srcCrv getParameters ?< -X | -Y | -Z >? value

This action gets the parameters at which the curve intersects the value.

Parameters

-X	This optional flag is the notification to get the position at a constant x; value is a float constant x coordinate value.
-Y	This optional flag is the notification to get the position at a constant y; value is a float constant y coordinate value.
-Z	This optional flag is the notification to get the position at a constant z; value is a float constant z coordinate value.
value	This parameter is the value to get the position.

Returns

This action returns an array of parameters.

Example

This example shows how to get parameters where this curve crosses Y-axis at 0.5. $srcCrv(1) is referencing an existing source curve.

Code

puts [$srcCrv(1) getParameters -Y .5]

Output

0.17637560670204108 0.2778605205775764 0.692205316990254

getTotalLength

$srcCrv getTotalLength ?-constrained constrainedVar?

This action gets the total length of the curve.

Parameters

-constrained constrainedVar

This optional parameter is the string name of a variable to receive the length of the this entity, that is constrained to database entities.

Returns

This action returns float length with the range [0.0, infinity).

Example

This example shows how to get the total length of a connecter, plus the length of the part constrained to a database entity. $srcCrv(1) is referencing an existing source curve.

Code

puts [$srcCrv(1) getTotalLength -constrained onDB]
puts $onDB

Output

10.012756135615804
5.0

spline

$srcCrv spline ?curve?

This action sets this source curve to a smooth interpolation of the control points of the given source curve.

Parameters

curve

This optional parameter is a pw::SourceCurve object whose control points will be interpolated. If not given the spline action will interpolate this source curve’s own control points.

Returns

This action returns nothing.

Information

If the given source curve is database constrained to a single parameter space, this action will set this source curve to a smooth interpolation in that parameter space, otherwise the curve will be unconstrained.

fitLSQ

$srcCrv fitLSQ ?-tolerance tol? ?curve?

This action sets this source curve to a least squares fit approximation of the control points of the given source curve.

Parameters

-tolerance tol	This optional parameter is the float approximation tolerance with the range [0, infinity). The default is the current tolerance returned from <getFitTolerance>.
curve	This optional parameter is a pw::SourceCurve object whose control points will be interpolated. If not given the spline action will interpolate this source curve’s own control points.

Returns

This action returns nothing.

Information

smoothC1

$srcCrv smoothC1 ?-tolerance tol? ?curve?

This action sets this source curve to a C1 continuous approximation of the shape of the given source curve.

Parameters

-tolerance tol	This optional parameter is the float approximation tolerance with the range [0, infinity). The default is the current tolerance returned from <getFitTolerance>.
curve	This optional parameter is a pw::SourceCurve object whose shape will be approximated. If not given the smoothC1 action will approximate this source curve’s own shape.

Returns

This action returns nothing.

Information

project

$srcCrv project ?-type proj_type? ?-direction direction? ?-center center? ?-axis point normal? ?-fit tolerance? ?-interior? ?dbentities?

This action projects this source curve onto one or more database entities.

Parameters

-type proj_type	This optional parameter is the string projection type to perform with options < ClosestPoint \| Linear \| SphericalIn \| SphericalOut \| CylindricalIn \| CylindricalOut >.
-direction direction	This optional parameter is the projection vector for linear projection. The default is determined by the entity and can be queried using getDefaultProjectDirection.
-center center	This optional parameter is the center point vector for spherical projection. The default is (0, 0, 0).
-axis point normal	This optional parameter is the axis defined by a point vector and normal vector used by cylindrical projection; The default point is (0, 0, 0) and the default normal is (1, 0, 0).
-fit tolerance	This is an optional parameter that is used to fit any curve-like entities. The default for this is 0 which means there is no fitting applied onto the projected curve. The valid range for this parameter is [0,infinity)
-interior	If this optional flag is present, only the interior of the entities are projected.
dbentities	This parameter is the optional list of database curve and surface-like entities to project onto. If none are given, project to any currently enabled, visible database surface-like entities.

Returns

This action returns nothing.

alignOrientation

$srcCrv alignOrientation ?-tolerance tol? curves

This action aligns the U orientation of the given source curves with this source curve.

Parameters

-tolerance tol	This optional parameter is the float tolerance used to consider curves adjacent. The default is fit tolerance.
curves	This parameter is a list of pw::SourceCurve objects to align with.

Returns

This action returns nothing.

Information

Any curves in the given list that are not connected (within tol) to this source curve will be ignored.

closestPoint

$srcCrv closestPoint ?-from fromVar? ?-distance distVar? ?-parameter paramVar? point ?dir?

This action gets the closest point on this source curve to the given point or ray.

Parameters

-from fromVar	This optional parameter is the string name of a variable to receive the xyz of the given point or the point along the ray that is closest to this entity.
-distance distVar	This optional parameter is the string name of a variable to receive the float distance between the given point or ray and the point entity.
-parameter paramVar	This optional parameter is the string name of a variable to receive the float parameter of the source curve where the closest point occurs with the range [0.0, 1.0].
point	This parameter is the point that is projected onto this source curve.
dir	This parameter is a direction vector for finding the closest point from a ray.

Returns

This action returns a point giving the closest point position and this may be in the form “u v dbentity”. If there is no closest point, the origin (0, 0, 0) will be returned.

Information

If the source curve is defined in model space, an xyz vector will be returned. If the source curve is defined by a database, the position will be returned in database parameter space.

closestControlPoint

$srcCrv closestControlPoint ?-from fromVar? ?-distance distVar? ?-parameter paramVar? ?-index indexVar? point ?dir?

This action gets the control point on this source curve closest to the given point.

Parameters

-from fromVar	This optional parameter is the string name of a variable to receive the xyz of the given point or the point along the ray that is closest to this source curve.
-distance distVar	This optional parameter is the string name of a variable to receive the float distance between the given point or ray and the point returned.
-parameter paramVar	This optional parameter is the string name of a variable to receive the float parameter of the source curve where the closest point occurs with the range [0.0, 1.0].
-index indexVar	This optional parameter is the string name of a variable to receive the control point index of the closest control point.
point	This parameter is the point to project onto this source curve.
dir	This paramter is a direction vector for finding the closest point from a ray.

Returns

This action returns a point in model space or the origin (0,0,0) if there is no closest point.

pw:: SourceCurve

Derives From

Static Actions

create

Parameters

Returns

Example

join

Parameters

Returns

Information

getBestSegment

Parameters

Returns

Example

Instance Actions

getSegmentCount

Parameters

Returns

Example

getSegment

Parameters

Returns

Example

getSegments

Parameters

Returns

Example

setSegment

Parameters

Returns

Example

addSegment

Parameters

Returns

Information

Example

insertSegment

Parameters

Returns

Information

Example

removeSegment

Parameters

Returns

Example

removeAllSegments

Parameters

Returns

Example

replaceAllSegments

Parameters

Returns

Example

getPosition

Parameters

Returns

Information

Example

getXYZ

Parameters

Returns

Example

getParameter

Parameters

Returns

Information

Example

getTangent

Parameters

Returns

getLength

Parameters

Returns

Information

Example

getParameters

Parameters

Returns

Example