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

implicit function for a Superquadric More...

#include <vtkSuperquadric.h>

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

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 const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
double EvaluateFunction (double x[3])
double EvaluateFunction (double x, double y, double z)
void EvaluateGradient (double x[3], double g[3])
virtual void SetCenter (double, double, double)
virtual void SetCenter (double[3])
virtual double * GetCenter ()
virtual void GetCenter (double data[3])
virtual void SetScale (double, double, double)
virtual void SetScale (double[3])
virtual double * GetScale ()
virtual void GetScale (double data[3])
virtual double GetThickness ()
virtual void SetThickness (double)
virtual double GetPhiRoundness ()
void SetPhiRoundness (double e)
virtual double GetThetaRoundness ()
void SetThetaRoundness (double e)
virtual void SetSize (double)
virtual double GetSize ()
virtual void ToroidalOn ()
virtual void ToroidalOff ()
virtual int GetToroidal ()
virtual void SetToroidal (int)
- Public Member Functions inherited from vtkImplicitFunction
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 vtkAbstractTransformGetTransform ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkSuperquadricNew ()
static int IsTypeOf (const char *type)
static vtkSuperquadricSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSuperquadric ()
 ~vtkSuperquadric ()
- 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 &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

int Toroidal
double Thickness
double Size
double PhiRoundness
double ThetaRoundness
double Center [3]
double Scale [3]
- Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransformTransform
double ReturnValue [3]
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

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.

Definition at line 48 of file vtkSuperquadric.h.

Member Typedef Documentation

Definition at line 56 of file vtkSuperquadric.h.

Constructor & Destructor Documentation

vtkSuperquadric::vtkSuperquadric ( )
protected
vtkSuperquadric::~vtkSuperquadric ( )
inlineprotected

Definition at line 114 of file vtkSuperquadric.h.

Member Function Documentation

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.

Reimplemented from vtkObject.

virtual const char* vtkSuperquadric::GetClassName ( )
virtual

Reimplemented from vtkImplicitFunction.

static int vtkSuperquadric::IsTypeOf ( const char *  name)
static

Return 1 if this class type 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.

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

static vtkSuperquadric* vtkSuperquadric::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkImplicitFunction.

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

double vtkSuperquadric::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.

double vtkSuperquadric::EvaluateFunction ( double  x,
double  y,
double  z 
)
inline

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 61 of file vtkSuperquadric.h.

void vtkSuperquadric::EvaluateGradient ( double  x[3],
double  g[3] 
)
virtual

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.

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

Set the center of the superquadric. Default is 0,0,0.

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

Set the center of the superquadric. Default is 0,0,0.

virtual double* vtkSuperquadric::GetCenter ( )
virtual

Set the center of the superquadric. Default is 0,0,0.

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

Set the center of the superquadric. Default is 0,0,0.

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

Set the scale factors of the superquadric. Default is 1,1,1.

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

Set the scale factors of the superquadric. Default is 1,1,1.

virtual double* vtkSuperquadric::GetScale ( )
virtual

Set the scale factors of the superquadric. Default is 1,1,1.

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

Set the scale factors of the superquadric. Default is 1,1,1.

virtual double vtkSuperquadric::GetThickness ( )
virtual

Set/Get Superquadric ring thickness (toroids only). Changing thickness maintains the outside diameter of the toroid.

virtual void vtkSuperquadric::SetThickness ( double  )
virtual

Set/Get Superquadric ring thickness (toroids only). Changing thickness maintains the outside diameter of the toroid.

virtual double vtkSuperquadric::GetPhiRoundness ( )
virtual

Set/Get Superquadric north/south roundness. Values range from 0 (rectangular) to 1 (circular) to higher orders.

void vtkSuperquadric::SetPhiRoundness ( double  e)

Set/Get Superquadric north/south roundness. Values range from 0 (rectangular) to 1 (circular) to higher orders.

virtual double vtkSuperquadric::GetThetaRoundness ( )
virtual

Set/Get Superquadric east/west roundness. Values range from 0 (rectangular) to 1 (circular) to higher orders.

void vtkSuperquadric::SetThetaRoundness ( double  e)

Set/Get Superquadric east/west roundness. Values range from 0 (rectangular) to 1 (circular) to higher orders.

virtual void vtkSuperquadric::SetSize ( double  )
virtual

Set/Get Superquadric isotropic size.

virtual double vtkSuperquadric::GetSize ( )
virtual

Set/Get Superquadric isotropic size.

virtual void vtkSuperquadric::ToroidalOn ( )
virtual

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

virtual void vtkSuperquadric::ToroidalOff ( )
virtual

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

virtual int vtkSuperquadric::GetToroidal ( )
virtual

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

virtual void vtkSuperquadric::SetToroidal ( int  )
virtual

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

Member Data Documentation

int vtkSuperquadric::Toroidal
protected

Definition at line 114 of file vtkSuperquadric.h.

double vtkSuperquadric::Thickness
protected

Definition at line 117 of file vtkSuperquadric.h.

double vtkSuperquadric::Size
protected

Definition at line 118 of file vtkSuperquadric.h.

double vtkSuperquadric::PhiRoundness
protected

Definition at line 119 of file vtkSuperquadric.h.

double vtkSuperquadric::ThetaRoundness
protected

Definition at line 120 of file vtkSuperquadric.h.

double vtkSuperquadric::Center[3]
protected

Definition at line 121 of file vtkSuperquadric.h.

double vtkSuperquadric::Scale[3]
protected

Definition at line 122 of file vtkSuperquadric.h.


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