VTK
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>

Inheritance diagram for vtkImplicitHalo:
[legend]
Collaboration diagram for vtkImplicitHalo:
[legend]

Public Types

typedef vtkImplicitFunction Superclass
 
- Public Types inherited from vtkImplicitFunction
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkImplicitHaloNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
double EvaluateFunction (double x[3]) override
 Evaluate function at position x-y-z and return value. More...
 
void EvaluateGradient (double x[3], double g[3]) override
 Evaluate normal. More...
 
virtual void SetRadius (double)
 Radius of the sphere. More...
 
virtual double GetRadius ()
 
virtual void SetCenter (double, double, double)
 Center of the sphere. More...
 
virtual void SetCenter (double[3])
 
virtual double * GetCenter ()
 
virtual void GetCenter (double &, double &, double &)
 
virtual void GetCenter (double[3])
 
virtual void SetFadeOut (double)
 FadeOut ratio. More...
 
virtual double GetFadeOut ()
 
virtual double EvaluateFunction (double x[3])=0
 Evaluate the equation. More...
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 Evaluate the equation. More...
 
virtual double EvaluateFunction (double x, double y, double z)
 Evaluate the equation. More...
 
- Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunctionNewInstance () const
 
vtkMTimeType GetMTime () override
 Overload standard modified time function. More...
 
virtual void FunctionValue (vtkDataArray *input, vtkDataArray *output)
 Evaluate function at position x-y-z and return value. More...
 
double FunctionValue (const double x[3])
 
double FunctionValue (double x, double y, double z)
 
void FunctionGradient (const double x[3], double g[3])
 Evaluate function gradient at position x-y-z and pass back vector. More...
 
double * FunctionGradient (const double x[3])
 
double * FunctionGradient (double x, double y, double z)
 
virtual void SetTransform (vtkAbstractTransform *)
 Set/Get a transformation to apply to input points before executing the implicit function. More...
 
virtual void SetTransform (const double elements[16])
 
virtual vtkAbstractTransformGetTransform ()
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 
virtual double EvaluateFunction (double x, double y, double z)
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkImplicitHaloNew ()
 Center=(0.0,0.0,0.0), Radius=1.0, FadeOut=0.01. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImplicitHaloSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImplicitFunction
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImplicitFunctionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImplicitHalo ()
 
 ~vtkImplicitHalo () override
 
- Protected Member Functions inherited from vtkImplicitFunction
 vtkImplicitFunction ()
 
 ~vtkImplicitFunction () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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
vtkAbstractTransformTransform
 
double ReturnValue [3]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > 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 38 of file vtkImplicitHalo.h.

Member Typedef Documentation

◆ Superclass

Definition at line 46 of file vtkImplicitHalo.h.

Constructor & Destructor Documentation

◆ vtkImplicitHalo()

vtkImplicitHalo::vtkImplicitHalo ( )
protected

◆ ~vtkImplicitHalo()

vtkImplicitHalo::~vtkImplicitHalo ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkImplicitHalo* vtkImplicitHalo::New ( )
static

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

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImplicitHalo::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImplicitFunction.

◆ NewInstance()

vtkImplicitHalo* vtkImplicitHalo::NewInstance ( ) const

◆ PrintSelf()

void vtkImplicitHalo::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ EvaluateFunction() [1/4]

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

Evaluate function at position x-y-z and return value.

You should generally not call this method directly, you should use FunctionValue() instead. This method must be implemented by any derived class.

Implements vtkImplicitFunction.

◆ EvaluateGradient()

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

Evaluate normal.

Not implemented.

Implements vtkImplicitFunction.

◆ SetRadius()

virtual void vtkImplicitHalo::SetRadius ( double  )
virtual

Radius of the sphere.

◆ GetRadius()

virtual double vtkImplicitHalo::GetRadius ( )
virtual

◆ SetCenter() [1/2]

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

Center of the sphere.

◆ SetCenter() [2/2]

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

◆ GetCenter() [1/3]

virtual double* vtkImplicitHalo::GetCenter ( )
virtual

◆ GetCenter() [2/3]

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

◆ GetCenter() [3/3]

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

◆ SetFadeOut()

virtual void vtkImplicitHalo::SetFadeOut ( double  )
virtual

FadeOut ratio.

Valid values are between 0.0 and 1.0.

◆ GetFadeOut()

virtual double vtkImplicitHalo::GetFadeOut ( )
virtual

◆ EvaluateFunction() [2/4]

virtual double vtkImplicitFunction::EvaluateFunction

Evaluate the equation.

◆ EvaluateFunction() [3/4]

virtual void vtkImplicitFunction::EvaluateFunction

Evaluate the equation.

◆ EvaluateFunction() [4/4]

virtual double vtkImplicitFunction::EvaluateFunction
inline

Evaluate the equation.

Definition at line 123 of file vtkImplicitFunction.h.

Member Data Documentation

◆ Radius

double vtkImplicitHalo::Radius
protected

Definition at line 90 of file vtkImplicitHalo.h.

◆ Center

double vtkImplicitHalo::Center[3]
protected

Definition at line 91 of file vtkImplicitHalo.h.

◆ FadeOut

double vtkImplicitHalo::FadeOut
protected

Definition at line 92 of file vtkImplicitHalo.h.


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