Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkParametricEllipsoid Class Reference

#include <vtkParametricEllipsoid.h>

Inheritance diagram for vtkParametricEllipsoid:

Inheritance graph
[legend]
Collaboration diagram for vtkParametricEllipsoid:

Collaboration graph
[legend]
List of all members.

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.maclean@cas.edu.au for creating and contributing the class.
Tests:
vtkParametricEllipsoid (Tests)

Definition at line 43 of file vtkParametricEllipsoid.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 void Evaluate (double uvw[3], double Pt[3], double Duvw[9])
virtual double EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9])
virtual int GetDimension ()
virtual void SetXRadius (double)
virtual double GetXRadius ()
virtual void SetYRadius (double)
virtual double GetYRadius ()
virtual void SetZRadius (double)
virtual double GetZRadius ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkParametricEllipsoid * SafeDownCast (vtkObject *o)
static vtkParametricEllipsoid * New ()

Protected Member Functions

 vtkParametricEllipsoid ()
 ~vtkParametricEllipsoid ()

Protected Attributes

double XRadius
double YRadius
double ZRadius
double N1
double N2

Member Typedef Documentation

typedef vtkParametricFunction vtkParametricEllipsoid::Superclass
 

Reimplemented from vtkParametricFunction.

Definition at line 46 of file vtkParametricEllipsoid.h.

Constructor & Destructor Documentation

vtkParametricEllipsoid::vtkParametricEllipsoid (   )  [protected]
 

vtkParametricEllipsoid::~vtkParametricEllipsoid (   )  [protected]
 

Member Function Documentation

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

Reimplemented from vtkParametricFunction.

static int vtkParametricEllipsoid::IsTypeOf (  const char *  type  )  [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 vtkParametricEllipsoid::IsA (  const char *  type  )  [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 vtkParametricEllipsoid* vtkParametricEllipsoid::SafeDownCast (  vtkObject *  o  )  [static]
 

Reimplemented from vtkParametricFunction.

void vtkParametricEllipsoid::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 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.

Reimplemented from vtkObject.

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

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 56 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]
 

Return the parametric dimension of the class.

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 98 of file vtkParametricEllipsoid.h.

double vtkParametricEllipsoid::YRadius [protected]
 

Definition at line 99 of file vtkParametricEllipsoid.h.

double vtkParametricEllipsoid::ZRadius [protected]
 

Definition at line 100 of file vtkParametricEllipsoid.h.

double vtkParametricEllipsoid::N1 [protected]
 

Definition at line 101 of file vtkParametricEllipsoid.h.

double vtkParametricEllipsoid::N2 [protected]
 

Definition at line 102 of file vtkParametricEllipsoid.h.

The documentation for this class was generated from the following file:
Generated on Tue Jan 22 00:05:35 2008 for VTK by  doxygen 1.4.3-20050530