implicit function for an halo More...

#include <vtkImplicitHalo.h>

Inheritance diagram for vtkImplicitHalo:

Collaboration diagram for vtkImplicitHalo:

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)

vtkImplicitHalo *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

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


virtual double	EvaluateFunction (double x[3])

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


virtual void	SetRadius (double)

virtual double	GetRadius ()


virtual void	SetCenter (double, double, double)

virtual void	SetCenter (double[3])

virtual double *	GetCenter ()

virtual void	GetCenter (double &, double &, double &)

virtual void	GetCenter (double[3])


virtual void	SetFadeOut (double)

virtual double	GetFadeOut ()

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

unsigned long	GetMTime ()

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 vtkImplicitHalo *	New ()

static int	IsTypeOf (const char *type)

static vtkImplicitHalo *	SafeDownCast (vtkObjectBase *o)

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

	vtkImplicitHalo ()

virtual	~vtkImplicitHalo ()

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
double	Radius

double	Center [3]

double	FadeOut

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

implicit function for an halo

vtkImplicitHalo evaluates to 1.0 for each position in the sphere of a given center and radius Radius*(1-FadeOut). It evaluates to 0.0 for each position out the sphere of a given Center and radius Radius. It fades out linearly from 1.0 to 0.0 for points in a radius from Radius*(1-FadeOut) to Radius. vtkImplicitHalo is a concrete implementation of vtkImplicitFunction. It is useful as an input to vtkSampleFunction to generate an 2D image of an halo. It is used this way by vtkShadowMapPass.

Warning: It does not implement the gradient.

Definition at line 37 of file vtkImplicitHalo.h.

Member Typedef Documentation

typedef vtkImplicitFunction vtkImplicitHalo::Superclass

Definition at line 43 of file vtkImplicitHalo.h.

Constructor & Destructor Documentation

vtkImplicitHalo::vtkImplicitHalo ( )

protected

virtual vtkImplicitHalo::~vtkImplicitHalo ( )

protectedvirtual

Member Function Documentation

static vtkImplicitHalo* vtkImplicitHalo::New ( )

static

Center=(0.0,0.0,0.0), Radius=1.0, FadeOut=0.01

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

static

virtual int vtkImplicitHalo::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 vtkImplicitHalo* vtkImplicitHalo::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkImplicitHalo::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImplicitFunction.

vtkImplicitHalo* vtkImplicitHalo::NewInstance ( ) const

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

virtual double vtkImplicitHalo::EvaluateFunction ( double x[3] )

virtual

Evaluate the equation.

Implements vtkImplicitFunction.

virtual double vtkImplicitHalo::EvaluateFunction	(	double	x,
		double	y,
		double	z
	)

inlinevirtual

Evaluate the equation.

Definition at line 49 of file vtkImplicitHalo.h.

void vtkImplicitHalo::EvaluateGradient	(	double	x[3],
		double	g[3]
	)

virtual

Evaluate normal. Not implemented.

Implements vtkImplicitFunction.

virtual void vtkImplicitHalo::SetRadius ( double )

virtual

Radius of the sphere.

virtual double vtkImplicitHalo::GetRadius ( )

virtual

Radius of the sphere.

virtual void vtkImplicitHalo::SetCenter	(	double	,
		double	,
		double
	)

virtual

Center of the sphere.

virtual void vtkImplicitHalo::SetCenter ( double [3] )

virtual

Center of the sphere.

virtual double* vtkImplicitHalo::GetCenter ( )

virtual

Center of the sphere.

virtual void vtkImplicitHalo::GetCenter	(	double &	,
		double &	,
		double &
	)

virtual

Center of the sphere.

virtual void vtkImplicitHalo::GetCenter ( double [3] )

virtual

Center of the sphere.

virtual void vtkImplicitHalo::SetFadeOut ( double )

virtual

FadeOut ratio. Valid values are between 0.0 and 1.0.

virtual double vtkImplicitHalo::GetFadeOut ( )

virtual

FadeOut ratio. Valid values are between 0.0 and 1.0.

Member Data Documentation

double vtkImplicitHalo::Radius

protected

Definition at line 80 of file vtkImplicitHalo.h.

double vtkImplicitHalo::Center[3]

protected

Definition at line 81 of file vtkImplicitHalo.h.

double vtkImplicitHalo::FadeOut

protected

Definition at line 82 of file vtkImplicitHalo.h.

The documentation for this class was generated from the following file:

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkImplicitHalo.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation