VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSphere Class Reference

implicit function for a sphere More...

#include <vtkSphere.h>

Inheritance diagram for vtkSphere:
[legend]
Collaboration diagram for vtkSphere:
[legend]

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. More...
 
vtkSphereNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
double EvaluateFunction (double x[3]) override
 Evaluate function at position x-y-z and return value. More...
 
void EvaluateGradient (double x[3], double n[3]) override
 Evaluate sphere gradient. More...
 
virtual void SetRadius (double)
 Set / get the radius of the sphere. More...
 
virtual double GetRadius ()
 
virtual void SetCenter (double, double, double)
 Set / get the center of the sphere. More...
 
virtual void SetCenter (double[3])
 
virtual double * GetCenter ()
 
virtual void GetCenter (double data[3])
 
virtual double EvaluateFunction (double x[3])=0
 Evaluate sphere equation ((x-x0)^2 + (y-y0)^2 + (z-z0)^2) - R^2. More...
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 Evaluate sphere equation ((x-x0)^2 + (y-y0)^2 + (z-z0)^2) - R^2. More...
 
virtual double EvaluateFunction (double x, double y, double z)
 Evaluate sphere equation ((x-x0)^2 + (y-y0)^2 + (z-z0)^2) - R^2. More...
 
- Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunctionNewInstance () 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])
 
double FunctionValue (double x, double y, double z)
 
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])
 
double * FunctionGradient (double x, double y, double z)
 
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])
 
virtual vtkAbstractTransformGetTransform ()
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 
virtual double EvaluateFunction (double x, double y, double z)
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSphereSafeDownCast (vtkObjectBase *o)
 
static vtkSphereNew ()
 Construct sphere with center at (0,0,0) and radius=0.5. More...
 
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. More...
 
static void ComputeBoundingSphere (float *pts, vtkIdType numPts, float sphere[4], vtkIdType hints[2])
 Create a bounding sphere from a set of points. More...
 
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])
 Create a bounding sphere from a set of spheres. More...
 
static void ComputeBoundingSphere (double **spheres, vtkIdType numSpheres, double sphere[4], vtkIdType hints[2])
 
- Static Public Member Functions inherited from vtkImplicitFunction
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImplicitFunctionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkSphere ()
 
 ~vtkSphere () 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 ()
 
- 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
vtkAbstractTransformTransform
 
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
 

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.

Definition at line 31 of file vtkSphere.h.

Member Typedef Documentation

◆ Superclass

Definition at line 34 of file vtkSphere.h.

Constructor & Destructor Documentation

◆ vtkSphere()

vtkSphere::vtkSphere ( )
protected

◆ ~vtkSphere()

vtkSphere::~vtkSphere ( )
inlineoverrideprotected

Definition at line 112 of file vtkSphere.h.

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

◆ 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

◆ 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

◆ GetCenter() [1/2]

virtual double* vtkSphere::GetCenter ( )
virtual

◆ GetCenter() [2/2]

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

◆ 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 74 of file vtkSphere.h.

◆ ComputeBoundingSphere() [1/4]

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/4]

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

◆ ComputeBoundingSphere() [3/4]

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/4]

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

◆ EvaluateFunction() [2/4]

virtual double vtkImplicitFunction::EvaluateFunction

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

◆ EvaluateFunction() [3/4]

virtual void vtkImplicitFunction::EvaluateFunction

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

◆ EvaluateFunction() [4/4]

virtual double vtkImplicitFunction::EvaluateFunction
inline

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

Definition at line 123 of file vtkImplicitFunction.h.

Member Data Documentation

◆ Radius

double vtkSphere::Radius
protected

Definition at line 114 of file vtkSphere.h.

◆ Center

double vtkSphere::Center[3]
protected

Definition at line 115 of file vtkSphere.h.


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