vtkImplicitHalo Class Reference
#include <vtkImplicitHalo.h>
Detailed Description
implicit function for an halovtkImplicitHalo 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 36 of file vtkImplicitHalo.h.
Public Types | |
| typedef vtkImplicitFunction | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| 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 vtkImplicitHalo * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkImplicitHalo * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkImplicitHalo () | |
| virtual | ~vtkImplicitHalo () |
Protected Attributes | |
| double | Radius |
| double | Center [3] |
| double | FadeOut |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkImplicitHalo::vtkImplicitHalo | ( | ) | [protected] |
| virtual vtkImplicitHalo::~vtkImplicitHalo | ( | ) | [protected, virtual] |
Member Function Documentation
| static vtkImplicitHalo* vtkImplicitHalo::New | ( | ) | [static] |
Center=(0.0,0.0,0.0), Radius=1.0, FadeOut=0.01
Reimplemented from vtkObject.
| virtual const char* vtkImplicitHalo::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkImplicitFunction.
| static int vtkImplicitHalo::IsTypeOf | ( | const char * | name | ) | [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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkImplicitFunction.
| 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 | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkImplicitFunction.
| 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 | |||
| ) | [inline, virtual] |
Evaluate the equation.
Reimplemented from vtkImplicitFunction.
Definition at line 48 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 79 of file vtkImplicitHalo.h.
double vtkImplicitHalo::Center[3] [protected] |
Definition at line 80 of file vtkImplicitHalo.h.
double vtkImplicitHalo::FadeOut [protected] |
Definition at line 81 of file vtkImplicitHalo.h.
The documentation for this class was generated from the following file:
- dox/Filtering/vtkImplicitHalo.h
