Glyph2 Version 2.18.0 |
## pw:: PlaneDatabase plane type ## Derives Frompw::Object pw::Entity pw::DatabaseEntity Summary
## create
This action creates a new database plane object. ## Parametersnone ## ReturnsThis action returns a new pw::Plane object. ## getBoundaryCount
This action gets the number of boundaries of the plane ## Parametersnone ## ReturnsThis action will always return 0, since a plane has no boundaries, but is included for symmetry with the pw::Surface type. ## getBoundary
This action gets a surface boundary. ## Parameters
## ReturnsThis action always fails since a plane has no boundaries, but is included for symmetry with the pw::Surface type. ## getInteriorCurves
This action gets all the curves that are at least partially on the surface. ## ParametersThis action has no parameters. ## ReturnsThis action returns a list of pw::Curve objects. ## setConstant
This action sets the plane to represent a constant x, y, or z value. ## Parameters
## ReturnsThis action returns nothing. ## setPoints
This action sets the plane by giving three points that plane will pass through. ## Parameters
## ReturnsThis action returns nothing. ## setCoefficients
This action sets the plane by giving the coefficients of the plane equation Ax + By + Cz + D = 0. ## Parameters
## ReturnsThis action returns nothing. ## getPosition
This action gets the position in the defining space of the plane at the given parameter. ## Parameters
## ReturnsThis action returns a point giving the position on the surface (may be in the form “u v dbentity”). ## getXYZ
This action gets the position of the plane in model space at the given parameter. ## Parameters
## ReturnsThis action returns an XYZ vector. ## getPlane
This action gets the plane coefficients. ## Parameters
## ReturnsThis action returns the plane as list of 4 coefficients. If the -D option is specified, the result can be treated as a pwu::Plane object. |

This action creates a new database plane object.

pw::Plane create

This action gets the number of boundaries of the plane

$plane getBoundaryCount

This action gets a surface boundary.

$plane getBoundary index

A boundary is reference to either a database curve or the edge of a database surface.

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

$plane getInteriorCurves

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

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

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

$plane setPointNormal point normal

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

$plane setPoints point1 point2 point3

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

$plane setCoefficients A B C D

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

$plane getPosition ?-parameter? value

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

$surface getXYZ ?-parameter? value

This action gets the normal of this plane.

$plane getNormal

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

$plane getDistance

This action gets the center point on this plane.

$plane getCenter

This action gets the plane coefficients.

$plane getPlane ?-D?

This action flips the orientation of this plane.

$plane flipOrientation

Base type for all glyph types

Entity type

Base type for all database entities

Database plane type

Database surface type

Database curve type

Utility functions for planes, which are represented as a list of four real values (the A, B, C and D coeffecients).