abstract interface for implicit functions More...

#include <vtkImplicitFunction.h>

Inheritance diagram for vtkImplicitFunction:

Collaboration diagram for vtkImplicitFunction:

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

vtkImplicitFunction *	NewInstance () 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	EvaluateGradient (double x[3], double g[3])=0
	Evaluate function gradient at position x-y-z and pass back vector. 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])
	Evaluate function at position x-y-z and return value. More...

double	FunctionValue (double x, double y, double z)
	Evaluate function at position x-y-z and return value. More...


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])
	Evaluate function gradient at position x-y-z and pass back vector. More...

double *	FunctionGradient (double x, double y, double z)
	Evaluate function gradient at position x-y-z and pass back vector. More...


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])
	Set/Get a transformation to apply to input points before executing the implicit function. More...

virtual vtkAbstractTransform *	GetTransform ()
	Set/Get a transformation to apply to input points before executing the implicit function. More...


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)
	Evaluate function at position x-y-z and return value. More...

virtual double	EvaluateFunction (double x, double y, double z)
	Evaluate function at position x-y-z and return value. 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...

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output. 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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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...

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

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

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

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

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. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 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). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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. More...

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. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

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

std::string	ObjectName

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

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

Online Examples:

ExtractPointsDemo

Definition at line 68 of file vtkImplicitFunction.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkImplicitFunction::Superclass

Definition at line 71 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 vtkImplicitProjectOnPlaneDistance, vtkImplicitPolyDataDistance, vtkSuperquadric, vtkSpheres, vtkSphere, vtkQuadric, vtkPolyPlane, vtkPlanesIntersection, vtkPlanes, vtkPlane, vtkPerlinNoise, vtkImplicitWindowFunction, vtkImplicitVolume, vtkImplicitSum, vtkImplicitSelectionLoop, vtkImplicitHalo, vtkImplicitDataSet, vtkImplicitBoolean, vtkCylinder, vtkCoordinateFrame, vtkCone, and vtkBox.

◆ 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 vtkImplicitProjectOnPlaneDistance, vtkImplicitPolyDataDistance, vtkSuperquadric, vtkSpheres, vtkSphere, vtkQuadric, vtkPolyPlane, vtkPlanesIntersection, vtkPlanes, vtkPlane, vtkPerlinNoise, vtkImplicitWindowFunction, vtkImplicitVolume, vtkImplicitSum, vtkImplicitSelectionLoop, and vtkImplicitHalo.

◆ 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 vtkImplicitProjectOnPlaneDistance, vtkImplicitPolyDataDistance, vtkPolyPlane, vtkImplicitWindowFunction, vtkImplicitVolume, vtkImplicitSum, and vtkImplicitSelectionLoop.

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

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

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

◆ FunctionValue() [3/3]

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

inline

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

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

Definition at line 87 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

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

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

Definition at line 100 of file vtkImplicitFunction.h.

◆ FunctionGradient() [3/3]

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

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

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

◆ GetTransform()

virtual vtkAbstractTransform* vtkImplicitFunction::GetTransform ( )

virtual

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

◆ 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 vtkImplicitProjectOnPlaneDistance, vtkImplicitPolyDataDistance, vtkSuperquadric, vtkSpheres, vtkSphere, vtkQuadric, vtkPolyPlane, vtkPlanes, vtkPlane, vtkPerlinNoise, vtkImplicitWindowFunction, vtkImplicitVolume, vtkImplicitSum, vtkImplicitSelectionLoop, vtkImplicitHalo, vtkImplicitDataSet, vtkImplicitBoolean, vtkCylinder, vtkCoordinateFrame, vtkCone, and vtkBox.

◆ EvaluateFunction() [2/3]

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

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 vtkPlane.

◆ EvaluateFunction() [3/3]

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

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.

Definition at line 131 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 vtkSpheres, vtkSphere, vtkPlanes, vtkPerlinNoise, vtkImplicitWindowFunction, vtkImplicitVolume, vtkImplicitSelectionLoop, vtkImplicitDataSet, vtkCoordinateFrame, vtkBox, vtkImplicitProjectOnPlaneDistance, vtkImplicitPolyDataDistance, vtkSuperquadric, vtkQuadric, vtkPolyPlane, vtkPlane, vtkImplicitSum, vtkImplicitHalo, vtkImplicitBoolean, vtkCylinder, and vtkCone.

Member Data Documentation

◆ Transform

vtkAbstractTransform* vtkImplicitFunction::Transform

protected

Definition at line 150 of file vtkImplicitFunction.h.

◆ ReturnValue

double vtkImplicitFunction::ReturnValue[3]

protected

Definition at line 151 of file vtkImplicitFunction.h.

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

Common/DataModel/vtkImplicitFunction.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkImplicitFunction()

◆ ~vtkImplicitFunction()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetMTime()

◆ FunctionValue() [1/3]

◆ FunctionValue() [2/3]

◆ FunctionValue() [3/3]

◆ FunctionGradient() [1/3]

◆ FunctionGradient() [2/3]

◆ FunctionGradient() [3/3]

◆ SetTransform() [1/2]

◆ SetTransform() [2/2]

◆ GetTransform()

◆ EvaluateFunction() [1/3]

◆ EvaluateFunction() [2/3]

◆ EvaluateFunction() [3/3]

◆ EvaluateGradient()

Member Data Documentation

◆ Transform

◆ ReturnValue