Main Page   Class Hierarchy   Alphabetical List   Compound List   Compound Members   Related Pages  

vtkImplicitVolume Class Reference

treat a volume as if it were an implicit function. More...

#include <vtkImplicitVolume.h>

Inheritance diagram for vtkImplicitVolume:

Inheritance graph
[legend]
Collaboration diagram for vtkImplicitVolume:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
unsigned long GetMTime ()
float EvaluateFunction (float x[3])
float EvaluateFunction (float x, float y, float z)
void EvaluateGradient (float x[3], float n[3])
virtual void SetVolume (vtkStructuredPoints *)
virtual vtkStructuredPointsGetVolume ()
void SetVolume (vtkImageData *cache)
virtual void SetOutValue (float)
virtual float GetOutValue ()
virtual void SetOutGradient (float, float, float)
virtual void SetOutGradient (float[3])
virtual float * GetOutGradient ()
virtual void GetOutGradient (float &, float &, float &)
virtual void GetOutGradient (float[3])

Static Public Methods

int IsTypeOf (const char *type)
vtkImplicitVolume * SafeDownCast (vtkObject *o)
vtkImplicitVolume * New ()

Protected Methods

 vtkImplicitVolume ()
 ~vtkImplicitVolume ()
 vtkImplicitVolume (const vtkImplicitVolume &)
void operator= (const vtkImplicitVolume &)

Protected Attributes

vtkStructuredPointsVolume
float OutValue
float OutGradient [3]
vtkIdListPointIds

Detailed Description

treat a volume as if it were an implicit function.

Date:
2000/12/10 20:08:40
Revision:
1.23

vtkImplicitVolume treats a volume (e.g., structured point dataset) as if it were an implicit function. This means it computes a function value and gradient. vtkImplicitVolume is a concrete implementation of vtkImplicitFunction.

vtkImplicitDataSet computes the function (at the point x) by performing cell interpolation. That is, it finds the cell containing x, and then uses the cell's interpolation functions to compute an interpolated scalar value at x. (A similar approach is used to find the gradient, if requested.) Points outside of the dataset are assigned the value of the ivar OutValue, and the gradient value OutGradient.

Warning:
Works for 3D structured points datasets, 0D-2D datasets won't work properly.
See also:
vtkImplicitFunction vtkImplicitDataSet vtkClipPolyData vtkCutter vtkImplicitWindowFunction
Examples:
vtkImplicitVolume (examples)


Member Function Documentation

float vtkImplicitVolume::EvaluateFunction float    x[3] [virtual]
 

Evaluate the ImplicitVolume. This returns the interpolated scalar value at x[3].

Implements vtkImplicitFunction.

void vtkImplicitVolume::EvaluateGradient float    x[3],
float    n[3]
[virtual]
 

Evaluate ImplicitVolume gradient.

Implements vtkImplicitFunction.

virtual const char* vtkImplicitVolume::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.

unsigned long vtkImplicitVolume::GetMTime   [virtual]
 

Returns the mtime also considering the volume.

Reimplemented from vtkImplicitFunction.

virtual int vtkImplicitVolume::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 vtkImplicitVolume::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.

vtkImplicitVolume* vtkImplicitVolume::New   [static]
 

Construct an vtkImplicitVolume with no initial volume; the OutValue set to a large negative number; and the OutGradient set to (0,0,1).

Reimplemented from vtkObject.

void vtkImplicitVolume::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.

vtkImplicitVolume* vtkImplicitVolume::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.

virtual void vtkImplicitVolume::SetOutGradient float   ,
float   ,
float   
[virtual]
 

Set the function gradient to use for points outside of the dataset.

virtual void vtkImplicitVolume::SetOutValue float    [virtual]
 

Set the function value to use for points outside of the dataset.

virtual void vtkImplicitVolume::SetVolume vtkStructuredPoints   [virtual]
 

Specify the volume for the implicit function.


The documentation for this class was generated from the following file:
Generated on Tue Mar 19 13:27:19 2002 for VTK by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002