vtkParametricTorus Class Reference

#include <vtkParametricTorus.h>

Inheritance diagram for vtkParametricTorus:

[legend]

Collaboration diagram for vtkParametricTorus:

[legend]

List of all members.

Detailed Description

Generate a torus.

vtkParametricTorus generates a torus.

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

Definition at line 38 of file vtkParametricTorus.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	SetRingRadius (double)
virtual double	GetRingRadius ()

virtual void	SetCrossSectionRadius (double)
virtual double	GetCrossSectionRadius ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkParametricTorus *	SafeDownCast (vtkObject *o)
static vtkParametricTorus *	New ()
Protected Member Functions
	vtkParametricTorus ()
	~vtkParametricTorus ()
Protected Attributes
double	RingRadius
double	CrossSectionRadius

Member Typedef Documentation

typedef vtkParametricFunction vtkParametricTorus::Superclass

Reimplemented from vtkParametricFunction.

Definition at line 42 of file vtkParametricTorus.h.

Constructor & Destructor Documentation

vtkParametricTorus::vtkParametricTorus ( ) [protected]

vtkParametricTorus::~vtkParametricTorus ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkParametricFunction.

static int vtkParametricTorus::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkParametricFunction.

virtual int vtkParametricTorus::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkParametricFunction.

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

Reimplemented from vtkParametricFunction.

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

Construct a torus with the following parameters: MinimumU = 0, MaximumU = 2*Pi, MinimumV = 0, MaximumV = 2*Pi, JoinU = 1, JoinV = 1, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 1, RingRadius = 1, CrossSectionRadius = 0.5.

Reimplemented from vtkObject.

virtual void vtkParametricTorus::SetRingRadius ( double ) [virtual]

Set/Get the radius from the center to the middle of the ring of the torus. The default value is 1.0.

virtual double vtkParametricTorus::GetRingRadius ( ) [virtual]

Set/Get the radius from the center to the middle of the ring of the torus. The default value is 1.0.

virtual void vtkParametricTorus::SetCrossSectionRadius ( double ) [virtual]

Set/Get the radius of the cross section of ring of the torus. The default value is 0.5.

virtual double vtkParametricTorus::GetCrossSectionRadius ( ) [virtual]

Set/Get the radius of the cross section of ring of the torus. The default value is 0.5.

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

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 66 of file vtkParametricTorus.h.

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

A torus. 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 vtkParametricTorus::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.