VTK
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 Types inherited from vtkObject
typedef vtkObjectBase 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 ()
 
- Public Member Functions inherited from vtkParametricFunction
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 ()
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char 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)
 
vtkCommandGetCommand (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)
 
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)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static
vtkParametricSuperEllipsoid
SafeDownCast (vtkObject *o)
 
static
vtkParametricSuperEllipsoid
New ()
 
- Static Public Member Functions inherited from vtkParametricFunction
static int IsTypeOf (const char *type)
 
static vtkParametricFunctionSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

 vtkParametricSuperEllipsoid ()
 
 ~vtkParametricSuperEllipsoid ()
 
- Protected Member Functions inherited from vtkParametricFunction
 vtkParametricFunction ()
 
virtual ~vtkParametricFunction ()
 
- 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 &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

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
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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 47 of file vtkParametricSuperEllipsoid.h.

Member Typedef Documentation

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 *  type)
static
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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkParametricFunction.

static vtkParametricSuperEllipsoid* vtkParametricSuperEllipsoid::SafeDownCast ( vtkObject o)
static
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.

virtual int vtkParametricSuperEllipsoid::GetDimension ( )
inlinevirtual

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.

Member Data Documentation

double vtkParametricSuperEllipsoid::XRadius
protected

Definition at line 115 of file vtkParametricSuperEllipsoid.h.

double vtkParametricSuperEllipsoid::YRadius
protected

Definition at line 116 of file vtkParametricSuperEllipsoid.h.

double vtkParametricSuperEllipsoid::ZRadius
protected

Definition at line 117 of file vtkParametricSuperEllipsoid.h.

double vtkParametricSuperEllipsoid::N1
protected

Definition at line 118 of file vtkParametricSuperEllipsoid.h.

double vtkParametricSuperEllipsoid::N2
protected

Definition at line 119 of file vtkParametricSuperEllipsoid.h.


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