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

vtkParametricConicSpiral Class Reference

#include <vtkParametricConicSpiral.h>

Inheritance diagram for vtkParametricConicSpiral:

Inheritance graph
[legend]
Collaboration diagram for vtkParametricConicSpiral:

Collaboration graph
[legend]
List of all members.

Detailed Description

Generate conic spiral surfaces that resemble sea-shells.

vtkParametricConicSpiral generates conic spiral surfaces. These can resemble sea shells, or may look like a torus "eating" its own tail.

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:
vtkParametricConicSpiral (Tests)

Definition at line 39 of file vtkParametricConicSpiral.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 SetA (double)
virtual double GetA ()
virtual void SetB (double)
virtual double GetB ()
virtual void SetC (double)
virtual double GetC ()
virtual void SetN (double)
virtual double GetN ()

Static Public Member Functions

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

Protected Member Functions

 vtkParametricConicSpiral ()
 ~vtkParametricConicSpiral ()

Protected Attributes

double A
double B
double C
double N

Member Typedef Documentation

typedef vtkParametricFunction vtkParametricConicSpiral::Superclass
 

Reimplemented from vtkParametricFunction.

Definition at line 42 of file vtkParametricConicSpiral.h.

Constructor & Destructor Documentation

vtkParametricConicSpiral::vtkParametricConicSpiral (   )  [protected]
 

vtkParametricConicSpiral::~vtkParametricConicSpiral (   )  [protected]
 

Member Function Documentation

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

Reimplemented from vtkParametricFunction.

static int vtkParametricConicSpiral::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 vtkParametricConicSpiral::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 vtkParametricConicSpiral* vtkParametricConicSpiral::SafeDownCast (  vtkObject *  o  )  [static]
 

Reimplemented from vtkParametricFunction.

void vtkParametricConicSpiral::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 vtkParametricConicSpiral* vtkParametricConicSpiral::New (   )  [static]
 

Construct a conic spiral surface with the following parameters: MinimumU = 0, MaximumU = 2Pi, MinimumV = 0, MaximumV = 2Pi, JoinU = 0, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 1, A = 0.2, B = 1.0, C = 0.1, N = 2.

Reimplemented from vtkObject.

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

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 52 of file vtkParametricConicSpiral.h.

virtual void vtkParametricConicSpiral::SetA (  double   )  [virtual]
 

Set/Get the scale factor. Default = 0.2

virtual double vtkParametricConicSpiral::GetA (   )  [virtual]
 

Return the parametric dimension of the class.

virtual void vtkParametricConicSpiral::SetB (  double   )  [virtual]
 

Set/Get the A function coefficient (see equation below). Default = 1.

virtual double vtkParametricConicSpiral::GetB (   )  [virtual]
 

Set/Get the A function coefficient (see equation below). Default = 1.

virtual void vtkParametricConicSpiral::SetC (  double   )  [virtual]
 

Set/Get the B function coefficient (see equation below). Default = 0.1.

virtual double vtkParametricConicSpiral::GetC (   )  [virtual]
 

Set/Get the B function coefficient (see equation below). Default = 0.1.

virtual void vtkParametricConicSpiral::SetN (  double   )  [virtual]
 

Set/Get the C function coefficient (see equation below). Default = 2.

virtual double vtkParametricConicSpiral::GetN (   )  [virtual]
 

Set/Get the C function coefficient (see equation below). Default = 2.

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

A conic spiral surface. 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 vtkParametricConicSpiral::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 vtkParametricConicSpiral::A [protected]
 

Definition at line 101 of file vtkParametricConicSpiral.h.

double vtkParametricConicSpiral::B [protected]
 

Definition at line 102 of file vtkParametricConicSpiral.h.

double vtkParametricConicSpiral::C [protected]
 

Definition at line 103 of file vtkParametricConicSpiral.h.

double vtkParametricConicSpiral::N [protected]
 

Definition at line 104 of file vtkParametricConicSpiral.h.

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