---

vtkPlanes Class Reference

implicit function for convex set of planes. More...

#include <vtkPlanes.h>

Inheritance diagram for vtkPlanes:

[legend]Collaboration diagram for vtkPlanes:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
float	EvaluateFunction (float x[3])
float	EvaluateFunction (float x, float y, float z)
void	EvaluateGradient (float x[3], float n[3])
virtual void	SetPoints (vtkPoints *)
virtual vtkPoints *	GetPoints ()
virtual void	SetNormals (vtkNormals *)
virtual vtkNormals *	GetNormals ()
void	SetFrustumPlanes (float aspect, vtkCamera *camera)
int	GetNumberOfPlanes ()
vtkPlane *	GetPlane (int i)
Static Public Methods
vtkPlanes *	New ()
int	IsTypeOf (const char *type)
vtkPlanes *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkPlanes ()
	~vtkPlanes ()
	vtkPlanes (const vtkPlanes &)
void	operator= (const vtkPlanes &)
Protected Attributes
vtkPoints *	Points
vtkNormals *	Normals
vtkPlane *	Plane

---

Detailed Description

implicit function for convex set of planes.

Date:

2000/12/10 20:08:46

Revision:

1.39

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.

Examples:

vtkPlanes (examples)

---

Member Function Documentation

float vtkPlanes::EvaluateFunction (  float    x[3] )  [virtual]

Evaluate plane equations. Return smallest absolute value. Implements vtkImplicitFunction.

void vtkPlanes::EvaluateGradient (  float    x[3], float    n[3] )  [virtual]

Evaluate planes gradient. Implements vtkImplicitFunction.

virtual const char* vtkPlanes::GetClassName (    )  [virtual]

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImplicitFunction.

int vtkPlanes::GetNumberOfPlanes (    )

Return the number of planes in the set of planes.

vtkPlane* vtkPlanes::GetPlane (  int    i )

Create and return a pointer to a vtkPlane object at the ith position. It is your responsibility to delete the vtkPlane when done with it. Asking for a plane outside the allowable range returns NULL.

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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImplicitFunction.

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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImplicitFunction.

vtkPlanes* vtkPlanes::New (    )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkObject.

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.

vtkPlanes* vtkPlanes::SafeDownCast (  vtkObject *    o )  [static]

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkImplicitFunction.

void vtkPlanes::SetFrustumPlanes (  float    aspect, vtkCamera *    camera )

Specify the planes via a camera frustum definition.

virtual void vtkPlanes::SetNormals (  vtkNormals *    )  [virtual]

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

virtual void vtkPlanes::SetPoints (  vtkPoints *    )  [virtual]

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

---

The documentation for this class was generated from the following file:

• vtkPlanes.h

---