pw:: Distribution

Base class for distribution types

Derives From

pw::Object

Summary
Base class for distribution types
This attribute is the grid point distribution variable.
This attribute is the grid point distribution normal.
This action deletes the distribution.
This action gets the requested grid point spacing at the beginning of the distribution.
This action sets the requested grid point spacing at the beginning of the distribution.
This action gets the requested grid point spacing at the end of the distribution.
This action sets the requested grid point spacing at the end of the distribution.
This action reverses the distribution, including the spacing constraints.
This action creates a copy of the distribution.

Instance Attributes

Variable

$dist get/setVariable < ArcLength | X | Y | Z >

This attribute is the grid point distribution variable.

Type

This attribute is a string with options < ArcLength | X | Y | Z | NonAligned >.

Default

The default for this attribute is ArcLength.

Information

This attribute is related to the Normal attribute.  Setting this attribute will change the Normal attribute to match the value of this attribute.

NonAligned is not a valid value for setVariable.  NonAligned is only returned when a non-axis aligned, normal vector has been assigned to Normal.

See Also

Normal

Normal

$dist get/setNormal vector

This attribute is the grid point distribution normal.

Type

This attribute is an xyz vector.

Default

The default for this attribute is “0 0 0”.

Information

This attribute is related to the Variable attribute.  Setting this attribute will change the Variable attribute to match the value of this attribute.

If the value of this attribute is the zero vector, the Variable will be set to ArcLength.

Instance Actions

delete

$dist delete

This action deletes the distribution.

Parameters

This action has no parameters.

Returns

This action returns nothing.

Information

This is necessary to delete a distribution that has not been added to a pw::Connector.

Calling delete on a distribution after it has been added to a pw::Connector, will generate an error.

getBeginSpacing

$dist getBeginSpacing

This action gets the requested grid point spacing at the beginning of the distribution.

Parameters

This action has no parameters.

Returns

This action returns a pw::Spacing object.

setBeginSpacing

$dist setBeginSpacing < spacing | value >

This action sets the requested grid point spacing at the beginning of the distribution.

Parameters

spacingThis parameter is a pw::Spacing object.
valueThis parameter is the float value to set for a pw::SpacingExplicit object which will be created for the begin spacing of this distribution with the range [0, infinity).

Returns

This action returns nothing.

getEndSpacing

$dist getEndSpacing

This action gets the requested grid point spacing at the end of the distribution.

Parameters

This action has no parameters.

Returns

This action returns a pw::Spacing object.

setEndSpacing

$dist setEndSpacing < spacing | value >

This action sets the requested grid point spacing at the end of the distribution.

Parameters

spacingThis parameter is a pw::Spacing object.
valueThis parameter is the float value to set for a pw::SpacingExplicit object which will be created for the begin spacing of this distribution with the range [0, infinity).

Returns

This action returns nothing.

reverse

$dist reverse

This action reverses the distribution, including the spacing constraints.

Parameters

This action has no parameters.

Returns

This action returns nothing.

copy

$dist copy

This action creates a copy of the distribution.

Parameters

This action has no parameters.

Returns

This action returns a new <distribution>.

$dist get/setVariable < ArcLength | X | Y | Z >
This attribute is the grid point distribution variable.
$dist get/setNormal vector
This attribute is the grid point distribution normal.
$dist delete
This action deletes the distribution.
$dist getBeginSpacing
This action gets the requested grid point spacing at the beginning of the distribution.
$dist setBeginSpacing < spacing | value >
This action sets the requested grid point spacing at the beginning of the distribution.
$dist getEndSpacing
This action gets the requested grid point spacing at the end of the distribution.
$dist setEndSpacing < spacing | value >
This action sets the requested grid point spacing at the end of the distribution.
$dist reverse
This action reverses the distribution, including the spacing constraints.
$dist copy
This action creates a copy of the distribution.
Base type for all glyph types
A string is an array of characters.
A vector is a list of float values.
Connector type
Base class for spacing types
A float is a fractional number.
Explicit spacing type