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

Generate a superellipsoid. More...

#include <vtkParametricSuperEllipsoid.h>

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

Public Types

typedef vtkParametricFunction Superclass
 
- Public Types inherited from vtkParametricFunction
typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkParametricSuperEllipsoidNewInstance () const
 
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 ()
 
- Public Member Functions inherited from vtkParametricFunction
vtkParametricFunctionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetMinimumU (double)
 
virtual double GetMinimumU ()
 
virtual void SetMaximumU (double)
 
virtual double GetMaximumU ()
 
virtual void SetMinimumV (double)
 
virtual double GetMinimumV ()
 
virtual void SetMaximumV (double)
 
virtual double GetMaximumV ()
 
virtual void SetMinimumW (double)
 
virtual double GetMinimumW ()
 
virtual void SetMaximumW (double)
 
virtual double GetMaximumW ()
 
virtual void SetJoinU (int)
 
virtual int GetJoinU ()
 
virtual void JoinUOn ()
 
virtual void JoinUOff ()
 
virtual void SetJoinV (int)
 
virtual int GetJoinV ()
 
virtual void JoinVOn ()
 
virtual void JoinVOff ()
 
virtual void SetTwistU (int)
 
virtual int GetTwistU ()
 
virtual void TwistUOn ()
 
virtual void TwistUOff ()
 
virtual void SetTwistV (int)
 
virtual int GetTwistV ()
 
virtual void TwistVOn ()
 
virtual void TwistVOff ()
 
virtual void SetClockwiseOrdering (int)
 
virtual int GetClockwiseOrdering ()
 
virtual void ClockwiseOrderingOn ()
 
virtual void ClockwiseOrderingOff ()
 
virtual void SetDerivativesAvailable (int)
 
virtual int GetDerivativesAvailable ()
 
virtual void DerivativesAvailableOn ()
 
virtual void DerivativesAvailableOff ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static
vtkParametricSuperEllipsoid
SafeDownCast (vtkObjectBase *o)
 
static
vtkParametricSuperEllipsoid
New ()
 
- Static Public Member Functions inherited from vtkParametricFunction
static int IsTypeOf (const char *type)
 
static vtkParametricFunctionSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkParametricSuperEllipsoid ()
 
 ~vtkParametricSuperEllipsoid ()
 
- Protected Member Functions inherited from vtkParametricFunction
 vtkParametricFunction ()
 
virtual ~vtkParametricFunction ()
 

Protected Attributes

double XRadius
 
double YRadius
 
double ZRadius
 
double N1
 
double N2
 
- Protected Attributes inherited from vtkParametricFunction
double MinimumU
 
double MaximumU
 
double MinimumV
 
double MaximumV
 
double MinimumW
 
double MaximumW
 
int JoinU
 
int JoinV
 
int JoinW
 
int TwistU
 
int TwistV
 
int TwistW
 
int ClockwiseOrdering
 
int DerivativesAvailable
 

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.mac.nosp@m.lean.nosp@m.@cas..nosp@m.edu..nosp@m.au for creating and contributing the class.
Tests:
vtkParametricSuperEllipsoid (Tests)

Definition at line 48 of file vtkParametricSuperEllipsoid.h.

Member Typedef Documentation

Definition at line 51 of file vtkParametricSuperEllipsoid.h.

Constructor & Destructor Documentation

vtkParametricSuperEllipsoid::vtkParametricSuperEllipsoid ( )
protected
vtkParametricSuperEllipsoid::~vtkParametricSuperEllipsoid ( )
protected

Member Function Documentation

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

Reimplemented from vtkParametricFunction.

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

Reimplemented from vtkParametricFunction.

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

virtual int vtkParametricSuperEllipsoid::GetDimension ( )
inlinevirtual

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 62 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.

Member Data Documentation

double vtkParametricSuperEllipsoid::XRadius
protected

Definition at line 116 of file vtkParametricSuperEllipsoid.h.

double vtkParametricSuperEllipsoid::YRadius
protected

Definition at line 117 of file vtkParametricSuperEllipsoid.h.

double vtkParametricSuperEllipsoid::ZRadius
protected

Definition at line 118 of file vtkParametricSuperEllipsoid.h.

double vtkParametricSuperEllipsoid::N1
protected

Definition at line 119 of file vtkParametricSuperEllipsoid.h.

double vtkParametricSuperEllipsoid::N2
protected

Definition at line 120 of file vtkParametricSuperEllipsoid.h.


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