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

#include <vtkSuperquadricSource.h>

Inheritance diagram for vtkSuperquadricSource:

Collaboration diagram for vtkSuperquadricSource:

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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkSuperquadricSource *	NewInstance () 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)


virtual void	SetOutputPointsPrecision (int)

virtual int	GetOutputPointsPrecision ()

Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithm *	NewInstance () const

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

vtkPolyData *	GetPolyDataInput (int port)

vtkPolyData *	GetOutput ()

vtkPolyData *	GetOutput (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
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

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

vtkDataObject *	GetOutputDataObject (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 ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

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)

vtkDataObject *	GetInputDataObject (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)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

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)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkSuperquadricSource *	New ()

static int	IsTypeOf (const char *type)

static vtkSuperquadricSource *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkPolyDataAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

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 *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

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 vtkExecutive *	CreateDefaultExecutive ()

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 Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	Toroidal

int	AxisOfSymmetry

double	Thickness

double	Size

double	PhiRoundness

double	ThetaRoundness

double	Center [3]

double	Scale [3]

int	ThetaResolution

int	PhiResolution

int	OutputPointsPrecision

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 vtkExecutive *	DefaultExecutivePrototype

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

typedef vtkPolyDataAlgorithm vtkSuperquadricSource::Superclass

Definition at line 74 of file vtkSuperquadricSource.h.

Constructor & Destructor Documentation

vtkSuperquadricSource::vtkSuperquadricSource ( int res = 16 )

protected

vtkSuperquadricSource::~vtkSuperquadricSource ( )

inlineprotected

Definition at line 160 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 * 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 vtkTypeMacro found in vtkSetGet.h.

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

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