vtkSuperquadric Class Reference

implicit function for a Superquadric More...

#include <vtkSuperquadric.h>

Inheritance diagram for vtkSuperquadric:

Collaboration diagram for vtkSuperquadric:

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.
vtkSuperquadric *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
double	EvaluateFunction (double x[3]) override
	Evaluate function at position x-y-z and return value.
void	EvaluateGradient (double x[3], double g[3]) override
	Evaluate function gradient at position x-y-z and pass back vector.
virtual double	EvaluateFunction (double x[3])=0
	Evaluate function at position x-y-z and return value.
virtual void	EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
	Evaluate function at position x-y-z and return value.
virtual double	EvaluateFunction (double x, double y, double z)
	Evaluate function at position x-y-z and return value.
virtual void	SetCenter (double, double, double)
	Set the center of the superquadric.
virtual void	SetCenter (double[3])
	Set the center of the superquadric.
virtual double *	GetCenter ()
	Set the center of the superquadric.
virtual void	GetCenter (double data[3])
	Set the center of the superquadric.
virtual void	SetScale (double, double, double)
	Set the scale factors of the superquadric.
virtual void	SetScale (double[3])
	Set the scale factors of the superquadric.
virtual double *	GetScale ()
	Set the scale factors of the superquadric.
virtual void	GetScale (double data[3])
	Set the scale factors of the superquadric.
virtual double	GetThickness ()
	Set/Get Superquadric ring thickness (toroids only).
virtual void	SetThickness (double)
	Set/Get Superquadric ring thickness (toroids only).
virtual double	GetPhiRoundness ()
	Set/Get Superquadric north/south roundness.
void	SetPhiRoundness (double e)
	Set/Get Superquadric north/south roundness.
virtual double	GetThetaRoundness ()
	Set/Get Superquadric east/west roundness.
void	SetThetaRoundness (double e)
	Set/Get Superquadric east/west roundness.
virtual void	SetSize (double)
	Set/Get Superquadric isotropic size.
virtual double	GetSize ()
	Set/Get Superquadric isotropic size.
virtual void	ToroidalOn ()
	Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).
virtual void	ToroidalOff ()
	Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).
virtual vtkTypeBool	GetToroidal ()
	Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).
virtual void	SetToroidal (vtkTypeBool)
	Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).
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 vtkSuperquadric *	New ()
	Construct with superquadric radius of 0.5, toroidal off, center at 0.0, scale (1,1,1), size 0.5, phi roundness 1.0, and theta roundness 0.0.
static vtkTypeBool	IsTypeOf (const char *type)
static vtkSuperquadric *	SafeDownCast (vtkObjectBase *o)
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
	vtkSuperquadric ()
	~vtkSuperquadric () 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
