NAME

vzSlicePlaneSet - A set of slicing planes.

INHERITS FROM

vzObject

HEADER FILE

#include <Volumizer2/SlicePlaneSet.h>

PUBLIC METHOD SUMMARY

vzSlicePlaneSet (

int maxPlanes);

int getNumPlanes (

);

int setPlaneEquation (

int index, double planeEqn[4]);

int getPlaneEquation (

int index, double planeEqn[4]);

int enable (

int index);

bool isEnabled (

int index);

int disable (

int index);

PROTECTED METHOD SUMMARY

~vzSlicePlaneSet (

);

CLASS DESCRIPTION

vzSlicePlaneSet provides a simple abstraction for specifying and rendering arbitrary slice planes. The slicing planes are specified by using the four coefficients of each of the planes. The slice planes are rendered in a sorted order using a recursive clipping algorithm. Methods are provided to manipulate, enable and disable individual slice planes.

METHOD DESCRIPTIONS

   vzSlicePlaneSet()

vzSlicePlaneSet (

int maxPlanes);

Constructor for vzSlicePlaneSet. One can specify any number of slicing planes using the maxPlanes parameter. A default value is selected for the plane equations of each of planes. These values can be modified later using the set methods. All the slice planes are enabled by default.

   ~vzSlicePlaneSet()

~vzSlicePlaneSet (

);

Destructor for vzSlicePlaneSet.

   disable()

int disable (

int index);

Disable the slice plane given by index. Returns index on success, -1 otherwise.

   enable()

int enable (

int index);

Enable the slice plane given by index. Returns index on success, -1 otherwise.

   getNumPlanes()

int getNumPlanes (

);

Return the number of slice planes in the slice plane set.

   getPlaneEquation()

int getPlaneEquation (

int index, double planeEqn[4]);

Get the plane equation for plane number index in planeEqn. Returns index on success, -1 otherwise.

   isEnabled()

bool isEnabled (

int index);

Returns true if the plane index is enabled. Returns false otherwise.

   setPlaneEquation()

int setPlaneEquation (

int index, double planeEqn[4]);

Set the plane equation for plane number index to planeEqn. Returns index on success, -1 otherwise.

SEE ALSO

vzObject, vzSlicePlaneSet

Back to Index