vtkSpheres Class Reference

implicit function for a set of spheres More...

#include <vtkSpheres.h>

Inheritance diagram for vtkSpheres:

Collaboration diagram for vtkSpheres:

Public Member Functions
void	EvaluateGradient (double x[3], double n[3]) override
	Evaluate spheres gradient. More...
int	GetNumberOfSpheres ()
	Return the number of spheres in the set of spheres. More...
vtkSphere *	GetSphere (int i)
	Create and return a pointer to a vtkSphere object at the ith position. More...
void	GetSphere (int i, vtkSphere *sphere)
	If i is within the allowable range, mutates the given sphere's Center and Radius to match the vtkSphere object at the ith position. More...
double	EvaluateFunction (double x[3]) override
	Evaluate function at position x-y-z and return value. More...
virtual void	SetCenters (vtkPoints *)
	Specify a list of points defining sphere centers. More...
virtual vtkPoints *	GetCenters ()
	Specify a list of points defining sphere centers. More...
void	SetRadii (vtkDataArray *radii)
	Specify a list of radii for the spheres. More...
virtual vtkDataArray *	GetRadii ()
	Specify a list of radii for the spheres. More...
Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunction *	NewInstance () 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])
	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 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)
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. 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...
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)
	This method invokes an event and return whether the event was aborted or not. More...
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	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...
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...

Protected Member Functions
	vtkSpheres ()
	~vtkSpheres () 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 ()
	These methods allow a command to exclusively grab all events. More...
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
vtkPoints *	Centers
vtkDataArray *	Radii
vtkSphere *	Sphere
Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransform *	Transform
double	ReturnValue [3]
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers
typedef vtkImplicitFunction	Superclass
	Standard methods for instantiation, type information, and printing. More...
static vtkSpheres *	New ()
	Standard methods for instantiation, type information, and printing. More...
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instantiation, type information, and printing. More...
static vtkSpheres *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instantiation, type information, and printing. More...
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instantiation, type information, and printing. More...
vtkSpheres *	NewInstance () const
	Standard methods for instantiation, type information, and printing. More...
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instantiation, type information, and printing. More...
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instantiation, type information, and printing. More...

Additional Inherited Members
Public Types inherited from vtkImplicitFunction
typedef vtkObject	Superclass
Static Public Member Functions inherited from vtkImplicitFunction
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 (int 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 int	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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Detailed Description

implicit function for a set of spheres

vtkSpheres computes the implicit function and function gradient for a set of spheres. The spheres are combined via a union operation (i.e., the minimum value from the evaluation of all spheres is taken).

The function value is the distance of a point to the closest sphere, with negative values interior to the spheres, positive outside the spheres, and distance=0 on the spheres surface. The function gradient is the sphere normal at the function value.

See also

vtkPlanes vtkImplicitBoolean

Definition at line 42 of file vtkSpheres.h.

Member Typedef Documentation

typedef vtkImplicitFunction vtkSpheres::Superclass

Standard methods for instantiation, type information, and printing.

Definition at line 50 of file vtkSpheres.h.

Constructor & Destructor Documentation

vtkSpheres::vtkSpheres ( )

protected

vtkSpheres::~vtkSpheres ( )

overrideprotected

Member Function Documentation

static vtkSpheres* vtkSpheres::New ( )

static

Standard methods for instantiation, type information, and printing.

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

static

Standard methods for instantiation, type information, and printing.

virtual vtkTypeBool vtkSpheres::IsA ( const char *  type )

virtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkImplicitFunction.

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

static

Standard methods for instantiation, type information, and printing.

virtual vtkObjectBase* vtkSpheres::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkImplicitFunction.

vtkSpheres* vtkSpheres::NewInstance

(

)

const

Standard methods for instantiation, type information, and printing.

void vtkSpheres::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkImplicitFunction.

double vtkSpheres::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.

void vtkSpheres::EvaluateGradient ( double  x[3], double  n[3]  )

overridevirtual

Evaluate spheres gradient.

Gradients point towards the outside of the spheres.

Implements vtkImplicitFunction.

virtual void vtkSpheres::SetCenters ( vtkPoints *  )

virtual

Specify a list of points defining sphere centers.

virtual vtkPoints* vtkSpheres::GetCenters ( )

virtual

Specify a list of points defining sphere centers.

void vtkSpheres::SetRadii

(

vtkDataArray *

radii

)

Specify a list of radii for the spheres.

There is a one-to-one correspondence between sphere points and sphere radii.

virtual vtkDataArray* vtkSpheres::GetRadii ( )

virtual

Specify a list of radii for the spheres.

There is a one-to-one correspondence between sphere points and sphere radii.

int vtkSpheres::GetNumberOfSpheres

(

)

Return the number of spheres in the set of spheres.

vtkSphere* vtkSpheres::GetSphere

(

int

i

)

Create and return a pointer to a vtkSphere object at the ith position.

Asking for a sphere outside the allowable range returns nullptr. This method always returns the same object. Alternatively use GetSphere(int i, vtkSphere *sphere) to update a user supplied sphere.

void vtkSpheres::GetSphere	(	int	i,
		vtkSphere *	sphere
	)

If i is within the allowable range, mutates the given sphere's Center and Radius to match the vtkSphere object at the ith position.

Does nothing if i is outside the allowable range.

Member Data Documentation

vtkPoints* vtkSpheres::Centers

protected

Definition at line 110 of file vtkSpheres.h.

vtkDataArray* vtkSpheres::Radii

protected

Definition at line 111 of file vtkSpheres.h.

vtkSphere* vtkSpheres::Sphere

protected

Definition at line 112 of file vtkSpheres.h.

---

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

• /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Common/DataModel/vtkSpheres.h