vtkSphere Class Reference

implicit function for a sphere More...

#include <vtkSphere.h>

Inheritance diagram for vtkSphere:

Collaboration diagram for vtkSphere:

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.
vtkSphere *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	EvaluateGradient (double x[3], double n[3]) override
	Evaluate sphere gradient.
double	EvaluateFunction (double x[3]) override
	Evaluate sphere equation ((x-x0)^2 + (y-y0)^2 + (z-z0)^2) - R^2.
virtual double	EvaluateFunction (double x[3])=0
	Evaluate sphere equation ((x-x0)^2 + (y-y0)^2 + (z-z0)^2) - R^2.
virtual void	EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
	Evaluate sphere equation ((x-x0)^2 + (y-y0)^2 + (z-z0)^2) - R^2.
virtual double	EvaluateFunction (double x, double y, double z)
	Evaluate sphere equation ((x-x0)^2 + (y-y0)^2 + (z-z0)^2) - R^2.
virtual void	SetRadius (double)
	Set / get the radius of the sphere.
virtual double	GetRadius ()
	Set / get the radius of the sphere.
virtual void	SetCenter (double, double, double)
	Set / get the center of the sphere.
virtual void	SetCenter (double[3])
	Set / get the center of the sphere.
virtual double *	GetCenter ()
	Set / get the center of the sphere.
virtual void	GetCenter (double data[3])
	Set / get the center of the sphere.
Public Member Functions inherited from vtkImplicitFunction
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.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
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.
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.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkSphere *	SafeDownCast (vtkObjectBase *o)
static vtkSphere *	New ()
	Construct sphere with center at (0,0,0) and radius=0.5.
static double	Evaluate (double center[3], double R, double x[3])
	Quick evaluation of the sphere equation ((x-x0)^2 + (y-y0)^2 + (z-z0)^2) - R^2.
static void	ComputeBoundingSphere (float *pts, vtkIdType numPts, float sphere[4], vtkIdType hints[2])
	Create a bounding sphere from a set of points.
static void	ComputeBoundingSphere (double *pts, vtkIdType numPts, double sphere[4], vtkIdType hints[2])
	Create a bounding sphere from a set of points.
static void	ComputeBoundingSphere (float **spheres, vtkIdType numSpheres, float sphere[4], vtkIdType hints[2])
	Create a bounding sphere from a set of spheres.
static void	ComputeBoundingSphere (double **spheres, vtkIdType numSpheres, double sphere[4], vtkIdType hints[2])
	Create a bounding sphere from a set of spheres.
static void	ComputeBoundingSphere (double *pts, vtkIdType numPts, double sphere[4])
	Create a bounding sphere from a set of points.
static void	ComputeBoundingSphere (float *pts, vtkIdType numPts, float sphere[4])
	Create a bounding sphere from a set of points.
static void	ComputeBoundingSphere (float **spheres, vtkIdType numSpheres, float sphere[4])
	Create a bounding sphere from a set of spheres.
static void	ComputeBoundingSphere (double **spheres, vtkIdType numSpheres, double sphere[4])
	Create a bounding sphere from a set of spheres.
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool 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 vtkTypeBool	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
	vtkSphere ()
	~vtkSphere () override=default
Protected Member Functions inherited from vtkImplicitFunction
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 *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
double	Radius
double	Center [3]
Protected Attributes inherited from vtkImplicitFunction
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

implicit function for a sphere

vtkSphere computes the implicit function and/or gradient for a sphere. vtkSphere is a concrete implementation of vtkImplicitFunction. Additional methods are available for sphere-related computations, such as computing bounding spheres for a set of points, or set of spheres.

Online Examples:

ImplicitBoolean

ImplicitBooleanDemo

ImplicitSphere

TissueLens

DiscreteMarchingCubes

ExtractPointsDemo

FitImplicitFunction

IsosurfaceSampling

ExtractData

SphereWidget2

Tests:

vtkSphere (Tests)

Definition at line 132 of file vtkSphere.h.

Member Typedef Documentation

Superclass

typedef vtkImplicitFunction vtkSphere::Superclass

Definition at line 135 of file vtkSphere.h.

Constructor & Destructor Documentation

vtkSphere()

vtkSphere::vtkSphere ( )

protected

~vtkSphere()

vtkSphere::~vtkSphere ( )

overrideprotecteddefault

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkSphere::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 vtkSphere * vtkSphere::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkSphere::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImplicitFunction.

NewInstance()

vtkSphere * vtkSphere::NewInstance

(

)

const

PrintSelf()

void vtkSphere::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.

New()

static vtkSphere * vtkSphere::New ( )

static

Construct sphere with center at (0,0,0) and radius=0.5.

EvaluateFunction() [1/4]

double vtkSphere::EvaluateFunction ( double  x[3] )

overridevirtual

Evaluate sphere equation ((x-x0)^2 + (y-y0)^2 + (z-z0)^2) - R^2.

Implements vtkImplicitFunction.

EvaluateGradient()

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

overridevirtual

Evaluate sphere gradient.

Implements vtkImplicitFunction.

SetRadius()

virtual void vtkSphere::SetRadius ( double  )

virtual

Set / get the radius of the sphere.

The default is 0.5.

GetRadius()

virtual double vtkSphere::GetRadius ( )

virtual

Set / get the radius of the sphere.

The default is 0.5.

SetCenter() [1/2]

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

virtual

Set / get the center of the sphere.

The default is (0,0,0).

SetCenter() [2/2]

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

virtual

Set / get the center of the sphere.

The default is (0,0,0).

