Documentation for vtkPlanes

vtkPlanes - implicit function for convex set of planes

Super Class: vtkImplicitFunction

Description:

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. To define the planes you must create two objects: a subclass of vtkPoints (e.g., vtkPoints) and a subclass of vtkNormals (e.g., vtkNormals). The points define a point on the plane, and the normals specify plane normals.

 

Methods:

void vtkPlanes ()
void vtkPlanes ()
static vtkPlanes *New ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
float EvaluateFunction (float )
void EvaluateGradient (float ,float )
void SetPoints (vtkPoints *)
vtkPoints *GetPoints ()
void SetNormals (vtkNormals *)
vtkNormals *GetNormals ()

 

Detailed Method Descriptions:

Specify a list of points defining points through which the planes pass.

void SetPoints (vtkPoints *)
vtkPoints *GetPoints ()

Specify a list of normal vectors for the planes. There is a one-to-one correspondence between plane points and plane normals.

void SetNormals (vtkNormals *)
vtkNormals *GetNormals ()