VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImplicitHalo Class Reference

implicit function for an halo More...

#include <vtkImplicitHalo.h>

Inherits vtkImplicitFunction.

Public Types

typedef vtkImplicitFunction Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkImplicitHaloNewInstance () 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 ()
 

Static Public Member Functions

static vtkImplicitHaloNew ()
 
static int IsTypeOf (const char *type)
 
static vtkImplicitHaloSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImplicitHalo ()
 
virtual ~vtkImplicitHalo ()
 

Protected Attributes

double Radius
 
double Center [3]
 
double FadeOut
 

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 *  type)
virtual
static vtkImplicitHalo* vtkImplicitHalo::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkImplicitHalo::NewInstanceInternal ( ) const
protectedvirtual
vtkImplicitHalo* vtkImplicitHalo::NewInstance ( ) const
void vtkImplicitHalo::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual double vtkImplicitHalo::EvaluateFunction ( double  x[3])
virtual

Evaluate the equation.

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] 
)

Evaluate normal. Not implemented.

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: