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

#include <vtkImplicitVolume.h>

Inheritance diagram for vtkImplicitVolume:

Collaboration diagram for vtkImplicitVolume:

Public Types
typedef vtkImplicitFunction	Superclass

Public Types inherited from vtkImplicitFunction
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkImplicitVolume *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

unsigned long	GetMTime ()

void	EvaluateGradient (double x[3], double n[3])


double	EvaluateFunction (double x[3])

double	EvaluateFunction (double x, double y, double z)


virtual void	SetVolume (vtkImageData *)

virtual vtkImageData *	GetVolume ()


virtual void	SetOutValue (double)

virtual double	GetOutValue ()


virtual void	SetOutGradient (double, double, double)

virtual void	SetOutGradient (double[3])

virtual double *	GetOutGradient ()

virtual void	GetOutGradient (double &, double &, double &)

virtual void	GetOutGradient (double[3])

Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunction *	NewInstance () const

double	FunctionValue (const double x[3])

double	FunctionValue (double x, double y, double z)

void	FunctionGradient (const double x[3], double g[3])

double *	FunctionGradient (const double x[3])

double *	FunctionGradient (double x, double y, double z)

virtual void	SetTransform (vtkAbstractTransform *)

virtual void	SetTransform (const double elements[16])

virtual vtkAbstractTransform *	GetTransform ()

double	EvaluateFunction (double x, double y, double z)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkImplicitVolume *	SafeDownCast (vtkObjectBase *o)

static vtkImplicitVolume *	New ()

Static Public Member Functions inherited from vtkImplicitFunction
static int	IsTypeOf (const char *type)

static vtkImplicitFunction *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkImplicitVolume ()

	~vtkImplicitVolume ()

Protected Member Functions inherited from vtkImplicitFunction
	vtkImplicitFunction ()

	~vtkImplicitFunction ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkImageData *	Volume

double	OutValue

double	OutGradient [3]

vtkIdList *	PointIds

Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransform *	Transform

double	ReturnValue [3]

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

Tests:: vtkImplicitVolume (Tests)

Definition at line 51 of file vtkImplicitVolume.h.

Member Typedef Documentation

typedef vtkImplicitFunction vtkImplicitVolume::Superclass

Definition at line 54 of file vtkImplicitVolume.h.

Constructor & Destructor Documentation

vtkImplicitVolume::vtkImplicitVolume ( )

protected

vtkImplicitVolume::~vtkImplicitVolume ( )

protected

Member Function Documentation

static int vtkImplicitVolume::IsTypeOf ( const char * type )

static

virtual int vtkImplicitVolume::IsA ( const char * name )

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.

static vtkImplicitVolume* vtkImplicitVolume::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkImplicitVolume::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImplicitFunction.

vtkImplicitVolume* vtkImplicitVolume::NewInstance ( ) const

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.

static 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).

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

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

Definition at line 70 of file vtkImplicitVolume.h.

void vtkImplicitVolume::EvaluateGradient	(	double	x[3],
		double	n[3]
	)

virtual

Evaluate ImplicitVolume gradient.

Implements vtkImplicitFunction.

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