vtkParametricTorus Class Reference

Generate a torus. More...

#include <vtkParametricTorus.h>

Inheritance diagram for vtkParametricTorus:

Collaboration diagram for vtkParametricTorus:

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.
vtkParametricTorus *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int	GetDimension () override
	Return the parametric dimension of the class.
void	Evaluate (double uvw[3], double Pt[3], double Duvw[9]) override
	A torus.
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.
virtual void	SetRingRadius (double)
	Set/Get the radius from the center to the middle of the ring of the torus.
virtual double	GetRingRadius ()
	Set/Get the radius from the center to the middle of the ring of the torus.
virtual void	SetCrossSectionRadius (double)
	Set/Get the radius of the cross section of ring of the torus.
virtual double	GetCrossSectionRadius ()
	Set/Get the radius of the cross section of ring of the torus.
Public Member Functions inherited from vtkParametricFunction
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkParametricFunction *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual int	GetDimension ()=0
	Return the dimension of parametric space.
virtual void	Evaluate (double uvw[3], double Pt[3], double Duvw[9])=0
	Performs the mapping $f(uvw)->(Pt,Duvw)$f.
virtual double	EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9])=0
	Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
virtual void	SetMinimumU (double)
	Set/Get the minimum u-value.
virtual double	GetMinimumU ()
	Set/Get the minimum u-value.
virtual void	SetMaximumU (double)
	Set/Get the maximum u-value.
virtual double	GetMaximumU ()
	Set/Get the maximum u-value.
virtual void	SetMinimumV (double)
	Set/Get the minimum v-value.
virtual double	GetMinimumV ()
	Set/Get the minimum v-value.
virtual void	SetMaximumV (double)
	Set/Get the maximum v-value.
virtual double	GetMaximumV ()
	Set/Get the maximum v-value.
virtual void	SetMinimumW (double)
	Set/Get the minimum w-value.
virtual double	GetMinimumW ()
	Set/Get the minimum w-value.
virtual void	SetMaximumW (double)
	Set/Get the maximum w-value.
virtual double	GetMaximumW ()
	Set/Get the maximum w-value.
virtual void	SetJoinU (vtkTypeBool)
	Set/Get the flag which joins the first triangle strip to the last one.
virtual vtkTypeBool	GetJoinU ()
	Set/Get the flag which joins the first triangle strip to the last one.
virtual void	JoinUOn ()
	Set/Get the flag which joins the first triangle strip to the last one.
virtual void	JoinUOff ()
	Set/Get the flag which joins the first triangle strip to the last one.
virtual void	SetJoinV (vtkTypeBool)
	Set/Get the flag which joins the ends of the triangle strips.
virtual vtkTypeBool	GetJoinV ()
	Set/Get the flag which joins the ends of the triangle strips.
virtual void	JoinVOn ()
	Set/Get the flag which joins the ends of the triangle strips.
virtual void	JoinVOff ()
	Set/Get the flag which joins the ends of the triangle strips.
virtual void	SetJoinW (vtkTypeBool)
	Set/Get the flag which joins the ends of the triangle strips.
virtual vtkTypeBool	GetJoinW ()
	Set/Get the flag which joins the ends of the triangle strips.
virtual void	JoinWOn ()
	Set/Get the flag which joins the ends of the triangle strips.
virtual void	JoinWOff ()
	Set/Get the flag which joins the ends of the triangle strips.
virtual void	SetTwistU (vtkTypeBool)
	Set/Get the flag which joins the first triangle strip to the last one with a twist.
virtual vtkTypeBool	GetTwistU ()
	Set/Get the flag which joins the first triangle strip to the last one with a twist.
virtual void	TwistUOn ()
	Set/Get the flag which joins the first triangle strip to the last one with a twist.
virtual void	TwistUOff ()
	Set/Get the flag which joins the first triangle strip to the last one with a twist.
virtual void	SetTwistV (vtkTypeBool)
	Set/Get the flag which joins the ends of the triangle strips with a twist.
virtual vtkTypeBool	GetTwistV ()
	Set/Get the flag which joins the ends of the triangle strips with a twist.
virtual void	TwistVOn ()
	Set/Get the flag which joins the ends of the triangle strips with a twist.
