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.

Examples:
vtkSuperquadricSource (Examples)
Tests:
vtkSuperquadricSource (Tests)

Definition at line 64 of file vtkSuperquadricSource.h.


Public Types

typedef vtkPolyDataAlgorithm 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

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

Protected Member Functions

 vtkSuperquadricSource (int res=16)
 ~vtkSuperquadricSource ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

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

Member Typedef Documentation

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 71 of file vtkSuperquadricSource.h.


Constructor & Destructor Documentation

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

vtkSuperquadricSource::~vtkSuperquadricSource (  )  [inline, protected]

Definition at line 135 of file vtkSuperquadricSource.h.


Member Function Documentation

static vtkSuperquadricSource* vtkSuperquadricSource::New (  )  [static]

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

Reimplemented from vtkPolyDataAlgorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

static int vtkSuperquadricSource::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkSuperquadricSource::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

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 vtkPolyDataAlgorithm.

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).

int vtkSuperquadricSource::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.


Member Data Documentation

Definition at line 135 of file vtkSuperquadricSource.h.

Definition at line 138 of file vtkSuperquadricSource.h.

Definition at line 139 of file vtkSuperquadricSource.h.

double vtkSuperquadricSource::Size [protected]

Definition at line 140 of file vtkSuperquadricSource.h.

Definition at line 141 of file vtkSuperquadricSource.h.

Definition at line 142 of file vtkSuperquadricSource.h.

double vtkSuperquadricSource::Center[3] [protected]

Definition at line 144 of file vtkSuperquadricSource.h.

double vtkSuperquadricSource::Scale[3] [protected]

Definition at line 145 of file vtkSuperquadricSource.h.

Definition at line 146 of file vtkSuperquadricSource.h.

Definition at line 147 of file vtkSuperquadricSource.h.


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

Generated on Sat Dec 27 13:52:23 2008 for VTK by  doxygen 1.5.6