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

Generate an ellipsoid. More...

#include <vtkParametricEllipsoid.h>

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

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 
vtkParametricEllipsoidNewInstance () 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 ()
 
- 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 vtkParametricEllipsoidSafeDownCast (vtkObjectBase *o)
 
static vtkParametricEllipsoidNew ()
 
- Static Public Member Functions inherited from vtkParametricFunction
static int IsTypeOf (const char *type)
 
static vtkParametricFunctionSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkParametricEllipsoid ()
 
 ~vtkParametricEllipsoid ()
 
- 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 an ellipsoid.

vtkParametricEllipsoid generates an ellipsoid. If all the radii are the same, we have a sphere. An oblate spheroid occurs if RadiusX = RadiusY > RadiusZ. Here the Z-axis forms the symmetry axis. To a first approximation, this is the shape of the earth. A prolate spheroid occurs if RadiusX = RadiusY < RadiusZ.

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.

Thanks:
Andrew Maclean a.mac.nosp@m.lean.nosp@m.@cas..nosp@m.edu..nosp@m.au for creating and contributing the class.
Tests:
vtkParametricEllipsoid (Tests)

Definition at line 44 of file vtkParametricEllipsoid.h.

Member Typedef Documentation

Definition at line 47 of file vtkParametricEllipsoid.h.

Constructor & Destructor Documentation

vtkParametricEllipsoid::vtkParametricEllipsoid ( )
protected
vtkParametricEllipsoid::~vtkParametricEllipsoid ( )
protected

Member Function Documentation

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

Reimplemented from vtkParametricFunction.

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

Reimplemented from vtkParametricFunction.

vtkParametricEllipsoid* vtkParametricEllipsoid::NewInstance ( ) const
void vtkParametricEllipsoid::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkParametricEllipsoid* vtkParametricEllipsoid::New ( )
static

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

virtual int vtkParametricEllipsoid::GetDimension ( )
inlinevirtual

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 57 of file vtkParametricEllipsoid.h.

virtual void vtkParametricEllipsoid::SetXRadius ( double  )
virtual

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

virtual double vtkParametricEllipsoid::GetXRadius ( )
virtual

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

virtual void vtkParametricEllipsoid::SetYRadius ( double  )
virtual

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

virtual double vtkParametricEllipsoid::GetYRadius ( )
virtual

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

virtual void vtkParametricEllipsoid::SetZRadius ( double  )
virtual

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

virtual double vtkParametricEllipsoid::GetZRadius ( )
virtual

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

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

An ellipsoid. 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 vtkParametricEllipsoid::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 vtkParametricEllipsoid::XRadius
protected

Definition at line 99 of file vtkParametricEllipsoid.h.

double vtkParametricEllipsoid::YRadius
protected

Definition at line 100 of file vtkParametricEllipsoid.h.

double vtkParametricEllipsoid::ZRadius
protected

Definition at line 101 of file vtkParametricEllipsoid.h.

double vtkParametricEllipsoid::N1
protected

Definition at line 102 of file vtkParametricEllipsoid.h.

double vtkParametricEllipsoid::N2
protected

Definition at line 103 of file vtkParametricEllipsoid.h.


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