VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImplicitFunction Class Referenceabstract

abstract interface for implicit functions More...

#include <vtkImplicitFunction.h>

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

Public Types

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...
 
vtkImplicitFunctionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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 double EvaluateFunction (double x[3])=0
 Evaluate function at position x-y-z and return value. More...
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 
virtual double EvaluateFunction (double x, double y, double z)
 
virtual void EvaluateGradient (double x[3], double g[3])=0
 Evaluate function gradient at position x-y-z and pass back vector. More...
 
- 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 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
 
 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

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

abstract interface for implicit functions

vtkImplicitFunction specifies an abstract interface for implicit functions. Implicit functions are real valued functions defined in 3D space, w = F(x,y,z). Two primitive operations are required: the ability to evaluate the function, and the function gradient at a given point. The implicit function divides space into three regions: on the surface (F(x,y,z)=w), outside of the surface (F(x,y,z)>c), and inside the surface (F(x,y,z)<c). (When c is zero, positive values are outside, negative values are inside, and zero is on the surface. Note also that the function gradient points from inside to outside.)

Implicit functions are very powerful. It is possible to represent almost any type of geometry with the level sets w = const, especially if you use boolean combinations of implicit functions (see vtkImplicitBoolean).

vtkImplicitFunction provides a mechanism to transform the implicit function(s) via a vtkAbstractTransform. This capability can be used to translate, orient, scale, or warp implicit functions. For example, a sphere implicit function can be transformed into an oriented ellipse.

Warning
The transformation transforms a point into the space of the implicit function (i.e., the model space). Typically we want to transform the implicit model into world coordinates. In this case the inverse of the transformation is required.
See also
vtkAbstractTransform vtkSphere vtkCylinder vtkImplicitBoolean vtkPlane vtkPlanes vtkQuadric vtkImplicitVolume vtkSampleFunction vtkCutter vtkClipPolyData

Definition at line 60 of file vtkImplicitFunction.h.

Member Typedef Documentation

◆ Superclass

Definition at line 63 of file vtkImplicitFunction.h.

Constructor & Destructor Documentation

◆ vtkImplicitFunction()

vtkImplicitFunction::vtkImplicitFunction ( )
protected

◆ ~vtkImplicitFunction()

vtkImplicitFunction::~vtkImplicitFunction ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkImplicitFunction::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 vtkObjectBase.

Reimplemented in vtkImplicitSelectionLoop, vtkSuperquadric, vtkPlanes, vtkPlanesIntersection, vtkImplicitProjectOnPlaneDistance, vtkImplicitVolume, vtkImplicitPolyDataDistance, vtkImplicitDataSet, vtkSpheres, vtkImplicitBoolean, vtkImplicitHalo, vtkPolyPlane, vtkCone, vtkCylinder, vtkImplicitWindowFunction, vtkBox, vtkPerlinNoise, vtkImplicitSum, vtkPlane, vtkSphere, and vtkQuadric.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImplicitFunction::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkImplicitFunction* vtkImplicitFunction::NewInstance ( ) const

◆ PrintSelf()

void vtkImplicitFunction::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 vtkObject.

Reimplemented in vtkImplicitSelectionLoop, vtkSuperquadric, vtkPlanes, vtkPlanesIntersection, vtkImplicitProjectOnPlaneDistance, vtkImplicitVolume, vtkImplicitPolyDataDistance, vtkSpheres, vtkImplicitHalo, vtkPolyPlane, vtkImplicitWindowFunction, vtkPerlinNoise, vtkImplicitSum, vtkPlane, vtkSphere, and vtkQuadric.

◆ GetMTime()

vtkMTimeType vtkImplicitFunction::GetMTime ( )
overridevirtual

Overload standard modified time function.

If Transform is modified, then this object is modified as well.

Reimplemented from vtkObject.

