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

implicit function for a set of spheres More...

#include <vtkSpheres.h>

Inheritance diagram for vtkSpheres:
[legend]
Collaboration diagram for vtkSpheres:
[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...
 
vtkSpheresNewInstance () 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 spheres gradient. More...
 
virtual void SetCenters (vtkPoints *)
 Specify a list of points defining sphere centers. More...
 
virtual vtkPointsGetCenters ()
 
void SetRadii (vtkDataArray *radii)
 Specify a list of radii for the spheres. More...
 
virtual vtkDataArrayGetRadii ()
 
int GetNumberOfSpheres ()
 Return the number of spheres in the set of spheres. More...
 
vtkSphereGetSphere (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...
 
virtual double EvaluateFunction (double x[3])=0
 Evaluate spheres equations. More...
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 Evaluate spheres equations. More...
 
virtual double EvaluateFunction (double x, double y, double z)
 Evaluate spheres equations. 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 vtkSpheresNew ()
 Standard methods for instantiation, type information, and printing. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSpheresSafeDownCast (vtkObjectBase *o)
 
- 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
 
 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 ()
 
- 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

vtkPointsCenters
 
vtkDataArrayRadii
 
vtkSphereSphere
 
- 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 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

◆ Superclass

Definition at line 50 of file vtkSpheres.h.

Constructor & Destructor Documentation

◆ vtkSpheres()

vtkSpheres::vtkSpheres ( )
protected

◆ ~vtkSpheres()

vtkSpheres::~vtkSpheres ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSpheres* vtkSpheres::New ( )
static

Standard methods for instantiation, type information, and printing.

◆ IsTypeOf()

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

◆ IsA()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSpheres::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImplicitFunction.

◆ NewInstance()

vtkSpheres* vtkSpheres::NewInstance ( ) const

◆ PrintSelf()

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

◆ EvaluateFunction() [1/4]

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.

◆ EvaluateGradient()

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

Evaluate spheres gradient.

Gradients point towards the outside of the spheres.

Implements vtkImplicitFunction.

◆ SetCenters()

virtual void vtkSpheres::SetCenters ( vtkPoints )
virtual

Specify a list of points defining sphere centers.

◆ GetCenters()

virtual vtkPoints* vtkSpheres::GetCenters ( )
virtual

◆ SetRadii()

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.

◆ GetRadii()

virtual vtkDataArray* vtkSpheres::GetRadii ( )
virtual

◆ GetNumberOfSpheres()

int vtkSpheres::GetNumberOfSpheres ( )

Return the number of spheres in the set of spheres.

◆ GetSphere() [1/2]

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.

◆ GetSphere() [2/2]

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.

◆ EvaluateFunction() [2/4]

virtual double vtkImplicitFunction::EvaluateFunction

Evaluate spheres equations.

Return largest value when evaluating all sphere equations.

◆ EvaluateFunction() [3/4]

virtual void vtkImplicitFunction::EvaluateFunction

Evaluate spheres equations.

Return largest value when evaluating all sphere equations.

◆ EvaluateFunction() [4/4]

virtual double vtkImplicitFunction::EvaluateFunction
inline

Evaluate spheres equations.

Return largest value when evaluating all sphere equations.

Definition at line 123 of file vtkImplicitFunction.h.

Member Data Documentation

◆ Centers

vtkPoints* vtkSpheres::Centers
protected

Definition at line 110 of file vtkSpheres.h.

◆ Radii

vtkDataArray* vtkSpheres::Radii
protected

Definition at line 111 of file vtkSpheres.h.

◆ Sphere

vtkSphere* vtkSpheres::Sphere
protected

Definition at line 112 of file vtkSpheres.h.


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