pw:: SourcePointCloud

Source point cloud type

Derives From

pw::Object pw::Entity pw::SourceEntity

Summary
Source point cloud type
This action creates a new source point cloud object.
This action adds a point to the source point cloud.
This action adds points to the source point cloud from another source entity, using the primitive points that a source defines when the background spacing is as given
This action removes a point from the source point cloud.
This action removes all of the points from the point cloud.
This action gets the number of points in the point cloud.
This action gets the xyz of the point at the given index of the source point cloud.
This action sets the xyz of the point at the given index of the source point cloud.
This action gets the spacing of the point at the given index of the source point cloud.
This action sets the spacing of the point at the given index of the source point cloud.
This action gets the decay of the point at the given index of the source point cloud.
This action sets the decay of the point at the given index of the source point cloud.

Static Actions

create

pw::SourcePointCloud create

This action creates a new source point cloud object.

Parameters

none

Returns

This action returns a new pw::SourcePointCloud object.

Instance Actions

addPoint

$cloud addPoint xyz spacing decay

This action adds a point to the source point cloud.

Parameters

xyzThis vector parameter is the xyz to add to the point cloud.
spacingThis float parameter is the spacing at the xyz, with the valid values in the range (0.0, infinity).
decayThis float parameter is the decay at the xyz, with the valid values in the range [0.0, 1.0].

Returns

This action returns nothing.

addSourcePoints

$cloud addSourcePoints source ?spacing?

This action adds points to the source point cloud from another source entity, using the primitive points that a source defines when the background spacing is as given

Parameters

sourceThis pw::SourceEntity parameter is the source to get the primitive points from.
spacingThis optional float parameter is the background spacing, with default 0.0 and valid values in the range [0.0, infinity).

Returns

This action returns nothing.

removePoint

$cloud removePoint index

This action removes a point from the source point cloud.

Parameters

indexThis parameter is the integer index of the point to remove with the range [1, number of points].

Returns

This action returns nothing.

removeAllPoints

$curve removeAllPoints

This action removes all of the points from the point cloud.

Parameters

This action has no parameters.

Returns

This action returns nothing.

getPointCount

This action gets the number of points in the point cloud.

Parameters

none

Returns

This action returns the number of points in the point cloud.

getXYZ

$point getXYZ index

This action gets the xyz of the point at the given index of the source point cloud.

Parameters

indexThis parameter is the integer index of the point to get the xyz of with the range [1, number of points].

Returns

This action returns the vector xyz of the point.

setXYZ

$point setXYZ index xyz

This action sets the xyz of the point at the given index of the source point cloud.

Parameters

indexThis parameter is the integer index of the point to set the xyz of with the range [1, number of points].
xyzThis vector parameter is the xyz to set on the point cloud.

Returns

This action returns nothing.

getSpacing

$point getSpacing index

This action gets the spacing of the point at the given index of the source point cloud.

Parameters

indexThis parameter is the integer index of the point to get the spacing of with the range [1, number of points].

Returns

This action returns the float spacing of the point.

setSpacing

$point setSpacing index spacing

This action sets the spacing of the point at the given index of the source point cloud.

Parameters

indexThis parameter is the integer index of the point to set the xyz of with the range [1, number of points].
spacingThis float parameter is the spacing at the xyz, with the valid values in the range (0.0, infinity).

Returns

This action returns nothing.

getDecay

$point getDecay index

This action gets the decay of the point at the given index of the source point cloud.

Parameters

indexThis parameter is the integer index of the point to get the decay of with the range [1, number of points].

Returns

This action returns the float decay of the point.

setDecay

$point setDecay index decay

This action sets the decay of the point at the given index of the source point cloud.

Parameters

indexThis parameter is the integer index of the point to set the xyz of with the range [1, number of points].
decayThis float parameter is the decay at the xyz, with the valid values in the range [0.0, 1.0].

Returns

This action returns nothing.

pw::SourcePointCloud create
This action creates a new source point cloud object.
$cloud addPoint xyz spacing decay
This action adds a point to the source point cloud.
$cloud addSourcePoints source ?spacing?
This action adds points to the source point cloud from another source entity, using the primitive points that a source defines when the background spacing is as given
$cloud removePoint index
This action removes a point from the source point cloud.
$curve removeAllPoints
This action removes all of the points from the point cloud.
$point getXYZ index
This action gets the xyz of the point at the given index of the source point cloud.
$point setXYZ index xyz
This action sets the xyz of the point at the given index of the source point cloud.
$point getSpacing index
This action gets the spacing of the point at the given index of the source point cloud.
$point setSpacing index spacing
This action sets the spacing of the point at the given index of the source point cloud.
$point getDecay index
This action gets the decay of the point at the given index of the source point cloud.
$point setDecay index decay
This action sets the decay of the point at the given index of the source point cloud.
Base type for all glyph types
Entity type
Base type for all source entities
Source point cloud type
A vector is a list of float values.
A float is a fractional number.
An integer is a whole number.