vtkTypeBool	Toroidal
double	Thickness
double	Size
double	PhiRoundness
double	ThetaRoundness
double	Center [3]
double	Scale [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 Superquadric

vtkSuperquadric computes the implicit function and function gradient for a superquadric. vtkSuperquadric is a concrete implementation of vtkImplicitFunction. The superquadric is centered at Center and axes of rotation is along the y-axis. (Use the superclass' vtkImplicitFunction transformation matrix if necessary to reposition.) Roundness parameters (PhiRoundness and ThetaRoundness) control the shape of the superquadric. The Toroidal boolean controls whether a toroidal superquadric is produced. If so, the Thickness parameter controls the thickness of the toroid: 0 is the thinnest allowable toroid, and 1 has a minimum sized hole. The Scale parameters allow the superquadric to be scaled in x, y, and z (normal vectors are correctly generated in any case). The Size parameter controls size of the superquadric.

This code is based on "Rigid physically based superquadrics", A. H. Barr, in "Graphics Gems III", David Kirk, ed., Academic Press, 1992.

Warning

The Size and Thickness parameters control coefficients of superquadric generation, and may do not exactly describe the size of the superquadric.

Online Examples:

SampleFunction

ExtractPointsDemo

Definition at line 68 of file vtkSuperquadric.h.

Member Typedef Documentation

Superclass

typedef vtkImplicitFunction vtkSuperquadric::Superclass

Definition at line 77 of file vtkSuperquadric.h.

Constructor & Destructor Documentation

vtkSuperquadric()

vtkSuperquadric::vtkSuperquadric ( )

protected

~vtkSuperquadric()

vtkSuperquadric::~vtkSuperquadric ( )

overrideprotecteddefault

Member Function Documentation

New()

static vtkSuperquadric * vtkSuperquadric::New ( )

static

Construct with superquadric radius of 0.5, toroidal off, center at 0.0, scale (1,1,1), size 0.5, phi roundness 1.0, and theta roundness 0.0.

IsTypeOf()

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

static

IsA()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkSuperquadric::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImplicitFunction.

NewInstance()

vtkSuperquadric * vtkSuperquadric::NewInstance

(

)

const

PrintSelf()

void vtkSuperquadric::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 vtkSuperquadric::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 vtkSuperquadric::EvaluateGradient ( double  x[3], double  g[3]  )

overridevirtual

Evaluate function gradient at position x-y-z and pass back vector.

You should generally not call this method directly, you should use FunctionGradient() instead. This method must be implemented by any derived class.

Implements vtkImplicitFunction.

SetCenter() [1/2]

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

virtual

Set the center of the superquadric.

Default is 0,0,0.

SetCenter() [2/2]

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

virtual

Set the center of the superquadric.

Default is 0,0,0.

GetCenter() [1/2]

virtual double * vtkSuperquadric::GetCenter ( )

virtual

Set the center of the superquadric.

Default is 0,0,0.

GetCenter() [2/2]

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

virtual

Set the center of the superquadric.

Default is 0,0,0.

SetScale() [1/2]

virtual void vtkSuperquadric::SetScale ( double  , double  , double    )

virtual

Set the scale factors of the superquadric.

Default is 1,1,1.

SetScale() [2/2]

virtual void vtkSuperquadric::SetScale ( double  [3] )

virtual

Set the scale factors of the superquadric.

Default is 1,1,1.

GetScale() [1/2]

virtual double * vtkSuperquadric::GetScale ( )

virtual

Set the scale factors of the superquadric.

Default is 1,1,1.

GetScale() [2/2]

virtual void vtkSuperquadric::GetScale ( double  data[3] )

virtual

Set the scale factors of the superquadric.

Default is 1,1,1.

GetThickness()

virtual double vtkSuperquadric::GetThickness ( )

virtual

Set/Get Superquadric ring thickness (toroids only).

Changing thickness maintains the outside diameter of the toroid.

SetThickness()

virtual void vtkSuperquadric::SetThickness ( double  )

virtual

Set/Get Superquadric ring thickness (toroids only).

Changing thickness maintains the outside diameter of the toroid.

GetPhiRoundness()

virtual double vtkSuperquadric::GetPhiRoundness ( )

virtual

Set/Get Superquadric north/south roundness.

Values range from 0 (rectangular) to 1 (circular) to higher orders.

SetPhiRoundness()

void vtkSuperquadric::SetPhiRoundness

(

double

e

)

Set/Get Superquadric north/south roundness.

Values range from 0 (rectangular) to 1 (circular) to higher orders.

GetThetaRoundness()

virtual double vtkSuperquadric::GetThetaRoundness ( )

virtual

Set/Get Superquadric east/west roundness.

Values range from 0 (rectangular) to 1 (circular) to higher orders.

SetThetaRoundness()

void vtkSuperquadric::SetThetaRoundness

(

double

e

)

Set/Get Superquadric east/west roundness.

Values range from 0 (rectangular) to 1 (circular) to higher orders.

SetSize()

virtual void vtkSuperquadric::SetSize ( double  )

virtual

Set/Get Superquadric isotropic size.

GetSize()

virtual double vtkSuperquadric::GetSize ( )

virtual

Set/Get Superquadric isotropic size.

ToroidalOn()

virtual void vtkSuperquadric::ToroidalOn ( )

virtual

Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).

ToroidalOff()

virtual void vtkSuperquadric::ToroidalOff ( )

virtual

Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).

GetToroidal()

virtual vtkTypeBool vtkSuperquadric::GetToroidal ( )

virtual

Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).

SetToroidal()

virtual void vtkSuperquadric::SetToroidal ( vtkTypeBool  )

virtual

Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).

EvaluateFunction() [2/4]

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

virtual

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.

EvaluateFunction() [3/4]

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

virtual

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.

Reimplemented from vtkImplicitFunction.

EvaluateFunction() [4/4]

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

inlinevirtual

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.

Reimplemented from vtkImplicitFunction.

Definition at line 131 of file vtkImplicitFunction.h.

Member Data Documentation

Toroidal

vtkTypeBool vtkSuperquadric::Toroidal

protected

Definition at line 149 of file vtkSuperquadric.h.

Thickness

double vtkSuperquadric::Thickness

protected

Definition at line 150 of file vtkSuperquadric.h.

Size

double vtkSuperquadric::Size

protected

Definition at line 151 of file vtkSuperquadric.h.

PhiRoundness

double vtkSuperquadric::PhiRoundness

protected

Definition at line 152 of file vtkSuperquadric.h.

ThetaRoundness

double vtkSuperquadric::ThetaRoundness

protected

Definition at line 153 of file vtkSuperquadric.h.

Center

double vtkSuperquadric::Center[3]

protected

Definition at line 154 of file vtkSuperquadric.h.

Scale

double vtkSuperquadric::Scale[3]

protected

Definition at line 155 of file vtkSuperquadric.h.

---

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

• Common/DataModel/vtkSuperquadric.h