vtkParametricDini Class Reference

#include <vtkParametricDini.h>

Inheritance diagram for vtkParametricDini:

[legend]

Collaboration diagram for vtkParametricDini:

[legend]

List of all members.

Detailed Description

Generate Dini's surface.

vtkParametricDini generates Dini's surface. Dini's surface is a surface that posesses constant negative Gaussian curvature

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

Definition at line 40 of file vtkParametricDini.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	SetA (double)
virtual double	GetA ()

virtual void	SetB (double)
virtual double	GetB ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkParametricDini *	SafeDownCast (vtkObject *o)
static vtkParametricDini *	New ()
Protected Member Functions
	vtkParametricDini ()
	~vtkParametricDini ()
Protected Attributes
double	A
double	B

Member Typedef Documentation

typedef vtkParametricFunction vtkParametricDini::Superclass

Reimplemented from vtkParametricFunction.

Definition at line 44 of file vtkParametricDini.h.

Constructor & Destructor Documentation

vtkParametricDini::vtkParametricDini ( ) [protected]

vtkParametricDini::~vtkParametricDini ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkParametricFunction.

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

Reimplemented from vtkParametricFunction.

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

Construct Dini's surface with the following parameters: MinimumU = 0, MaximumU = 4*Pi, MinimumV = 0.001, MaximumV = 2, JoinU = 0, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 1 A = 1, B = 0.2

Reimplemented from vtkObject.

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

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 54 of file vtkParametricDini.h.

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

Set/Get the scale factor. Default = 1.

virtual double vtkParametricDini::GetA ( ) [virtual]

Set/Get the scale factor. Default = 1.

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

Set/Get the scale factor. Default = 0.2

virtual double vtkParametricDini::GetB ( ) [virtual]

Set/Get the scale factor. Default = 0.2

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

Dini'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 vtkParametricDini::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.