Reimplemented in vtkImplicitSelectionLoop, vtkImplicitWindowFunction, vtkPolyPlane, vtkImplicitVolume, vtkImplicitSum, vtkImplicitProjectOnPlaneDistance, and vtkImplicitPolyDataDistance.

◆ FunctionValue() [1/3]

virtual void vtkImplicitFunction::FunctionValue ( vtkDataArray input,
vtkDataArray output 
)
virtual

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

Point x[3] is transformed through transform (if provided).

◆ FunctionValue() [2/3]

double vtkImplicitFunction::FunctionValue ( const double  x[3])

◆ FunctionValue() [3/3]

double vtkImplicitFunction::FunctionValue ( double  x,
double  y,
double  z 
)
inline

Definition at line 79 of file vtkImplicitFunction.h.

◆ FunctionGradient() [1/3]

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

Evaluate function gradient at position x-y-z and pass back vector.

Point x[3] is transformed through transform (if provided).

◆ FunctionGradient() [2/3]

double* vtkImplicitFunction::FunctionGradient ( const double  x[3])
inline

Definition at line 92 of file vtkImplicitFunction.h.

◆ FunctionGradient() [3/3]

double* vtkImplicitFunction::FunctionGradient ( double  x,
double  y,
double  z 
)
inline

Definition at line 97 of file vtkImplicitFunction.h.

◆ SetTransform() [1/2]

virtual void vtkImplicitFunction::SetTransform ( vtkAbstractTransform )
virtual

Set/Get a transformation to apply to input points before executing the implicit function.

◆ SetTransform() [2/2]

virtual void vtkImplicitFunction::SetTransform ( const double  elements[16])
virtual

◆ GetTransform()

virtual vtkAbstractTransform* vtkImplicitFunction::GetTransform ( )
virtual

◆ EvaluateFunction() [1/3]

virtual double vtkImplicitFunction::EvaluateFunction ( double  x[3])
pure virtual

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.

Implemented in vtkImplicitSelectionLoop, vtkImplicitVolume, vtkImplicitDataSet, vtkImplicitBoolean, vtkPlanes, vtkImplicitProjectOnPlaneDistance, vtkSuperquadric, vtkImplicitPolyDataDistance, vtkSpheres, vtkCylinder, vtkImplicitWindowFunction, vtkImplicitHalo, vtkPerlinNoise, vtkPolyPlane, vtkBox, vtkCone, vtkImplicitSum, vtkPlane, vtkSphere, and vtkQuadric.

◆ EvaluateFunction() [2/3]

virtual void vtkImplicitFunction::EvaluateFunction ( vtkDataArray input,
vtkDataArray output 
)
virtual

Reimplemented in vtkPlane.

◆ EvaluateFunction() [3/3]

virtual double vtkImplicitFunction::EvaluateFunction ( double  x,
double  y,
double  z 
)
inlinevirtual

Definition at line 123 of file vtkImplicitFunction.h.

◆ EvaluateGradient()

virtual void vtkImplicitFunction::EvaluateGradient ( double  x[3],
double  g[3] 
)
pure virtual

Evaluate function gradient at position x-y-z and pass back vector.

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

Implemented in vtkImplicitSelectionLoop, vtkImplicitVolume, vtkImplicitDataSet, vtkPlanes, vtkSpheres, vtkImplicitWindowFunction, vtkPerlinNoise, vtkBox, vtkSphere, vtkImplicitBoolean, vtkImplicitProjectOnPlaneDistance, vtkImplicitPolyDataDistance, vtkSuperquadric, vtkCylinder, vtkImplicitHalo, vtkPolyPlane, vtkCone, vtkImplicitSum, vtkPlane, and vtkQuadric.

Member Data Documentation

◆ Transform

vtkAbstractTransform* vtkImplicitFunction::Transform
protected

Definition at line 142 of file vtkImplicitFunction.h.

◆ ReturnValue

double vtkImplicitFunction::ReturnValue[3]
protected

Definition at line 143 of file vtkImplicitFunction.h.


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