vtkParametricBoy Class Reference

#include <vtkParametricBoy.h>

Inheritance diagram for vtkParametricBoy:

Inheritance graph
[legend]
Collaboration diagram for vtkParametricBoy:

Collaboration graph
[legend]

List of all members.


Detailed Description

Generate Boy's surface.

vtkParametricBoy generates Boy's surface. This is a Model of the projective plane without singularities. It was found by Werner Boy on assignment from David Hilbert.

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

Definition at line 40 of file vtkParametricBoy.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 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 SetZScale (double)
virtual double GetZScale ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkParametricBoySafeDownCast (vtkObject *o)
static vtkParametricBoyNew ()

Protected Member Functions

 vtkParametricBoy ()
 ~vtkParametricBoy ()

Protected Attributes

double ZScale

Member Typedef Documentation

Reimplemented from vtkParametricFunction.

Definition at line 44 of file vtkParametricBoy.h.


Constructor & Destructor Documentation

vtkParametricBoy::vtkParametricBoy (  )  [protected]

vtkParametricBoy::~vtkParametricBoy (  )  [protected]


Member Function Documentation

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

Reimplemented from vtkParametricFunction.

static int vtkParametricBoy::IsTypeOf ( const char *  name  )  [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 vtkParametricBoy::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkParametricFunction.

static vtkParametricBoy* vtkParametricBoy::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkParametricFunction.

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

Construct Boy's surface with the following parameters: MinimumU = 0, MaximumU = Pi, MinimumV = 0, MaximumV = Pi, JoinU = 1, JoinV = 1, TwistU = 1, TwistV = 1; ClockwiseOrdering = 1, DerivativesAvailable = 1, ZScale = 0.125.

Reimplemented from vtkObject.

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

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 54 of file vtkParametricBoy.h.

virtual void vtkParametricBoy::SetZScale ( double   )  [virtual]

Set/Get the scale factor for the z-coordinate. Default = 1/8, giving a nice shape.

virtual double vtkParametricBoy::GetZScale (  )  [virtual]

Set/Get the scale factor for the z-coordinate. Default = 1/8, giving a nice shape.

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

Boy's 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 vtkParametricBoy::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 vtkParametricBoy::ZScale [protected]

Definition at line 85 of file vtkParametricBoy.h.


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

Generated on Wed Jun 3 19:22:27 2009 for VTK by  doxygen 1.5.6