vtkPlanes Class Reference
#include <vtkPlanes.h>
Inheritance diagram for vtkPlanes:
[legend]Collaboration diagram for vtkPlanes:
[legend]List of all members.
Detailed Description
implicit function for convex set of planes
vtkPlanes computes the implicit function and function gradient for a set of planes. The planes must define a convex space.
The function value is the closest first order distance of a point to the convex region defined by the planes. The function gradient is the plane normal at the function value. Note that the normals must point outside of the convex region. Thus, a negative function value means that a point is inside the convex region.
There are several methods to define the set of planes. The most general is to supply an instance of vtkPoints and an instance of vtkDataArray. (The points define a point on the plane, and the normals corresponding plane normals.) Two other specialized ways are to 1) supply six planes defining the view frustrum of a camera, and 2) provide a bounding box.
- See also:
- vtkCamera
- Examples:
- vtkPlanes (Examples)
- Tests:
- vtkPlanes (Tests)
Definition at line 52 of file vtkPlanes.h.
|
Public Types |
| typedef vtkImplicitFunction | Superclass |
Public Member Functions |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
|
| void | PrintSelf (ostream &os, vtkIndent indent) |
| double | EvaluateFunction (double x[3]) |
| double | EvaluateFunction (double x, double y, double z) |
|
| void | EvaluateGradient (double x[3], double n[3]) |
| virtual void | SetPoints (vtkPoints *) |
| virtual vtkPoints * | GetPoints () |
|
| void | SetNormals (vtkDataArray *normals) |
| virtual vtkDataArray * | GetNormals () |
|
| void | SetFrustumPlanes (double planes[24]) |
| void | SetBounds (double bounds[6]) |
| void | SetBounds (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) |
|
| int | GetNumberOfPlanes () |
| vtkPlane * | GetPlane (int i) |
| void | GetPlane (int i, vtkPlane *plane) |
Static Public Member Functions |
| static vtkPlanes * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkPlanes * | SafeDownCast (vtkObject *o) |
Protected Member Functions |
| | vtkPlanes () |
| | ~vtkPlanes () |
Protected Attributes |
| vtkPoints * | Points |
| vtkDataArray * | Normals |
| vtkPlane * | Plane |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkPlanes::vtkPlanes |
( |
|
) |
[protected] |
|
| vtkPlanes::~vtkPlanes |
( |
|
) |
[protected] |
|
Member Function Documentation
| static vtkPlanes* vtkPlanes::New |
( |
|
) |
[static] |
|
|
|
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
Reimplemented in vtkPlanesIntersection. |
| virtual const char* vtkPlanes::GetClassName |
( |
|
) |
[virtual] |
|
| static int vtkPlanes::IsTypeOf |
( |
const char * |
type |
) |
[static] |
|
|
|
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkImplicitFunction. |
| virtual int vtkPlanes::IsA |
( |
const char * |
type |
) |
[virtual] |
|
|
|
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkImplicitFunction. |
| void vtkPlanes::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
[virtual] |
|
|
|
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkImplicitFunction.
Reimplemented in vtkPlanesIntersection. |
| double vtkPlanes::EvaluateFunction |
( |
double |
x[3] |
) |
[virtual] |
|
| double vtkPlanes::EvaluateFunction |
( |
double |
x, |
|
|
double |
y, |
|
|
double |
z |
|
) |
[inline] |
|
| void vtkPlanes::EvaluateGradient |
( |
double |
x[3], |
|
|
double |
n[3] |
|
) |
[virtual] |
|
| virtual void vtkPlanes::SetPoints |
( |
vtkPoints * |
|
) |
[virtual] |
|
|
|
Specify a list of points defining points through which the planes pass. |
| virtual vtkPoints* vtkPlanes::GetPoints |
( |
|
) |
[virtual] |
|
|
|
Evaluate planes gradient. |
|
|
Specify a list of normal vectors for the planes. There is a one-to-one correspondence between plane points and plane normals. |
|
|
Specify a list of normal vectors for the planes. There is a one-to-one correspondence between plane points and plane normals. |
| void vtkPlanes::SetFrustumPlanes |
( |
double |
planes[24] |
) |
|
|
| void vtkPlanes::SetBounds |
( |
double |
bounds[6] |
) |
|
|
|
|
An alternative method to specify six planes defined by a bounding box. The bounding box is a six-vector defined as (xmin,xmax,ymin,ymax,zmin,zmax). It defines six planes orthogonal to the x-y-z coordinate axes. |
| void vtkPlanes::SetBounds |
( |
double |
xmin, |
|
|
double |
xmax, |
|
|
double |
ymin, |
|
|
double |
ymax, |
|
|
double |
zmin, |
|
|
double |
zmax |
|
) |
|
|
| int vtkPlanes::GetNumberOfPlanes |
( |
|
) |
|
|
|
|
Return the number of planes in the set of planes. |
|
|
Create and return a pointer to a vtkPlane object at the ith position. Asking for a plane outside the allowable range returns NULL. This method always returns the same object. Use GetPlane(int i, vtkPlane plane) instead |
| void vtkPlanes::GetPlane |
( |
int |
i, |
|
|
vtkPlane * |
plane |
|
) |
|
|
|
|
Return the number of planes in the set of planes. |
Member Data Documentation
The documentation for this class was generated from the following file:
Generated on Tue Jan 22 00:07:33 2008 for VTK by
1.4.3-20050530