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
vtkSuperquadricSource Class Reference

create a polygonal superquadric centered at the origin More...

#include <vtkSuperquadricSource.h>

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

Public Types

typedef vtkPolyDataAlgorithm Superclass
 
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkSuperquadricSourceNewInstance () const
 
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 SetAxisOfSymmetry (int)
 
virtual int GetAxisOfSymmetry ()
 
void SetXAxisOfSymmetry ()
 
void SetYAxisOfSymmetry ()
 
void SetZAxisOfSymmetry ()
 
virtual void ToroidalOn ()
 
virtual void ToroidalOff ()
 
virtual int GetToroidal ()
 
virtual void SetToroidal (int)
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformation * GetInputPortInformation (int port)
 
vtkInformation * GetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformation * GetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int extent[6])
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 
vtkDataObjectGetInputDataObject (int port, int connection)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformation * GetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int extent[6])
 
int * GetUpdateExtent ()
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 

Static Public Member Functions

static vtkSuperquadricSourceNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSuperquadricSourceSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKey * INPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKey * INPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey * 
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKey * INPUT_PORT ()
 
static vtkInformationIntegerKey * INPUT_CONNECTION ()
 
static vtkInformationIntegerKey * PRESERVES_DATASET ()
 
static vtkInformationIntegerKey * PRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKey * PRESERVES_BOUNDS ()
 
static vtkInformationIntegerKey * PRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKey * PRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKey * PRESERVES_RANGES ()
 
static vtkInformationIntegerKey * MANAGES_METAINFORMATION ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkSuperquadricSource (int res=16)
 
 ~vtkSuperquadricSource ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
virtual void SetNumberOfInputPorts (int n)
 
virtual void SetNumberOfOutputPorts (int n)
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 
virtual vtkExecutiveCreateDefaultExecutive ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void SetNumberOfInputConnections (int port, int n)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformation * GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
virtual void SetErrorCode (unsigned long)
 

Protected Attributes

int Toroidal
 
int AxisOfSymmetry
 
double Thickness
 
double Size
 
double PhiRoundness
 
double ThetaRoundness
 
double Center [3]
 
double Scale [3]
 
int ThetaResolution
 
int PhiResolution
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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 alignment of the axis of the superquadric along one of the global axes can be specified. 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 66 of file vtkSuperquadricSource.h.

Member Typedef Documentation

Definition at line 74 of file vtkSuperquadricSource.h.

Constructor & Destructor Documentation

vtkSuperquadricSource::vtkSuperquadricSource ( int  res = 16)
protected
vtkSuperquadricSource::~vtkSuperquadricSource ( )
inlineprotected

Definition at line 151 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, with a scaling factor of 1 in each direction, a theta resolution and a phi resolutions of 16.

static int vtkSuperquadricSource::IsTypeOf ( const char *  type)
static
virtual int vtkSuperquadricSource::IsA ( const char *  type)
virtual

Reimplemented from vtkPolyDataAlgorithm.

static vtkSuperquadricSource* vtkSuperquadricSource::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkSuperquadricSource::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

vtkSuperquadricSource* vtkSuperquadricSource::NewInstance ( ) const
void vtkSuperquadricSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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. Initial value is

void vtkSuperquadricSource::SetThetaResolution ( int  i)

Set the number of points in the longitude direction. Initial value is

virtual int vtkSuperquadricSource::GetPhiResolution ( )
virtual

Set the number of points in the latitude direction. Initial value is

void vtkSuperquadricSource::SetPhiResolution ( int  i)

Set the number of points in the latitude direction. Initial value is

virtual double vtkSuperquadricSource::GetThickness ( )
virtual

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

virtual void vtkSuperquadricSource::SetThickness ( double  )
virtual

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

virtual double vtkSuperquadricSource::GetPhiRoundness ( )
virtual

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

void vtkSuperquadricSource::SetPhiRoundness ( double  e)

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

virtual double vtkSuperquadricSource::GetThetaRoundness ( )
virtual

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

void vtkSuperquadricSource::SetThetaRoundness ( double  e)

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

virtual void vtkSuperquadricSource::SetSize ( double  )
virtual

Set/Get Superquadric isotropic size. Initial value is 0.5;

virtual double vtkSuperquadricSource::GetSize ( )
virtual

Set/Get Superquadric isotropic size. Initial value is 0.5;

virtual void vtkSuperquadricSource::SetAxisOfSymmetry ( int  )
virtual

Set/Get axis of symmetry for superquadric (x axis: 0, y axis: 1, z axis: 2). Initial value is 1.

virtual int vtkSuperquadricSource::GetAxisOfSymmetry ( )
virtual

Set/Get axis of symmetry for superquadric (x axis: 0, y axis: 1, z axis: 2). Initial value is 1.

void vtkSuperquadricSource::SetXAxisOfSymmetry ( )
inline

Set/Get axis of symmetry for superquadric (x axis: 0, y axis: 1, z axis: 2). Initial value is 1.

Definition at line 136 of file vtkSuperquadricSource.h.

void vtkSuperquadricSource::SetYAxisOfSymmetry ( )
inline

Set/Get axis of symmetry for superquadric (x axis: 0, y axis: 1, z axis: 2). Initial value is 1.

Definition at line 137 of file vtkSuperquadricSource.h.

void vtkSuperquadricSource::SetZAxisOfSymmetry ( )
inline

Set/Get axis of symmetry for superquadric (x axis: 0, y axis: 1, z axis: 2). Initial value is 1.

Definition at line 138 of file vtkSuperquadricSource.h.

virtual void vtkSuperquadricSource::ToroidalOn ( )
virtual

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

virtual void vtkSuperquadricSource::ToroidalOff ( )
virtual

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

virtual int vtkSuperquadricSource::GetToroidal ( )
virtual

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

virtual void vtkSuperquadricSource::SetToroidal ( int  )
virtual

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

int vtkSuperquadricSource::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

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

Reimplemented from vtkPolyDataAlgorithm.

Member Data Documentation

int vtkSuperquadricSource::Toroidal
protected

Definition at line 151 of file vtkSuperquadricSource.h.

int vtkSuperquadricSource::AxisOfSymmetry
protected

Definition at line 154 of file vtkSuperquadricSource.h.

double vtkSuperquadricSource::Thickness
protected

Definition at line 155 of file vtkSuperquadricSource.h.

double vtkSuperquadricSource::Size
protected

Definition at line 156 of file vtkSuperquadricSource.h.

double vtkSuperquadricSource::PhiRoundness
protected

Definition at line 157 of file vtkSuperquadricSource.h.

double vtkSuperquadricSource::ThetaRoundness
protected

Definition at line 158 of file vtkSuperquadricSource.h.

double vtkSuperquadricSource::Center[3]
protected

Definition at line 160 of file vtkSuperquadricSource.h.

double vtkSuperquadricSource::Scale[3]
protected

Definition at line 161 of file vtkSuperquadricSource.h.

int vtkSuperquadricSource::ThetaResolution
protected

Definition at line 162 of file vtkSuperquadricSource.h.

int vtkSuperquadricSource::PhiResolution
protected

Definition at line 163 of file vtkSuperquadricSource.h.


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