Generate a supertoroid. More...

#include <vtkParametricSuperToroid.h>

Inheritance diagram for vtkParametricSuperToroid:

Collaboration diagram for vtkParametricSuperToroid:

Public Types
typedef vtkParametricFunction	Superclass

Public Types inherited from vtkParametricFunction
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkParametricSuperToroid *	NewInstance () 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 ()


virtual void	SetXRadius (double)

virtual double	GetXRadius ()


virtual void	SetYRadius (double)

virtual double	GetYRadius ()


virtual void	SetZRadius (double)

virtual double	GetZRadius ()


virtual void	SetN1 (double)

virtual double	GetN1 ()


virtual void	SetN2 (double)

virtual double	GetN2 ()

Public Member Functions inherited from vtkParametricFunction
vtkParametricFunction *	NewInstance () const

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	SetJoinW (int)

virtual int	GetJoinW ()

virtual void	JoinWOn ()

virtual void	JoinWOff ()

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	SetTwistW (int)

virtual int	GetTwistW ()

virtual void	TwistWOn ()

virtual void	TwistWOff ()

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

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkParametricSuperToroid *	SafeDownCast (vtkObjectBase *o)

static vtkParametricSuperToroid *	New ()

Static Public Member Functions inherited from vtkParametricFunction
static int	IsTypeOf (const char *type)

static vtkParametricFunction *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkParametricSuperToroid ()

	~vtkParametricSuperToroid ()

Protected Member Functions inherited from vtkParametricFunction
	vtkParametricFunction ()

virtual	~vtkParametricFunction ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	RingRadius

double	CrossSectionRadius

double	XRadius

double	YRadius

double	ZRadius

double	N1

double	N2

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

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Generate a supertoroid.

vtkParametricSuperToroid generates a supertoroid. Essentially a supertoroid is a torus with the sine and cosine terms raised to a power. A supertoroid is a versatile primitive that is controlled by four parameters r0, r1, n1 and n2. r0, r1 determine the type of torus whilst the value of n1 determines the shape of the torus ring and n2 determines the shape of the cross section of the ring. It is the different values of these powers which give rise to a family of 3D shapes that are all basically toroidal in shape.

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.

Also see: http://paulbourke.net/geometry/torus/#super.

Warning: Care needs to be taken specifying the bounds correctly. You may need to carefully adjust MinimumU, MinimumV, MaximumU, MaximumV.

Thanks:: Andrew Maclean andre.nosp@m.w.am.nosp@m.aclea.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om for creating and contributing the class.

Tests:: vtkParametricSuperToroid (Tests)

Definition at line 52 of file vtkParametricSuperToroid.h.

Member Typedef Documentation

typedef vtkParametricFunction vtkParametricSuperToroid::Superclass

Definition at line 55 of file vtkParametricSuperToroid.h.

Constructor & Destructor Documentation

vtkParametricSuperToroid::vtkParametricSuperToroid ( )

protected

vtkParametricSuperToroid::~vtkParametricSuperToroid ( )

protected

Member Function Documentation

static int vtkParametricSuperToroid::IsTypeOf ( const char * type )

static

virtual int vtkParametricSuperToroid::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 vtkParametricSuperToroid* vtkParametricSuperToroid::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkParametricSuperToroid::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkParametricFunction.

vtkParametricSuperToroid* vtkParametricSuperToroid::NewInstance ( ) const

void vtkParametricSuperToroid::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 vtkParametricSuperToroid* vtkParametricSuperToroid::New ( )

static

Construct a supertoroid 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 = 0, RingRadius = 1, CrossSectionRadius = 0.5, N1 = 1, N2 = 1, XRadius = 1, YRadius = 1, ZRadius = 1, a torus in this case.

virtual int vtkParametricSuperToroid::GetDimension ( )

inlinevirtual

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 66 of file vtkParametricSuperToroid.h.

virtual void vtkParametricSuperToroid::SetRingRadius ( double )

virtual

Set/Get the radius from the center to the middle of the ring of the supertoroid. Default is 1.

virtual double vtkParametricSuperToroid::GetRingRadius ( )

virtual

Set/Get the radius from the center to the middle of the ring of the supertoroid. Default is 1.

virtual void vtkParametricSuperToroid::SetCrossSectionRadius ( double )

virtual

Set/Get the radius of the cross section of ring of the supertoroid. Default = 0.5.

virtual double vtkParametricSuperToroid::GetCrossSectionRadius ( )

virtual

Set/Get the radius of the cross section of ring of the supertoroid. Default = 0.5.

virtual void vtkParametricSuperToroid::SetXRadius ( double )

virtual

Set/Get the scaling factor for the x-axis. Default is 1.

virtual double vtkParametricSuperToroid::GetXRadius ( )

virtual

Set/Get the scaling factor for the x-axis. Default is 1.

virtual void vtkParametricSuperToroid::SetYRadius ( double )

virtual

Set/Get the scaling factor for the y-axis. Default is 1.

virtual double vtkParametricSuperToroid::GetYRadius ( )

virtual

Set/Get the scaling factor for the y-axis. Default is 1.

virtual void vtkParametricSuperToroid::SetZRadius ( double )

virtual

Set/Get the scaling factor for the z-axis. Default is 1.

virtual double vtkParametricSuperToroid::GetZRadius ( )

virtual

Set/Get the scaling factor for the z-axis. Default is 1.

virtual void vtkParametricSuperToroid::SetN1 ( double )

virtual

Set/Get the shape of the torus ring. Default is 1.

virtual double vtkParametricSuperToroid::GetN1 ( )

virtual

Set/Get the shape of the torus ring. Default is 1.

virtual void vtkParametricSuperToroid::SetN2 ( double )

virtual

Set/Get the shape of the cross section of the ring. Default is 1.

virtual double vtkParametricSuperToroid::GetN2 ( )

virtual

Set/Get the shape of the cross section of the ring. Default is 1.

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

virtual

A supertoroid. 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 vtkParametricSuperToroid::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.