pw:: Plane

Database plane type

Derives From

pw::Object pw::Entity pw::DatabaseEntity

Summary
Database plane type
This action creates a new database plane object.
This action gets the number of boundaries of the plane
This action gets a surface boundary.
This action gets all the curves that are at least partially on the surface.
This action sets the plane to represent a constant x, y, or z value.
This action sets the plane by giving a point that plane passes through and a normal vector.
This action sets the plane by giving three points that plane will pass through.
This action sets the plane by giving the coefficients of the plane equation Ax + By + Cz + D = 0.
This action gets the position in the defining space of the plane at the given parameter.
This action gets the position of the plane in model space at the given parameter.
This action gets the normal of this plane.
This action gets the signed distance of this plane from the origin.
This action gets the center point on this plane.
This action flips the orientation of this plane.

Static Actions

create

pw::Plane create

This action creates a new database plane object.

Parameters

none

Returns

This action returns a new pw::Plane object.

Instance Actions

getBoundaryCount

$plane getBoundaryCount

This action gets the number of boundaries of the plane

Parameters

none

Returns

This action will always return 0, since a plane has no boundaries, but is included for symmetry with the pw::Surface type.

getBoundary

$plane getBoundary index

This action gets a surface boundary.

Parameters

indexThis parameter is the index of the boundary to get.

Returns

This action always fails since a plane has no boundaries, but is included for symmetry with the pw::Surface type.

getInteriorCurves

$plane getInteriorCurves

This action gets all the curves that are at least partially on the surface.

Parameters

This action has no parameters.

Returns

This action returns a list of pw::Curve objects.

setConstant

$plane setConstant ?< -X | -Y | -Z >? value

This action sets the plane to represent a constant x, y, or z value.

Parameters

-XThis indicates the plane will represent a constant x value; the default.
-YThis indicates the plane will represent a constant y value.
-ZThis indicates the plane will represent a constant z value.
valueThis parameter is the constant x, y, or z value.

Returns

This action returns nothing.

setPointNormal

$plane setPointNormal point normal

This action sets the plane by giving a point that plane passes through and a normal vector.

Parameters

pointThis parameter is the point the plane will pass through.
normalThis parameter is the normal of the plane.

Returns

This action returns nothing.

setPoints

$plane setPoints point1 point2 point3

This action sets the plane by giving three points that plane will pass through.

Parameters

point1This parameter is a point the plane will pass through.
point2This parameter is a point the plane will pass through.
point3This parameter is a point the plane will pass through.

Returns

This action returns nothing.

setCoefficients

$plane setCoefficients A B C D

This action sets the plane by giving the coefficients of the plane equation Ax + By + Cz + D = 0.

Parameters

AThis parameter is the first coefficient.
BThis parameter is the second coefficient.
CThis parameter is the third coefficient.
DThis parameter is the fourth coefficient.

Returns

This action returns nothing.

getPosition

$plane getPosition ?-parameter? value

This action gets the position in the defining space of the plane at the given parameter.

Parameters

-parameterThis indicates to get the position at a parameter; the value is a uv parameter in the range [0.0, 1.0]; this is the default option.
valueThis parameter is the value at which to get the position.

Returns

This action returns a point giving the position on the surface (may be in the form “u v dbentity”).

getXYZ

$surface getXYZ ?-parameter? value

This action gets the position of the plane in model space at the given parameter.

Parameters

-parameterThis indicates to get the xyz at a parameter; the value is a uv parameter [(0,0), (1,1)]; this is the default option.
valueThis parameter is the value at which to get the position.

Returns

This action returns an XYZ vector.

getNormal

$plane getNormal

This action gets the normal of this plane.

Parameters

none

Returns

This action return the normal vector.

getDistance

$plane getDistance

This action gets the signed distance of this plane from the origin.

Parameters

none

Returns

This action returns the distance.

getCenter

$plane getCenter

This action gets the center point on this plane.

Parameters

none

Returns

This action returns the center.

flipOrientation

$plane flipOrientation

This action flips the orientation of this plane.

Parameters

none

Returns

This action returns nothing.

pw::Plane create
This action creates a new database plane object.
$plane getBoundaryCount
This action gets the number of boundaries of the plane
$plane getBoundary index
This action gets a surface boundary.
A boundary is reference to either a database curve or the edge of a database surface.
$plane getInteriorCurves
This action gets all the curves that are at least partially on the surface.
$plane setConstant ?< -X | -Y | -Z >? value
This action sets the plane to represent a constant x, y, or z value.
$plane setPointNormal point normal
This action sets the plane by giving a point that plane passes through and a normal vector.
$plane setPoints point1 point2 point3
This action sets the plane by giving three points that plane will pass through.
$plane setCoefficients A B C D
This action sets the plane by giving the coefficients of the plane equation Ax + By + Cz + D = 0.
$plane getPosition ?-parameter? value
This action gets the position in the defining space of the plane at the given parameter.
$surface getXYZ ?-parameter? value
This action gets the position of the plane in model space at the given parameter.
$plane getNormal
This action gets the normal of this plane.
$plane getDistance
This action gets the signed distance of this plane from the origin.
$plane getCenter
This action gets the center point on this plane.
$plane flipOrientation
This action flips the orientation of this plane.
Base type for all glyph types
Entity type
Base type for all database entities
Database plane type
Database surface type
Database curve type