VTK
9.1.0
|
abstract interface for implicit functions More...
#include <vtkImplicitFunction.h>
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. | |
vtkImplicitFunction * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
vtkMTimeType | GetMTime () override |
Overload standard modified time function. | |
virtual void | EvaluateGradient (double x[3], double g[3])=0 |
Evaluate function gradient at position x-y-z and pass back vector. | |
virtual void | FunctionValue (vtkDataArray *input, vtkDataArray *output) |
Evaluate function at position x-y-z and return value. | |
double | FunctionValue (const double x[3]) |
Evaluate function at position x-y-z and return value. | |
double | FunctionValue (double x, double y, double z) |
Evaluate function at position x-y-z and return value. | |
void | FunctionGradient (const double x[3], double g[3]) |
Evaluate function gradient at position x-y-z and pass back vector. | |
double * | FunctionGradient (const double x[3]) |
Evaluate function gradient at position x-y-z and pass back vector. | |
double * | FunctionGradient (double x, double y, double z) |
Evaluate function gradient at position x-y-z and pass back vector. | |
virtual void | SetTransform (vtkAbstractTransform *) |
Set/Get a transformation to apply to input points before executing the implicit function. | |
virtual void | SetTransform (const double elements[16]) |
Set/Get a transformation to apply to input points before executing the implicit function. | |
virtual vtkAbstractTransform * | GetTransform () |
Set/Get a transformation to apply to input points before executing the implicit function. | |
virtual double | EvaluateFunction (double x[3])=0 |
Evaluate function at position x-y-z and return value. | |
virtual void | EvaluateFunction (vtkDataArray *input, vtkDataArray *output) |
Evaluate function at position x-y-z and return value. | |
virtual double | EvaluateFunction (double x, double y, double z) |
Evaluate function at position x-y-z and return value. | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
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. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. | |
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. | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkImplicitFunction * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
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. | |
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () 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. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkAbstractTransform * | Transform |
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 |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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.
Definition at line 79 of file vtkImplicitFunction.h.
Definition at line 82 of file vtkImplicitFunction.h.
|
protected |
|
overrideprotected |
|
static |
|
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 vtkBox, vtkCone, vtkCylinder, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitHalo, vtkImplicitSelectionLoop, vtkImplicitSum, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPerlinNoise, vtkPlane, vtkPlanes, vtkPlanesIntersection, vtkPolyPlane, vtkQuadric, vtkSphere, vtkSpheres, vtkSuperquadric, vtkImplicitPolyDataDistance, and vtkImplicitProjectOnPlaneDistance.
|
static |
|
protectedvirtual |
Reimplemented in vtkBox, vtkCone, vtkCylinder, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitHalo, vtkImplicitSelectionLoop, vtkImplicitSum, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPerlinNoise, vtkPlane, vtkPlanes, vtkPlanesIntersection, vtkPolyPlane, vtkQuadric, vtkSphere, vtkSpheres, vtkSuperquadric, vtkImplicitPolyDataDistance, and vtkImplicitProjectOnPlaneDistance.
vtkImplicitFunction * vtkImplicitFunction::NewInstance | ( | ) | const |
|
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 vtkImplicitHalo, vtkImplicitSelectionLoop, vtkImplicitSum, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPerlinNoise, vtkPlane, vtkPlanes, vtkPlanesIntersection, vtkPolyPlane, vtkQuadric, vtkSphere, vtkSpheres, vtkSuperquadric, vtkImplicitPolyDataDistance, and vtkImplicitProjectOnPlaneDistance.
|
overridevirtual |
Overload standard modified time function.
If Transform is modified, then this object is modified as well.
Reimplemented from vtkObject.
Reimplemented in vtkImplicitSelectionLoop, vtkImplicitSum, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPolyPlane, vtkImplicitPolyDataDistance, and vtkImplicitProjectOnPlaneDistance.
|
virtual |
Evaluate function at position x-y-z and return value.
Point x[3] is transformed through transform (if provided).
double vtkImplicitFunction::FunctionValue | ( | const double | x[3] | ) |
Evaluate function at position x-y-z and return value.
Point x[3] is transformed through transform (if provided).
|
inline |
Evaluate function at position x-y-z and return value.
Point x[3] is transformed through transform (if provided).
Definition at line 98 of file vtkImplicitFunction.h.
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).
|
inline |
Evaluate function gradient at position x-y-z and pass back vector.
Point x[3] is transformed through transform (if provided).
Definition at line 111 of file vtkImplicitFunction.h.
|
inline |
Evaluate function gradient at position x-y-z and pass back vector.
Point x[3] is transformed through transform (if provided).
Definition at line 116 of file vtkImplicitFunction.h.
|
virtual |
Set/Get a transformation to apply to input points before executing the implicit function.
|
virtual |
Set/Get a transformation to apply to input points before executing the implicit function.
|
virtual |
Set/Get a transformation to apply to input points before executing the implicit function.
|
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 vtkBox, vtkCone, vtkCylinder, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitHalo, vtkImplicitSelectionLoop, vtkImplicitSum, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPerlinNoise, vtkPlane, vtkPlanes, vtkPolyPlane, vtkQuadric, vtkSphere, vtkSpheres, vtkSuperquadric, vtkImplicitPolyDataDistance, vtkImplicitProjectOnPlaneDistance, vtkBox, vtkCone, vtkCylinder, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitHalo, vtkImplicitSelectionLoop, vtkImplicitSum, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPerlinNoise, vtkPlane, vtkPlanes, vtkPolyPlane, vtkQuadric, vtkSphere, vtkSpheres, vtkSuperquadric, vtkImplicitPolyDataDistance, and vtkImplicitProjectOnPlaneDistance.
|
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.
Reimplemented in vtkBox, vtkCone, vtkCylinder, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitHalo, vtkImplicitSelectionLoop, vtkImplicitSum, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPerlinNoise, vtkPlane, vtkPlanes, vtkPolyPlane, vtkQuadric, vtkSphere, vtkSpheres, vtkSuperquadric, vtkImplicitPolyDataDistance, vtkImplicitProjectOnPlaneDistance, and vtkPlane.
|
inlinevirtual |
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.
Reimplemented in vtkBox, vtkCone, vtkCylinder, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitHalo, vtkImplicitSelectionLoop, vtkImplicitSum, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPerlinNoise, vtkPlane, vtkPlanes, vtkPolyPlane, vtkQuadric, vtkSphere, vtkSpheres, vtkSuperquadric, vtkImplicitPolyDataDistance, and vtkImplicitProjectOnPlaneDistance.
Definition at line 142 of file vtkImplicitFunction.h.
|
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 vtkCone, vtkCylinder, vtkImplicitBoolean, vtkImplicitHalo, vtkImplicitSum, vtkPlane, vtkPolyPlane, vtkQuadric, vtkSuperquadric, vtkImplicitPolyDataDistance, vtkImplicitProjectOnPlaneDistance, vtkBox, vtkImplicitDataSet, vtkImplicitSelectionLoop, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPerlinNoise, vtkPlanes, vtkSphere, and vtkSpheres.
|
protected |
Definition at line 161 of file vtkImplicitFunction.h.
|
protected |
Definition at line 162 of file vtkImplicitFunction.h.