VTK  9.3.20240612
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 Member Functions

void EvaluateGradient (double x[3], double n[3]) override
 Evaluate spheres gradient.
 
int GetNumberOfSpheres ()
 Return the number of spheres in the set of spheres.
 
vtkSphereGetSphere (int i)
 Create and return a pointer to a vtkSphere object at the ith position.
 
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.
 
double EvaluateFunction (double x[3]) override
 Evaluate spheres equations.
 
virtual double EvaluateFunction (double x[3])=0
 Evaluate spheres equations.
 
virtual void EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
 Evaluate spheres equations.
 
virtual double EvaluateFunction (double x, double y, double z)
 Evaluate spheres equations.
 
virtual void SetCenters (vtkPoints *)
 Specify a list of points defining sphere centers.
 
virtual vtkPointsGetCenters ()
 Specify a list of points defining sphere centers.
 
void SetRadii (vtkDataArray *radii)
 Specify a list of radii for the spheres.
 
virtual vtkDataArrayGetRadii ()
 Specify a list of radii for the spheres.
 
- 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.
 
vtkImplicitFunctionNewInstance () 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 vtkAbstractTransformGetTransform ()
 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.
 
vtkCommandGetCommand (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.
 

Protected Member Functions

 vtkSpheres ()
 
 ~vtkSpheres () override
 
- Protected Member Functions inherited from vtkImplicitFunction
virtual vtkObjectBaseNewInstanceInternal () 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

vtkPointsCenters
 
vtkDataArrayRadii
 
vtkSphereSphere
 
- Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransformTransform
 
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
 
typedef vtkImplicitFunction Superclass
 Standard methods for instantiation, type information, and printing.
 
static vtkSpheresNew ()
 Standard methods for instantiation, type information, and printing.
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instantiation, type information, and printing.
 
static vtkSpheresSafeDownCast (vtkObjectBase *o)
 Standard methods for instantiation, type information, and printing.
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instantiation, type information, and printing.
 
vtkSpheresNewInstance () const
 Standard methods for instantiation, type information, and printing.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instantiation, type information, and printing.
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instantiation, type information, and printing.
 

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 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.
 
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 vtkObjectBaseNew ()
 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.
 
- 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 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 31 of file vtkSpheres.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instantiation, type information, and printing.

Definition at line 39 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

Standard methods for instantiation, type information, and printing.

◆ IsA()

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

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkImplicitFunction.

◆ SafeDownCast()

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

Standard methods for instantiation, type information, and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSpheres::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkImplicitFunction.

◆ NewInstance()

vtkSpheres * vtkSpheres::NewInstance ( ) const

Standard methods for instantiation, type information, and printing.

◆ PrintSelf()

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

Standard methods for instantiation, type information, and printing.

Reimplemented from vtkImplicitFunction.

◆ EvaluateFunction() [1/4]

double vtkSpheres::EvaluateFunction ( double  x[3])
overridevirtual

Evaluate spheres equations.

Return largest value when evaluating all sphere equations.

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

Specify a list of points defining sphere centers.

◆ 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

Specify a list of radii for the spheres.

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

◆ 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 ( double  x[3])
virtual

Evaluate spheres equations.

Return largest value when evaluating all sphere equations.

Implements vtkImplicitFunction.

◆ EvaluateFunction() [3/4]

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

Evaluate spheres equations.

Return largest value when evaluating all sphere equations.

Reimplemented from vtkImplicitFunction.

◆ EvaluateFunction() [4/4]

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

Evaluate spheres equations.

Return largest value when evaluating all sphere equations.

Reimplemented from vtkImplicitFunction.

Definition at line 131 of file vtkImplicitFunction.h.

Member Data Documentation

◆ Centers

vtkPoints* vtkSpheres::Centers
protected

Definition at line 99 of file vtkSpheres.h.

◆ Radii

vtkDataArray* vtkSpheres::Radii
protected

Definition at line 100 of file vtkSpheres.h.

◆ Sphere

vtkSphere* vtkSpheres::Sphere
protected

Definition at line 101 of file vtkSpheres.h.


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