treat a volume as if it were an implicit function
More...
#include <vtkImplicitVolume.h>
Inherits vtkImplicitFunction.
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
Definition at line 48 of file vtkImplicitVolume.h.
vtkImplicitVolume::vtkImplicitVolume |
( |
| ) |
|
|
protected |
vtkImplicitVolume::~vtkImplicitVolume |
( |
| ) |
|
|
protected |
static int vtkImplicitVolume::IsTypeOf |
( |
const char * |
type | ) |
|
|
static |
virtual int vtkImplicitVolume::IsA |
( |
const char * |
type | ) |
|
|
virtual |
virtual vtkObjectBase* vtkImplicitVolume::NewInstanceInternal |
( |
| ) |
const |
|
protectedvirtual |
void vtkImplicitVolume::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
| |
Construct an vtkImplicitVolume with no initial volume; the OutValue set to a large negative number; and the OutGradient set to (0,0,1).
unsigned long vtkImplicitVolume::GetMTime |
( |
| ) |
|
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.
double vtkImplicitVolume::EvaluateFunction |
( |
double |
x[3] | ) |
|
Evaluate the ImplicitVolume. This returns the interpolated scalar value at x[3].
double vtkImplicitVolume::EvaluateFunction |
( |
double |
x, |
|
|
double |
y, |
|
|
double |
z |
|
) |
| |
|
inline |
Evaluate the ImplicitVolume. This returns the interpolated scalar value at x[3].
Definition at line 67 of file vtkImplicitVolume.h.
void vtkImplicitVolume::EvaluateGradient |
( |
double |
x[3], |
|
|
double |
n[3] |
|
) |
| |
Evaluate ImplicitVolume gradient.
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.
vtkImageData* vtkImplicitVolume::Volume |
|
protected |
double vtkImplicitVolume::OutValue |
|
protected |
double vtkImplicitVolume::OutGradient[3] |
|
protected |
vtkIdList* vtkImplicitVolume::PointIds |
|
protected |
The documentation for this class was generated from the following file: