Main Page   Class Hierarchy   Alphabetical List   Compound List   Compound Members   Related Pages  

vtkSuperquadric Class Reference

implicit function for a Superquadric. More...

#include <vtkSuperquadric.h>

Inheritance diagram for vtkSuperquadric:

Inheritance graph
[legend]
Collaboration diagram for vtkSuperquadric:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
float EvaluateFunction (float x[3])
float EvaluateFunction (float x, float y, float z)
void EvaluateGradient (float x[3], float g[3])
virtual void SetCenter (float, float, float)
virtual void SetCenter (float[3])
virtual float * GetCenter ()
virtual void GetCenter (float data[3])
virtual void SetScale (float, float, float)
virtual void SetScale (float[3])
virtual float * GetScale ()
virtual void GetScale (float data[3])
virtual float GetThickness ()
virtual void SetThickness (float)
virtual float GetPhiRoundness ()
void SetPhiRoundness (float e)
virtual float GetThetaRoundness ()
void SetThetaRoundness (float e)
virtual void SetSize (float)
virtual float GetSize ()
virtual void ToroidalOn ()
virtual void ToroidalOff ()
virtual int GetToroidal ()
virtual void SetToroidal (int)

Static Public Methods

vtkSuperquadric * New ()
int IsTypeOf (const char *type)
vtkSuperquadric * SafeDownCast (vtkObject *o)

Protected Methods

 vtkSuperquadric ()
 ~vtkSuperquadric ()
 vtkSuperquadric (const vtkSuperquadric &)
void operator= (const vtkSuperquadric &)

Protected Attributes

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

Detailed Description

implicit function for a Superquadric.

Date:
2000/12/10 20:08:26
Revision:
1.15
Thanks:
Mike Halle, Brigham and Women's Hospital
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.
Examples:
vtkSuperquadric (examples)


Member Function Documentation

float vtkSuperquadric::EvaluateFunction float    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.

void vtkSuperquadric::EvaluateGradient float    x[3],
float    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 const char* vtkSuperquadric::GetClassName   [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImplicitFunction.

virtual float vtkSuperquadric::GetPhiRoundness   [virtual]
 

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

virtual float vtkSuperquadric::GetThetaRoundness   [virtual]
 

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

virtual float vtkSuperquadric::GetThickness   [virtual]
 

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

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

Reimplemented from vtkImplicitFunction.

int vtkSuperquadric::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImplicitFunction.

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.

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.

vtkSuperquadric* vtkSuperquadric::SafeDownCast vtkObject   o [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImplicitFunction.

virtual void vtkSuperquadric::SetCenter float   ,
float   ,
float   
[virtual]
 

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

virtual void vtkSuperquadric::SetScale float   ,
float   ,
float   
[virtual]
 

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

virtual void vtkSuperquadric::SetSize float    [virtual]
 

Set/Get Superquadric isotropic size.

virtual void vtkSuperquadric::ToroidalOn   [virtual]
 

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


The documentation for this class was generated from the following file:
Generated on Tue Mar 19 13:33:30 2002 for VTK by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002