VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkParametricTorus Class Reference

Generate a torus. More...

#include <vtkParametricTorus.h>

Inheritance diagram for vtkParametricTorus:
[legend]
Collaboration diagram for vtkParametricTorus:
[legend]

Public Types

typedef vtkParametricFunction Superclass
 
- Public Types inherited from vtkParametricFunction
typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkParametricTorusNewInstance () const
 
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 ()
 
- Public Member Functions inherited from vtkParametricFunction
vtkParametricFunctionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetMinimumU (double)
 
virtual double GetMinimumU ()
 
virtual void SetMaximumU (double)
 
virtual double GetMaximumU ()
 
virtual void SetMinimumV (double)
 
virtual double GetMinimumV ()
 
virtual void SetMaximumV (double)
 
virtual double GetMaximumV ()
 
virtual void SetMinimumW (double)
 
virtual double GetMinimumW ()
 
virtual void SetMaximumW (double)
 
virtual double GetMaximumW ()
 
virtual void SetJoinU (int)
 
virtual int GetJoinU ()
 
virtual void JoinUOn ()
 
virtual void JoinUOff ()
 
virtual void SetJoinV (int)
 
virtual int GetJoinV ()
 
virtual void JoinVOn ()
 
virtual void JoinVOff ()
 
virtual void SetTwistU (int)
 
virtual int GetTwistU ()
 
virtual void TwistUOn ()
 
virtual void TwistUOff ()
 
virtual void SetTwistV (int)
 
virtual int GetTwistV ()
 
virtual void TwistVOn ()
 
virtual void TwistVOff ()
 
virtual void SetClockwiseOrdering (int)
 
virtual int GetClockwiseOrdering ()
 
virtual void ClockwiseOrderingOn ()
 
virtual void ClockwiseOrderingOff ()
 
virtual void SetDerivativesAvailable (int)
 
virtual int GetDerivativesAvailable ()
 
virtual void DerivativesAvailableOn ()
 
virtual void DerivativesAvailableOff ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkParametricTorusSafeDownCast (vtkObjectBase *o)
 
static vtkParametricTorusNew ()
 
- Static Public Member Functions inherited from vtkParametricFunction
static int IsTypeOf (const char *type)
 
static vtkParametricFunctionSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkParametricTorus ()
 
 ~vtkParametricTorus ()
 
- Protected Member Functions inherited from vtkParametricFunction
 vtkParametricFunction ()
 
virtual ~vtkParametricFunction ()
 

Protected Attributes

double RingRadius
 
double CrossSectionRadius
 
- Protected Attributes inherited from vtkParametricFunction
double MinimumU
 
double MaximumU
 
double MinimumV
 
double MaximumV
 
double MinimumW
 
double MaximumW
 
int JoinU
 
int JoinV
 
int JoinW
 
int TwistU
 
int TwistV
 
int TwistW
 
int ClockwiseOrdering
 
int DerivativesAvailable
 

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.mac.nosp@m.lean.nosp@m.@cas..nosp@m.edu..nosp@m.au for creating and contributing the class.
Tests:
vtkParametricTorus (Tests)

Definition at line 39 of file vtkParametricTorus.h.

Member Typedef Documentation

Definition at line 43 of file vtkParametricTorus.h.

Constructor & Destructor Documentation

vtkParametricTorus::vtkParametricTorus ( )
protected
vtkParametricTorus::~vtkParametricTorus ( )
protected

Member Function Documentation

static int vtkParametricTorus::IsTypeOf ( const char *  type)
static
virtual int vtkParametricTorus::IsA ( const char *  type)
virtual

Reimplemented from vtkParametricFunction.

static vtkParametricTorus* vtkParametricTorus::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkParametricTorus::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkParametricFunction.

vtkParametricTorus* vtkParametricTorus::NewInstance ( ) const
void vtkParametricTorus::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

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 ( )
inlinevirtual

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 67 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.

Member Data Documentation

double vtkParametricTorus::RingRadius
protected

Definition at line 90 of file vtkParametricTorus.h.

double vtkParametricTorus::CrossSectionRadius
protected

Definition at line 91 of file vtkParametricTorus.h.


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