Database plane type

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

Summary

pw:: | Database plane type |

Static Actions | |

create | This action creates a new database plane object. |

Instance Actions | |

getBoundaryCount | This action gets the number of boundaries of the plane |

getBoundary | This action gets a surface boundary. |

getBoundaries | This action gets all surface boundaries. |

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

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

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

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

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

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

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

getNormal | This action gets the normal of this plane. |

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

getCenter | This action gets the center point on this plane. |

getPlane | This action gets the plane coefficients. |

flipOrientation | This action flips the orientation of this plane. |

pw::Plane create

This action creates a new database plane object.

none

This action returns a new pw::Plane object.

$plane getBoundaryCount

This action gets the number of boundaries of the plane

none

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

$plane getBoundary index

This action gets a surface boundary.

index | This parameter is the index of the boundary to get. |

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

$plane getBoundaries

This action gets all surface boundaries.

This action has no parameters.

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

$plane getInteriorCurves

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

This action has no parameters.

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

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

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

-X | This indicates the plane will represent a constant x value; the default. |

-Y | This indicates the plane will represent a constant y value. |

-Z | This indicates the plane will represent a constant z value. |

value | This parameter is the constant x, y, or z value. |

This action returns nothing.

$plane setPoints point1 point2 point3

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

point1 | This parameter is a point the plane will pass through. |

point2 | This parameter is a point the plane will pass through. |

point3 | This parameter is a point the plane will pass through. |

This action returns nothing.

$plane setCoefficients A B C D

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

A | This parameter is the first coefficient. |

B | This parameter is the second coefficient. |

C | This parameter is the third coefficient. |

D | This parameter is the fourth coefficient. |

This action returns nothing.

$plane getPosition ?-parameter? value

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

-parameter | This 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. |

value | This parameter is the value at which to get the position. |

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

$surface getXYZ ?-parameter? value

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

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

value | This parameter is the value at which to get the position. |

This action returns an XYZ vector.

$plane getPlane ?-D?

This action gets the plane coefficients.

-D | If specified, the coefficients correspond to the equation Ax + By + Cz = D, which matches the pwu::Plane format. If not specified, the coefficients correspond to the Ax + By + Cz + D = 0 equation. |

This 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 surface boundaries.

$plane getBoundaries

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).