GetCenter() [1/2]

virtual double * vtkSphere::GetCenter ( )

virtual

Set / get the center of the sphere.

The default is (0,0,0).

GetCenter() [2/2]

virtual void vtkSphere::GetCenter ( double  data[3] )

virtual

Set / get the center of the sphere.

The default is (0,0,0).

Evaluate()

static double vtkSphere::Evaluate ( double  center[3], double  R, double  x[3]  )

inlinestatic

Quick evaluation of the sphere equation ((x-x0)^2 + (y-y0)^2 + (z-z0)^2) - R^2.

Definition at line 175 of file vtkSphere.h.

ComputeBoundingSphere() [1/8]

static void vtkSphere::ComputeBoundingSphere ( float *  pts, vtkIdType  numPts, float  sphere[4], vtkIdType  hints[2]  )

static

Create a bounding sphere from a set of points.

The set of points is defined by an array of doubles, in the order of x-y-z (which repeats for each point). An optional hints array provides a guess for the initial bounding sphere; the two values in the hints array are the two points expected to be the furthest apart. The output sphere consists of a center (x-y-z) and a radius.

ComputeBoundingSphere() [2/8]

static void vtkSphere::ComputeBoundingSphere ( double *  pts, vtkIdType  numPts, double  sphere[4], vtkIdType  hints[2]  )

static

Create a bounding sphere from a set of points.

The set of points is defined by an array of doubles, in the order of x-y-z (which repeats for each point). An optional hints array provides a guess for the initial bounding sphere; the two values in the hints array are the two points expected to be the furthest apart. The output sphere consists of a center (x-y-z) and a radius.

ComputeBoundingSphere() [3/8]

static void vtkSphere::ComputeBoundingSphere ( float **  spheres, vtkIdType  numSpheres, float  sphere[4], vtkIdType  hints[2]  )

static

Create a bounding sphere from a set of spheres.

The set of input spheres is defined by an array of pointers to spheres. Each sphere is defined by the 4-tuple: center(x-y-z)+radius. An optional hints array provides a guess for the initial bounding sphere; the two values in the hints array are the two spheres expected to be the furthest apart. The output sphere consists of a center (x-y-z) and a radius.

ComputeBoundingSphere() [4/8]

static void vtkSphere::ComputeBoundingSphere ( double **  spheres, vtkIdType  numSpheres, double  sphere[4], vtkIdType  hints[2]  )

static

Create a bounding sphere from a set of spheres.

The set of input spheres is defined by an array of pointers to spheres. Each sphere is defined by the 4-tuple: center(x-y-z)+radius. An optional hints array provides a guess for the initial bounding sphere; the two values in the hints array are the two spheres expected to be the furthest apart. The output sphere consists of a center (x-y-z) and a radius.

ComputeBoundingSphere() [5/8]

static void vtkSphere::ComputeBoundingSphere ( double *  pts, vtkIdType  numPts, double  sphere[4]  )

inlinestatic

Create a bounding sphere from a set of points.

The set of points is defined by an array of doubles or an array of floats, in the order of x-y-z (which repeats for each point). The output sphere consists of a center (x-y-z) and a radius.

Definition at line 218 of file vtkSphere.h.

ComputeBoundingSphere() [6/8]

static void vtkSphere::ComputeBoundingSphere ( float *  pts, vtkIdType  numPts, float  sphere[4]  )

inlinestatic

Create a bounding sphere from a set of points.

The set of points is defined by an array of doubles or an array of floats, in the order of x-y-z (which repeats for each point). The output sphere consists of a center (x-y-z) and a radius.

Definition at line 222 of file vtkSphere.h.

ComputeBoundingSphere() [7/8]

static void vtkSphere::ComputeBoundingSphere ( float **  spheres, vtkIdType  numSpheres, float  sphere[4]  )

inlinestatic

Create a bounding sphere from a set of spheres.

The set of input spheres is defined by an array of pointers to spheres. Each sphere is defined by the 4-tuple: center(x-y-z)+radius. The output sphere consists of a center (x-y-z) and a radius.

Definition at line 235 of file vtkSphere.h.

ComputeBoundingSphere() [8/8]

static void vtkSphere::ComputeBoundingSphere ( double **  spheres, vtkIdType  numSpheres, double  sphere[4]  )

inlinestatic

Create a bounding sphere from a set of spheres.

The set of input spheres is defined by an array of pointers to spheres. Each sphere is defined by the 4-tuple: center(x-y-z)+radius. The output sphere consists of a center (x-y-z) and a radius.

Definition at line 239 of file vtkSphere.h.

EvaluateFunction() [2/4]

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

virtual

Evaluate sphere equation ((x-x0)^2 + (y-y0)^2 + (z-z0)^2) - R^2.

Implements vtkImplicitFunction.

EvaluateFunction() [3/4]

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

virtual

Evaluate sphere equation ((x-x0)^2 + (y-y0)^2 + (z-z0)^2) - R^2.

Reimplemented from vtkImplicitFunction.

EvaluateFunction() [4/4]

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

inlinevirtual

Evaluate sphere equation ((x-x0)^2 + (y-y0)^2 + (z-z0)^2) - R^2.

Reimplemented from vtkImplicitFunction.

Definition at line 131 of file vtkImplicitFunction.h.

Member Data Documentation

Radius

double vtkSphere::Radius

protected

Definition at line 249 of file vtkSphere.h.

Center

double vtkSphere::Center[3]

protected

Definition at line 250 of file vtkSphere.h.

---

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

• Common/DataModel/vtkSphere.h