Main Page | Directories | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkSuperquadricSource Class Reference

#include <vtkSuperquadricSource.h>

Inheritance diagram for vtkSuperquadricSource:

Inheritance graph
[legend]
Collaboration diagram for vtkSuperquadricSource:

Collaboration graph
[legend]
List of all members.

Detailed Description

create a polygonal superquadric centered at the origin

vtkSuperquadricSource creates a superquadric (represented by polygons) of specified size centered at the origin. The resolution (polygonal discretization) in both the latitude (phi) and longitude (theta) directions can be specified. 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:
Resolution means the number of latitude or longitude lines for a complete superquadric. The resolution parameters are rounded to the nearest 4 in phi and 8 in theta.

Texture coordinates are not equally distributed around all superquadrics.

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

Created by:
  • Lorensen, Bill
CVS contributions (if > 5%):
  • Lorensen, Bill (80%)
  • Martin, Ken (11%)
CVS logs (CVSweb):
  • .h (/Graphics/vtkSuperquadricSource.h)
  • .cxx (/Graphics/vtkSuperquadricSource.cxx)
Examples:
vtkSuperquadricSource (Examples)
Tests:
vtkSuperquadricSource (Tests)

Definition at line 75 of file vtkSuperquadricSource.h.

Public Types

typedef vtkPolyDataSource Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
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 int GetThetaResolution ()
void SetThetaResolution (int i)
virtual int GetPhiResolution ()
void SetPhiResolution (int i)
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

vtkSuperquadricSourceNew ()
int IsTypeOf (const char *type)
vtkSuperquadricSourceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSuperquadricSource (int res=16)
 ~vtkSuperquadricSource ()
void Execute ()

Protected Attributes

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


Member Typedef Documentation

typedef vtkPolyDataSource vtkSuperquadricSource::Superclass
 

Reimplemented from vtkPolyDataSource.

Definition at line 82 of file vtkSuperquadricSource.h.


Constructor & Destructor Documentation

vtkSuperquadricSource::vtkSuperquadricSource int  res = 16  )  [protected]
 

vtkSuperquadricSource::~vtkSuperquadricSource  )  [inline, protected]
 

Definition at line 146 of file vtkSuperquadricSource.h.


Member Function Documentation

vtkSuperquadricSource* vtkSuperquadricSource::New  )  [static]
 

Create a default superquadric with a radius of 0.5, non-toroidal, spherical, and centered at the origin.

Reimplemented from vtkAlgorithm.

virtual const char* vtkSuperquadricSource::GetClassName  )  [virtual]
 

Reimplemented from vtkPolyDataSource.

int vtkSuperquadricSource::IsTypeOf const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataSource.

virtual int vtkSuperquadricSource::IsA const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataSource.

vtkSuperquadricSource* vtkSuperquadricSource::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkPolyDataSource.

void vtkSuperquadricSource::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 vtkPolyDataSource.

virtual void vtkSuperquadricSource::SetCenter double  ,
double  ,
double 
[virtual]
 

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

virtual void vtkSuperquadricSource::SetCenter double  [3]  )  [virtual]
 

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

virtual double* vtkSuperquadricSource::GetCenter  )  [virtual]
 

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

virtual void vtkSuperquadricSource::GetCenter double  data[3]  )  [virtual]
 

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

virtual void vtkSuperquadricSource::SetScale double  ,
double  ,
double 
[virtual]
 

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

virtual void vtkSuperquadricSource::SetScale double  [3]  )  [virtual]
 

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

virtual double* vtkSuperquadricSource::GetScale  )  [virtual]
 

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

virtual void vtkSuperquadricSource::GetScale double  data[3]  )  [virtual]
 

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

virtual int vtkSuperquadricSource::GetThetaResolution  )  [virtual]
 

Set the number of points in the longitude direction.

void vtkSuperquadricSource::SetThetaResolution int  i  ) 
 

Set the number of points in the longitude direction.

virtual int vtkSuperquadricSource::GetPhiResolution  )  [virtual]
 

Set the number of points in the latitude direction.

void vtkSuperquadricSource::SetPhiResolution int  i  ) 
 

Set the number of points in the latitude direction.

virtual double vtkSuperquadricSource::GetThickness  )  [virtual]
 

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

virtual void vtkSuperquadricSource::SetThickness double   )  [virtual]
 

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

virtual double vtkSuperquadricSource::GetPhiRoundness  )  [virtual]
 

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

void vtkSuperquadricSource::SetPhiRoundness double  e  ) 
 

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

virtual double vtkSuperquadricSource::GetThetaRoundness  )  [virtual]
 

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

void vtkSuperquadricSource::SetThetaRoundness double  e  ) 
 

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

virtual void vtkSuperquadricSource::SetSize double   )  [virtual]
 

Set/Get Superquadric isotropic size.

virtual double vtkSuperquadricSource::GetSize  )  [virtual]
 

Set/Get Superquadric isotropic size.

virtual void vtkSuperquadricSource::ToroidalOn  )  [virtual]
 

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

virtual void vtkSuperquadricSource::ToroidalOff  )  [virtual]
 

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

virtual int vtkSuperquadricSource::GetToroidal  )  [virtual]
 

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

virtual void vtkSuperquadricSource::SetToroidal int   )  [virtual]
 

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

void vtkSuperquadricSource::Execute  )  [protected, virtual]
 

This method is the old style execute method

Reimplemented from vtkSource.


Member Data Documentation

int vtkSuperquadricSource::Toroidal [protected]
 

Definition at line 148 of file vtkSuperquadricSource.h.

double vtkSuperquadricSource::Thickness [protected]
 

Definition at line 149 of file vtkSuperquadricSource.h.

double vtkSuperquadricSource::Size [protected]
 

Definition at line 150 of file vtkSuperquadricSource.h.

double vtkSuperquadricSource::PhiRoundness [protected]
 

Definition at line 151 of file vtkSuperquadricSource.h.

double vtkSuperquadricSource::ThetaRoundness [protected]
 

Definition at line 152 of file vtkSuperquadricSource.h.

double vtkSuperquadricSource::Center[3] [protected]
 

Definition at line 154 of file vtkSuperquadricSource.h.

double vtkSuperquadricSource::Scale[3] [protected]
 

Definition at line 155 of file vtkSuperquadricSource.h.

int vtkSuperquadricSource::ThetaResolution [protected]
 

Definition at line 156 of file vtkSuperquadricSource.h.

int vtkSuperquadricSource::PhiResolution [protected]
 

Definition at line 157 of file vtkSuperquadricSource.h.


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