vtkImplicitVolume Class Reference
#include <vtkImplicitVolume.h>
Inheritance diagram for vtkImplicitVolume:
[legend]Collaboration diagram for vtkImplicitVolume:
[legend]List of all members.
Detailed Description
treat a volume as if it were an implicit function
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:
- The input volume data is only updated when GetMTime() is called. Works for 3D structured points datasets, 0D-2D datasets won't work properly.
- See also:
- vtkImplicitFunction vtkImplicitDataSet vtkClipPolyData vtkCutter vtkImplicitWindowFunction
- Created by:
-
- CVS contributions (if > 5%):
- Lorensen, Bill (35%)
- Schroeder, Will (20%)
- Gobbi, David (11%)
- Martin, Ken (9%)
- Law, Charles (7%)
- CVS logs (CVSweb):
/Filtering/vtkImplicitVolume.cxx)/Filtering/vtkImplicitVolume.h)
- Tests:
- vtkImplicitVolume (Tests)
Definition at line 64 of file vtkImplicitVolume.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkImplicitVolume::vtkImplicitVolume |
( |
|
) |
[protected] |
|
Member Function Documentation
| virtual const char* vtkImplicitVolume::GetClassName |
( |
|
) |
[virtual] |
|
| 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 vtkTypeRevisionMacro found in vtkSetGet.h.
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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkImplicitFunction. |
| 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. |
|
|
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. |
| unsigned long vtkImplicitVolume::GetMTime |
( |
|
) |
[virtual] |
|
|
|
Returns the mtime also considering the volume. This also calls Update on the volume, and it therefore must be called before the function is evaluated.
Reimplemented from vtkImplicitFunction. |
| double vtkImplicitVolume::EvaluateFunction |
( |
double |
x[3] |
) |
[virtual] |
|
|
|
Evaluate the ImplicitVolume. This returns the interpolated scalar value at x[3].
Implements vtkImplicitFunction. |
| double vtkImplicitVolume::EvaluateFunction |
( |
double |
x, |
|
|
double |
y, |
|
|
double |
z |
|
) |
[inline] |
|
| void vtkImplicitVolume::EvaluateGradient |
( |
double |
x[3], |
|
|
double |
n[3] |
|
) |
[virtual] |
|
| virtual void vtkImplicitVolume::SetVolume |
( |
vtkImageData * |
|
) |
[virtual] |
|
|
|
Specify the volume for the implicit function. |
| virtual vtkImageData* vtkImplicitVolume::GetVolume |
( |
|
) |
[virtual] |
|
|
|
Specify the volume for the implicit function. |
| virtual void vtkImplicitVolume::SetOutValue |
( |
double |
|
) |
[virtual] |
|
|
|
Set the function value to use for points outside of the dataset. |
| virtual double vtkImplicitVolume::GetOutValue |
( |
|
) |
[virtual] |
|
|
|
Set the function value to use for points outside of the dataset. |
| virtual void vtkImplicitVolume::SetOutGradient |
( |
double |
, |
|
|
double |
, |
|
|
double |
|
|
) |
[virtual] |
|
|
|
Set the function gradient to use for points outside of the dataset. |
| virtual void vtkImplicitVolume::SetOutGradient |
( |
double |
[3] |
) |
[virtual] |
|
|
|
Set the function gradient to use for points outside of the dataset. |
| virtual double* vtkImplicitVolume::GetOutGradient |
( |
|
) |
[virtual] |
|
|
|
Set the function gradient to use for points outside of the dataset. |
| virtual void vtkImplicitVolume::GetOutGradient |
( |
double & |
, |
|
|
double & |
, |
|
|
double & |
|
|
) |
[virtual] |
|
|
|
Set the function gradient to use for points outside of the dataset. |
| virtual void vtkImplicitVolume::GetOutGradient |
( |
double |
[3] |
) |
[virtual] |
|
|
|
Set the function gradient to use for points outside of the dataset. |
Member Data Documentation
The documentation for this class was generated from the following file: