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 Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkParametricSuperToroid *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

int	GetDimension () override
	Return the parametric dimension of the class. More...

void	Evaluate (double uvw[3], double Pt[3], double Duvw[9]) override
	A supertoroid. More...

double	EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9]) override
	Calculate a user defined scalar using one or all of uvw, Pt, Duvw. More...


virtual void	SetRingRadius (double)
	Set/Get the radius from the center to the middle of the ring of the supertoroid. More...

virtual double	GetRingRadius ()
	Set/Get the radius from the center to the middle of the ring of the supertoroid. More...


virtual void	SetCrossSectionRadius (double)
	Set/Get the radius of the cross section of ring of the supertoroid. More...

virtual double	GetCrossSectionRadius ()
	Set/Get the radius of the cross section of ring of the supertoroid. More...


virtual void	SetXRadius (double)
	Set/Get the scaling factor for the x-axis. More...

virtual double	GetXRadius ()
	Set/Get the scaling factor for the x-axis. More...


virtual void	SetYRadius (double)
	Set/Get the scaling factor for the y-axis. More...

virtual double	GetYRadius ()
	Set/Get the scaling factor for the y-axis. More...


virtual void	SetZRadius (double)
	Set/Get the scaling factor for the z-axis. More...

virtual double	GetZRadius ()
	Set/Get the scaling factor for the z-axis. More...


virtual void	SetN1 (double)
	Set/Get the shape of the torus ring. More...

virtual double	GetN1 ()
	Set/Get the shape of the torus ring. More...


virtual void	SetN2 (double)
	Set/Get the shape of the cross section of the ring. More...

virtual double	GetN2 ()
	Set/Get the shape of the cross section of the ring. More...

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

virtual void	SetMinimumU (double)
	Set/Get the minimum u-value. More...

virtual double	GetMinimumU ()
	Set/Get the minimum u-value. More...

virtual void	SetMaximumU (double)
	Set/Get the maximum u-value. More...

virtual double	GetMaximumU ()
	Set/Get the maximum u-value. More...

virtual void	SetMinimumV (double)
	Set/Get the minimum v-value. More...

virtual double	GetMinimumV ()
	Set/Get the minimum v-value. More...

virtual void	SetMaximumV (double)
	Set/Get the maximum v-value. More...

virtual double	GetMaximumV ()
	Set/Get the maximum v-value. More...

virtual void	SetMinimumW (double)
	Set/Get the minimum w-value. More...

virtual double	GetMinimumW ()
	Set/Get the minimum w-value. More...

virtual void	SetMaximumW (double)
	Set/Get the maximum w-value. More...

virtual double	GetMaximumW ()
	Set/Get the maximum w-value. More...

virtual void	SetJoinU (vtkTypeBool)
	Set/Get the flag which joins the first triangle strip to the last one. More...

virtual vtkTypeBool	GetJoinU ()
	Set/Get the flag which joins the first triangle strip to the last one. More...

virtual void	JoinUOn ()
	Set/Get the flag which joins the first triangle strip to the last one. More...

virtual void	JoinUOff ()
	Set/Get the flag which joins the first triangle strip to the last one. More...

virtual void	SetJoinV (vtkTypeBool)
	Set/Get the flag which joins the ends of the triangle strips. More...

virtual vtkTypeBool	GetJoinV ()
	Set/Get the flag which joins the ends of the triangle strips. More...

virtual void	JoinVOn ()
	Set/Get the flag which joins the ends of the triangle strips. More...

virtual void	JoinVOff ()
	Set/Get the flag which joins the ends of the triangle strips. More...

virtual void	SetJoinW (vtkTypeBool)
	Set/Get the flag which joins the ends of the triangle strips. More...

virtual vtkTypeBool	GetJoinW ()
	Set/Get the flag which joins the ends of the triangle strips. More...

virtual void	JoinWOn ()
	Set/Get the flag which joins the ends of the triangle strips. More...

virtual void	JoinWOff ()
	Set/Get the flag which joins the ends of the triangle strips. More...

virtual void	SetTwistU (vtkTypeBool)
	Set/Get the flag which joins the first triangle strip to the last one with a twist. More...

virtual vtkTypeBool	GetTwistU ()
	Set/Get the flag which joins the first triangle strip to the last one with a twist. More...

virtual void	TwistUOn ()
	Set/Get the flag which joins the first triangle strip to the last one with a twist. More...

virtual void	TwistUOff ()
	Set/Get the flag which joins the first triangle strip to the last one with a twist. More...

virtual void	SetTwistV (vtkTypeBool)
	Set/Get the flag which joins the ends of the triangle strips with a twist. More...

virtual vtkTypeBool	GetTwistV ()
	Set/Get the flag which joins the ends of the triangle strips with a twist. More...

virtual void	TwistVOn ()
	Set/Get the flag which joins the ends of the triangle strips with a twist. More...

virtual void	TwistVOff ()
	Set/Get the flag which joins the ends of the triangle strips with a twist. More...

virtual void	SetTwistW (vtkTypeBool)
	Set/Get the flag which joins the ends of the triangle strips with a twist. More...

virtual vtkTypeBool	GetTwistW ()
	Set/Get the flag which joins the ends of the triangle strips with a twist. More...

virtual void	TwistWOn ()
	Set/Get the flag which joins the ends of the triangle strips with a twist. More...

virtual void	TwistWOff ()
	Set/Get the flag which joins the ends of the triangle strips with a twist. More...

virtual void	SetClockwiseOrdering (vtkTypeBool)
	Set/Get the flag which determines the ordering of the vertices forming the triangle strips. More...

virtual vtkTypeBool	GetClockwiseOrdering ()
	Set/Get the flag which determines the ordering of the vertices forming the triangle strips. More...

virtual void	ClockwiseOrderingOn ()
	Set/Get the flag which determines the ordering of the vertices forming the triangle strips. More...

virtual void	ClockwiseOrderingOff ()
	Set/Get the flag which determines the ordering of the vertices forming the triangle strips. More...

virtual void	SetDerivativesAvailable (vtkTypeBool)
	Set/Get the flag which determines whether derivatives are available from the parametric function (i.e., whether the Evaluate() method returns valid derivatives). More...

virtual vtkTypeBool	GetDerivativesAvailable ()
	Set/Get the flag which determines whether derivatives are available from the parametric function (i.e., whether the Evaluate() method returns valid derivatives). More...

virtual void	DerivativesAvailableOn ()
	Set/Get the flag which determines whether derivatives are available from the parametric function (i.e., whether the Evaluate() method returns valid derivatives). More...

virtual void	DerivativesAvailableOff ()
	Set/Get the flag which determines whether derivatives are available from the parametric function (i.e., whether the Evaluate() method returns valid derivatives). More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

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

static vtkParametricSuperToroid *	SafeDownCast (vtkObjectBase *o)

static vtkParametricSuperToroid *	New ()
	Construct a supertoroid with the following parameters: MinimumU = 0, MaximumU = 2Pi, MinimumV = 0, MaximumV = 2Pi, JoinU = 0, JoinV = 0, 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. More...

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

static vtkParametricFunction *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkParametricSuperToroid ()

	~vtkParametricSuperToroid () override

Protected Member Functions inherited from vtkParametricFunction
	vtkParametricFunction ()

	~vtkParametricFunction () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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

vtkTypeBool	JoinU

vtkTypeBool	JoinV

vtkTypeBool	JoinW

vtkTypeBool	TwistU

vtkTypeBool	TwistV

vtkTypeBool	TwistW

vtkTypeBool	ClockwiseOrdering

vtkTypeBool	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/publications 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 53 of file vtkParametricSuperToroid.h.

Member Typedef Documentation

typedef vtkParametricFunction vtkParametricSuperToroid::Superclass

Definition at line 57 of file vtkParametricSuperToroid.h.

Constructor & Destructor Documentation

vtkParametricSuperToroid::vtkParametricSuperToroid ( )

protected

vtkParametricSuperToroid::~vtkParametricSuperToroid ( )

overrideprotected

Member Function Documentation

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

static

virtual vtkTypeBool 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
	)

overridevirtual

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 = 0, JoinV = 0, 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.

int vtkParametricSuperToroid::GetDimension ( )

inlineoverridevirtual

Return the parametric dimension of the class.

Implements vtkParametricFunction.

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

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

overridevirtual

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.

double vtkParametricSuperToroid::EvaluateScalar	(	double	uvw[3],
		double	Pt[3],
		double	Duvw[9]
	)

overridevirtual

Calculate a user defined scalar using one or all of uvw, Pt, Duvw.

uvw are the parameters with Pt being 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.