vtkParametricSuperEllipsoid Class Reference

#include <vtkParametricSuperEllipsoid.h>

Inheritance diagram for vtkParametricSuperEllipsoid:

[legend]

Collaboration diagram for vtkParametricSuperEllipsoid:

[legend]

List of all members.

Detailed Description

Generate a superellipsoid.

vtkParametricSuperEllipsoid generates a superellipsoid. A superellipsoid is a versatile primitive that is controlled by two parameters n1 and n2. As special cases it can represent a sphere, square box, and closed cylindrical can.

For further information about this surface, please consult the technical description "Parametric surfaces" in http://www.vtk.org/documents.php in the "VTK Technical Documents" section in the VTk.org web pages.

Also see: http://astronomy.swin.edu.au/~pbourke/surfaces/

Warning:: Care needs to be taken specifying the bounds correctly. You may need to carefully adjust MinimumU, MinimumV, MaximumU, MaximumV.

Thanks:: Andrew Maclean a.maclean@cas.edu.au for creating and contributing the class.

Tests:: vtkParametricSuperEllipsoid (Tests)

Definition at line 47 of file vtkParametricSuperEllipsoid.h.


Public Types
typedef vtkParametricFunction	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	GetDimension ()
virtual void	Evaluate (double uvw[3], double Pt[3], double Duvw[9])
virtual double	EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9])

virtual void	SetXRadius (double)
virtual double	GetXRadius ()

virtual void	SetYRadius (double)
virtual double	GetYRadius ()

virtual void	SetZRadius (double)
virtual double	GetZRadius ()

virtual void	SetN1 (double)
virtual double	GetN1 ()

virtual void	SetN2 (double)
virtual double	GetN2 ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkParametricSuperEllipsoid *	SafeDownCast (vtkObject *o)
static vtkParametricSuperEllipsoid *	New ()
Protected Member Functions
	vtkParametricSuperEllipsoid ()
	~vtkParametricSuperEllipsoid ()
Protected Attributes
double	XRadius
double	YRadius
double	ZRadius
double	N1
double	N2

Member Typedef Documentation

typedef vtkParametricFunction vtkParametricSuperEllipsoid::Superclass

Reimplemented from vtkParametricFunction.

Definition at line 50 of file vtkParametricSuperEllipsoid.h.

Constructor & Destructor Documentation

vtkParametricSuperEllipsoid::vtkParametricSuperEllipsoid ( ) [protected]

vtkParametricSuperEllipsoid::~vtkParametricSuperEllipsoid ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkParametricFunction.

static int vtkParametricSuperEllipsoid::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 vtkParametricFunction.

virtual int vtkParametricSuperEllipsoid::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 vtkParametricFunction.

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

Reimplemented from vtkParametricFunction.

void vtkParametricSuperEllipsoid::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 vtkParametricFunction.

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

Construct a superellipsoid with the following parameters: MinimumU = 0, MaximumU = 2*Pi, MinimumV = 0, MaximumV = Pi, JoinU = 1, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 0, N1 = 1, N2 = 1, XRadius = 1, YRadius = 1, ZRadius = 1, a sphere in this case.

Reimplemented from vtkObject.

virtual int vtkParametricSuperEllipsoid::GetDimension ( ) [inline, virtual]

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 61 of file vtkParametricSuperEllipsoid.h.

virtual void vtkParametricSuperEllipsoid::SetXRadius ( double ) [virtual]

Set/Get the scaling factor for the x-axis. Default = 1.

virtual double vtkParametricSuperEllipsoid::GetXRadius ( ) [virtual]

Set/Get the scaling factor for the x-axis. Default = 1.

virtual void vtkParametricSuperEllipsoid::SetYRadius ( double ) [virtual]

Set/Get the scaling factor for the y-axis. Default = 1.

virtual double vtkParametricSuperEllipsoid::GetYRadius ( ) [virtual]

Set/Get the scaling factor for the y-axis. Default = 1.

virtual void vtkParametricSuperEllipsoid::SetZRadius ( double ) [virtual]

Set/Get the scaling factor for the z-axis. Default = 1.

virtual double vtkParametricSuperEllipsoid::GetZRadius ( ) [virtual]

Set/Get the scaling factor for the z-axis. Default = 1.

virtual void vtkParametricSuperEllipsoid::SetN1 ( double ) [virtual]

Set/Get the "squareness" parameter in the z axis. Default = 1.

virtual double vtkParametricSuperEllipsoid::GetN1 ( ) [virtual]

Set/Get the "squareness" parameter in the z axis. Default = 1.

virtual void vtkParametricSuperEllipsoid::SetN2 ( double ) [virtual]

Set/Get the "squareness" parameter in the x-y plane. Default = 1.

virtual double vtkParametricSuperEllipsoid::GetN2 ( ) [virtual]

Set/Get the "squareness" parameter in the x-y plane. Default = 1.

virtual void vtkParametricSuperEllipsoid::Evaluate	(	double	uvw[3],
		double	Pt[3],
		double	Duvw[9]
	)			`[virtual]`

A superellipsoid. This function performs the mapping $f(u,v) \rightarrow (x,y,x)$ , returning it as Pt. It also returns the partial derivatives Du and Dv. $Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv)$ . Then the normal is $N = Du X Dv$ .

Implements vtkParametricFunction.

virtual double vtkParametricSuperEllipsoid::EvaluateScalar	(	double	uvw[3],
		double	Pt[3],
		double	Duvw[9]
	)			`[virtual]`

Calculate a user defined scalar using one or all of uvw, Pt, Duvw. uvw are the parameters with Pt being the the cartesian point, Duvw are the derivatives of this point with respect to u, v and w. Pt, Duvw are obtained from Evaluate(). This function is only called if the ScalarMode has the value vtkParametricFunctionSource::SCALAR_FUNCTION_DEFINED If the user does not need to calculate a scalar, then the instantiated function should return zero.

Implements vtkParametricFunction.