pw::SegmentSpline

Point interpolating spline connector segment type

Derives From

pw::Object pw::Segment

Summary
pw::SegmentSplinePoint interpolating spline connector segment type
Static Actions
createThis action creates a new connector spline segment object.
Instance Attributes
ProjectToCommonThis attribute controls whether the segment should be automatically projected to a database entity if all of the control points are constrained to the same database entity.
Instance Actions
getCommonEntityThis action gets the entity that is common to all control points.
getSlopeThis action gets the method for calculating the slope vector of all control points.
setSlopeThis action sets the method for calculating the slope vector of all control points.
getSlopeInThis action gets the incoming slope vector of the given control point.
setSlopeInThis action sets the incoming slope vector of the given control point.
getSlopeOutThis action gets the outgoing slope vector of the given control point.
setSlopeOutThis action sets the outgoing slope vector of the given control point.
smoothPointsThis action modifies the control points of this segment by smoothing.

Static Actions

create

pw::SegmentSpline create

This action creates a new connector spline segment object.

Parameters

none

Returns

This action returns a new pw::SegmentSpline object.

Instance Attributes

ProjectToCommon

$segment get/setProjectToCommon project

This attribute controls whether the segment should be automatically projected to a database entity if all of the control points are constrained to the same database entity.

Type

A boolean where true indicates that the segment should be projected to a common pw::DatabaseEntity.

Default

The default for this attribute is false.

Instance Actions

getCommonEntity

$segment getCommonEntity

This action gets the entity that is common to all control points.

Parameters

none

Returns

This action returns a pw::DatabaseEntity object.  An error is raised if there is no common entity.

getSlope

$segment getSlope

This action gets the method for calculating the slope vector of all control points.

Parameters

none

Returns

The action returns the string type of slope calculation with options < Linear | Akima | CatmullRom | Free >.

setSlope

$segment setSlope type

This action sets the method for calculating the slope vector of all control points.

Parameters

typeThis required parameter is the string type of slope calculation with options < Linear | Akima | CatmullRom | Free >.

Returns

This action returns nothing.

Information

Setting the slope to type Free, converts all slopes to Free using the current actual slope vector as the explicit slope vectors

getSlopeIn

$segment getSlopeIn index

This action gets the incoming slope vector of the given control point.

Parameters

indexThis required parameter is the integer index of the control point in the range (1, number of points].

Returns

This action returns the xyz vector of the incoming slope at the given point.

setSlopeIn

$segment setSlopeIn ?-continuous? index xyz

This action sets the incoming slope vector of the given control point.

Parameters

-continuousIf this optional flag is present the outgoing slope vector of the control point will be forced to be continuous.
indexThis required parameter is the integer index of the control point in the range (1, number of points].
xyzThis required parameter is the slope vector.

Returns

This action returns nothing.

Information

If this action is called on a segment whose slope type is not Free, it will first be converted to a Free slope segment.

getSlopeOut

$segment getSlopeOut index

This action gets the outgoing slope vector of the given control point.

Parameters

indexThis required parameter is the integer index of the control point in the range [1, number of points).  Returns: This action returns the xyz vector of the outgoing slope at the given point.

setSlopeOut

$segment setSlopeOut ?-continuous? index xyz

This action sets the outgoing slope vector of the given control point.

Parameters

-continuousIf this optional flag is present the incoming slope vector of the control point will be forced to be continuous.
indexThis required parameter is the integer index of the control point in the range [1, number of points).
xyzThis required parameter is the slope vector.

Returns

This action returns nothing.

Information

If this is called on a segment whose slope type is not Free, it will first be converted to a Free slope segment

smoothPoints

$segment smoothPoints

This action modifies the control points of this segment by smoothing.

Parameters

none

Returns

This action returns nothing.

pw::SegmentSpline create
This action creates a new connector spline segment object.
$segment get/setProjectToCommon project
This attribute controls whether the segment should be automatically projected to a database entity if all of the control points are constrained to the same database entity.
$segment getCommonEntity
This action gets the entity that is common to all control points.
$segment getSlope
This action gets the method for calculating the slope vector of all control points.
$segment setSlope type
This action sets the method for calculating the slope vector of all control points.
$segment getSlopeIn index
This action gets the incoming slope vector of the given control point.
$segment setSlopeIn ?-continuous? index xyz
This action sets the incoming slope vector of the given control point.
$segment getSlopeOut index
This action gets the outgoing slope vector of the given control point.
$segment setSlopeOut ?-continuous? index xyz
This action sets the outgoing slope vector of the given control point.
$segment smoothPoints
This action modifies the control points of this segment by smoothing.
Base type for all glyph types
Connector and Curve segment type
Point interpolating spline connector segment type
A boolean is represented as a 0 or 1, with 0 being false and 1 being true.
Base type for all database entities
A string is an array of characters.
An integer is a whole number.
A vector is a list of float values.
Close