virtual void	TwistVOff ()
	Set/Get the flag which joins the ends of the triangle strips with a twist.
virtual void	SetTwistW (vtkTypeBool)
	Set/Get the flag which joins the ends of the triangle strips with a twist.
virtual vtkTypeBool	GetTwistW ()
	Set/Get the flag which joins the ends of the triangle strips with a twist.
virtual void	TwistWOn ()
	Set/Get the flag which joins the ends of the triangle strips with a twist.
virtual void	TwistWOff ()
	Set/Get the flag which joins the ends of the triangle strips with a twist.
virtual void	SetClockwiseOrdering (vtkTypeBool)
	Set/Get the flag which determines the ordering of the vertices forming the triangle strips.
virtual vtkTypeBool	GetClockwiseOrdering ()
	Set/Get the flag which determines the ordering of the vertices forming the triangle strips.
virtual void	ClockwiseOrderingOn ()
	Set/Get the flag which determines the ordering of the vertices forming the triangle strips.
virtual void	ClockwiseOrderingOff ()
	Set/Get the flag which determines the ordering of the vertices forming the triangle strips.
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).
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).
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).
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).
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkParametricTorus *	SafeDownCast (vtkObjectBase *o)
static vtkParametricTorus *	New ()
	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 = 0, RingRadius = 1, CrossSectionRadius = 0.5.
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkParametricTorus ()
	~vtkParametricTorus () override
Protected Member Functions inherited from vtkParametricFunction
virtual vtkObjectBase *	NewInstanceInternal () const
	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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
double	RingRadius
double	CrossSectionRadius
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
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

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/publications in the "VTK Technical Documents" section in the VTk.org web pages.

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.

Online Examples:

ParametricObjectsDemo

CurvaturesAdjustEdges

PBR_Skybox

PBR_Skybox_Anisotropy

PBR_Skybox_Texturing

CurvatureBandsWithGlyphs

ElevationBandsWithGlyphs

PointDataSubdivision

Tests:

vtkParametricTorus (Tests)

Definition at line 118 of file vtkParametricTorus.h.

Member Typedef Documentation

Superclass

typedef vtkParametricFunction vtkParametricTorus::Superclass

Definition at line 122 of file vtkParametricTorus.h.

Constructor & Destructor Documentation

vtkParametricTorus()

vtkParametricTorus::vtkParametricTorus ( )

protected

~vtkParametricTorus()

vtkParametricTorus::~vtkParametricTorus ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

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

SafeDownCast()

static vtkParametricTorus * vtkParametricTorus::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkParametricTorus::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkParametricFunction.

NewInstance()

vtkParametricTorus * vtkParametricTorus::NewInstance

(

)

const

PrintSelf()

void vtkParametricTorus::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.

New()

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 = 0, RingRadius = 1, CrossSectionRadius = 0.5.

SetRingRadius()

virtual void vtkParametricTorus::SetRingRadius ( double  )

virtual

Set/Get the radius from the center to the middle of the ring of the torus.

Default is 1.0.

GetRingRadius()

virtual double vtkParametricTorus::GetRingRadius ( )

virtual

Set/Get the radius from the center to the middle of the ring of the torus.

Default is 1.0.

SetCrossSectionRadius()

virtual void vtkParametricTorus::SetCrossSectionRadius ( double  )

virtual

Set/Get the radius of the cross section of ring of the torus.

Default is 0.5.

GetCrossSectionRadius()

virtual double vtkParametricTorus::GetCrossSectionRadius ( )

virtual

Set/Get the radius of the cross section of ring of the torus.

Default is 0.5.

GetDimension()

int vtkParametricTorus::GetDimension ( )

inlineoverridevirtual

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 157 of file vtkParametricTorus.h.

Evaluate()

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

overridevirtual

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.

EvaluateScalar()

double vtkParametricTorus::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.

Member Data Documentation

RingRadius

double vtkParametricTorus::RingRadius

protected

Definition at line 189 of file vtkParametricTorus.h.

CrossSectionRadius

double vtkParametricTorus::CrossSectionRadius

protected

Definition at line 190 of file vtkParametricTorus.h.

---

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

• Common/ComputationalGeometry/vtkParametricTorus.h