VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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>

Inherits vtkImplicitFunction.

Public Types

typedef vtkImplicitFunction Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkSuperquadricNewInstance () const
 
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)
 

Static Public Member Functions

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

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkSuperquadric ()
 
 ~vtkSuperquadric ()
 

Protected Attributes

int Toroidal
 
double Thickness
 
double Size
 
double PhiRoundness
 
double ThetaRoundness
 
double Center [3]
 
double Scale [3]
 

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

Member Typedef Documentation

typedef vtkImplicitFunction vtkSuperquadric::Superclass

Definition at line 57 of file vtkSuperquadric.h.

Constructor & Destructor Documentation

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

Definition at line 115 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.

static int vtkSuperquadric::IsTypeOf ( const char *  type)
static
virtual int vtkSuperquadric::IsA ( const char *  type)
virtual
static vtkSuperquadric* vtkSuperquadric::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkSuperquadric::NewInstanceInternal ( ) const
protectedvirtual
vtkSuperquadric* vtkSuperquadric::NewInstance ( ) const
void vtkSuperquadric::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
double vtkSuperquadric::EvaluateFunction ( double  x[3])
double vtkSuperquadric::EvaluateFunction ( double  x,
double  y,
double  z 
)
inline

Definition at line 62 of file vtkSuperquadric.h.

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

double vtkSuperquadric::Thickness
protected

Definition at line 118 of file vtkSuperquadric.h.

double vtkSuperquadric::Size
protected

Definition at line 119 of file vtkSuperquadric.h.

double vtkSuperquadric::PhiRoundness
protected

Definition at line 120 of file vtkSuperquadric.h.

double vtkSuperquadric::ThetaRoundness
protected

Definition at line 121 of file vtkSuperquadric.h.

double vtkSuperquadric::Center[3]
protected

Definition at line 122 of file vtkSuperquadric.h.

double vtkSuperquadric::Scale[3]
protected

Definition at line 123 of file vtkSuperquadric.h.


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