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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkSphere *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

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


double	EvaluateFunction (double x[3])

double	EvaluateFunction (double x, double y, double z)


virtual void	SetRadius (double)

virtual double	GetRadius ()


virtual void	SetCenter (double, double, double)

virtual void	SetCenter (double[3])

virtual double *	GetCenter ()

virtual void	GetCenter (double data[3])

Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunction *	NewInstance () const

unsigned long	GetMTime ()

double	FunctionValue (const double x[3])

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

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

double *	FunctionGradient (const double x[3])

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

virtual void	SetTransform (vtkAbstractTransform *)

virtual void	SetTransform (const double elements[16])

virtual vtkAbstractTransform *	GetTransform ()

double	EvaluateFunction (double x, double y, double z)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkSphere *	SafeDownCast (vtkObjectBase *o)

static vtkSphere *	New ()


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

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


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

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

Static Public Member Functions inherited from vtkImplicitFunction
static int	IsTypeOf (const char *type)

static vtkImplicitFunction *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkSphere ()

	~vtkSphere ()

Protected Member Functions inherited from vtkImplicitFunction
	vtkImplicitFunction ()

	~vtkImplicitFunction ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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.

Examples:: vtkSphere (Examples)

Tests:: vtkSphere (Tests)

Definition at line 36 of file vtkSphere.h.

Member Typedef Documentation

typedef vtkImplicitFunction vtkSphere::Superclass

Definition at line 39 of file vtkSphere.h.

Constructor & Destructor Documentation

vtkSphere::vtkSphere ( )

protected

vtkSphere::~vtkSphere ( )

inlineprotected

Definition at line 95 of file vtkSphere.h.

Member Function Documentation

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

static

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

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

static

virtual vtkObjectBase* vtkSphere::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImplicitFunction.

vtkSphere* vtkSphere::NewInstance ( ) const

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

virtual

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.

static vtkSphere* vtkSphere::New ( )

static

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

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

virtual

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

Implements vtkImplicitFunction.

double vtkSphere::EvaluateFunction	(	double	x,
		double	y,
		double	z
	)

inline

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

Definition at line 48 of file vtkSphere.h.

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

virtual

Evaluate sphere gradient.

Implements vtkImplicitFunction.

virtual void vtkSphere::SetRadius ( double )

virtual

Set / get the radius of the sphere. The default is 0.5.

virtual double vtkSphere::GetRadius ( )

virtual

Set / get the radius of the sphere. The default is 0.5.

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

virtual

Set / get the center of the sphere. The default is (0,0,0).

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

virtual

Set / get the center of the sphere. The default is (0,0,0).

virtual double* vtkSphere::GetCenter ( )

virtual

Set / get the center of the sphere. The default is (0,0,0).

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

virtual

Set / get the center of the sphere. The default is (0,0,0).

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.

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.

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.

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.

Member Data Documentation

double vtkSphere::Radius

protected

Definition at line 97 of file vtkSphere.h.

double vtkSphere::Center[3]

protected

Definition at line 98 of file vtkSphere.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkSphere.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation