abstract interface for parametric functions More...

#include <vtkParametricFunction.h>

Inheritance diagram for vtkParametricFunction:

Collaboration diagram for vtkParametricFunction:

Public Types
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...

vtkParametricFunction *	NewInstance () const

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

virtual int	GetDimension ()=0
	Return the dimension of parametric space. More...

virtual void	Evaluate (double uvw[3], double Pt[3], double Duvw[9])=0
	Performs the mapping $f(uvw)->(Pt,Duvw)$f. More...

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. More...


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

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

abstract interface for parametric functions

vtkParametricFunction is an abstract interface for functions defined by parametric mapping i.e. f(u,v,w)->(x,y,z) where u_min <= u < u_max, v_min <= v < v_max, w_min <= w < w_max. (For notational convenience, we will write f(u)->x and assume that u means (u,v,w) and x means (x,y,z).)

The interface contains the pure virtual function, Evaluate(), that generates a point and the derivatives at that point which are then used to construct the surface. A second pure virtual function, EvaluateScalar(), can be used to generate a scalar for the surface. Finally, the GetDimension() virtual function is used to differentiate 1D, 2D, and 3D parametric functions. Since this abstract class defines a pure virtual API, its subclasses must implement the pure virtual functions GetDimension(), Evaluate() and EvaluateScalar().

This class has also methods for defining a range of parametric values (u,v,w).

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.

See also: vtkParametricFunctionSource - tessellates a parametric function; Implementations of derived classes implementing non-orentable surfaces: vtkParametricBoy vtkParametricCrossCap vtkParametricFigure8Klein vtkParametricKlein vtkParametricMobius vtkParametricRoman; Implementations of derived classes implementing orientable surfaces: vtkParametricConicSpiral vtkParametricDini vtkParametricEllipsoid vtkParametricEnneper vtkParametricRandomHills vtkParametricSuperEllipsoid vtkParametricSuperToroid vtkParametricTorus

Definition at line 62 of file vtkParametricFunction.h.

Member Typedef Documentation

typedef vtkObject vtkParametricFunction::Superclass

Definition at line 65 of file vtkParametricFunction.h.

Constructor & Destructor Documentation

vtkParametricFunction::vtkParametricFunction ( )

protected

vtkParametricFunction::~vtkParametricFunction ( )

overrideprotected

Member Function Documentation

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

static

virtual vtkTypeBool vtkParametricFunction::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 vtkObjectBase.

Reimplemented in vtkParametricSuperToroid, vtkParametricSpline, vtkParametricFigure8Klein, vtkParametricKlein, vtkParametricSuperEllipsoid, vtkParametricRandomHills, vtkParametricEllipsoid, vtkParametricBoy, vtkParametricCrossCap, vtkParametricDini, vtkParametricEnneper, vtkParametricPluckerConoid, vtkParametricConicSpiral, vtkParametricRoman, vtkParametricTorus, vtkParametricMobius, vtkParametricBohemianDome, vtkParametricKuen, vtkParametricPseudosphere, vtkParametricCatalanMinimal, vtkParametricBour, and vtkParametricHenneberg.

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

static

virtual vtkObjectBase* vtkParametricFunction::NewInstanceInternal ( ) const

protectedvirtual

vtkParametricFunction* vtkParametricFunction::NewInstance ( ) const

void vtkParametricFunction::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 vtkObjectBase.

Reimplemented in vtkParametricSuperToroid, vtkParametricSpline, vtkParametricKlein, vtkParametricSuperEllipsoid, vtkParametricRandomHills, vtkParametricPluckerConoid, vtkParametricRoman, vtkParametricTorus, vtkParametricMobius, vtkParametricKuen, vtkParametricPseudosphere, and vtkParametricHenneberg.

virtual int vtkParametricFunction::GetDimension ( )

pure virtual

Return the dimension of parametric space.

Depending on the dimension, then the (u,v,w) parameters and associated information (e.g., derivates) have meaning. For example, if the dimension of the function is one, then u[0] and Duvw[0...2] have meaning. This is a pure virtual function that must be instantiated in a derived class.

Implemented in vtkParametricTorus, vtkParametricFigure8Klein, vtkParametricSuperToroid, vtkParametricSuperEllipsoid, vtkParametricKlein, vtkParametricPluckerConoid, vtkParametricBohemianDome, vtkParametricMobius, vtkParametricSpline, vtkParametricEllipsoid, vtkParametricBoy, vtkParametricDini, vtkParametricCrossCap, vtkParametricEnneper, vtkParametricConicSpiral, vtkParametricKuen, vtkParametricPseudosphere, vtkParametricCatalanMinimal, vtkParametricRandomHills, vtkParametricBour, vtkParametricHenneberg, and vtkParametricRoman.

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

pure virtual

Performs the mapping $f(uvw)->(Pt,Duvw)$f.

This is a pure virtual function that must be instantiated in a derived class.

uvw are the parameters, with u corresponding to uvw[0], v to uvw[1] and w to uvw[2] respectively. Pt is the returned Cartesian point, Duvw are the derivatives of this point with respect to u, v and w. Note that the first three values in Duvw are Du, the next three are Dv, and the final three are Dw. Du Dv Dw are the partial derivatives of the function at the point Pt with respect to u, v and w respectively.

Implemented in vtkParametricRandomHills, vtkParametricSuperToroid, vtkParametricSuperEllipsoid, vtkParametricConicSpiral, vtkParametricEllipsoid, vtkParametricDini, vtkParametricTorus, vtkParametricFigure8Klein, vtkParametricBoy, vtkParametricKlein, vtkParametricKuen, vtkParametricPluckerConoid, vtkParametricRoman, vtkParametricBohemianDome, vtkParametricMobius, vtkParametricSpline, vtkParametricCrossCap, vtkParametricEnneper, vtkParametricPseudosphere, vtkParametricCatalanMinimal, vtkParametricBour, and vtkParametricHenneberg.

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

pure virtual

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

This is a pure virtual function that must be instantiated in a derived class.

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

Implemented in vtkParametricRandomHills, vtkParametricSuperToroid, vtkParametricSuperEllipsoid, vtkParametricConicSpiral, vtkParametricEllipsoid, vtkParametricDini, vtkParametricTorus, vtkParametricFigure8Klein, vtkParametricBoy, vtkParametricKlein, vtkParametricRoman, vtkParametricMobius, vtkParametricCrossCap, vtkParametricEnneper, vtkParametricKuen, vtkParametricPluckerConoid, vtkParametricBohemianDome, vtkParametricSpline, vtkParametricPseudosphere, vtkParametricCatalanMinimal, vtkParametricBour, and vtkParametricHenneberg.

virtual void vtkParametricFunction::SetMinimumU ( double )

virtual

Set/Get the minimum u-value.

virtual double vtkParametricFunction::GetMinimumU ( )

virtual

Set/Get the minimum u-value.

virtual void vtkParametricFunction::SetMaximumU ( double )

virtual

Set/Get the maximum u-value.

virtual double vtkParametricFunction::GetMaximumU ( )

virtual

Set/Get the maximum u-value.

virtual void vtkParametricFunction::SetMinimumV ( double )

virtual

Set/Get the minimum v-value.

virtual double vtkParametricFunction::GetMinimumV ( )

virtual

Set/Get the minimum v-value.

virtual void vtkParametricFunction::SetMaximumV ( double )

virtual

Set/Get the maximum v-value.

virtual double vtkParametricFunction::GetMaximumV ( )

virtual

Set/Get the maximum v-value.

virtual void vtkParametricFunction::SetMinimumW ( double )

virtual

Set/Get the minimum w-value.

virtual double vtkParametricFunction::GetMinimumW ( )

virtual

Set/Get the minimum w-value.

virtual void vtkParametricFunction::SetMaximumW ( double )

virtual

Set/Get the maximum w-value.

virtual double vtkParametricFunction::GetMaximumW ( )

virtual

Set/Get the maximum w-value.

virtual void vtkParametricFunction::SetJoinU ( vtkTypeBool )

virtual

Set/Get the flag which joins the first triangle strip to the last one.

virtual vtkTypeBool vtkParametricFunction::GetJoinU ( )

virtual

Set/Get the flag which joins the first triangle strip to the last one.

virtual void vtkParametricFunction::JoinUOn ( )

virtual

Set/Get the flag which joins the first triangle strip to the last one.

virtual void vtkParametricFunction::JoinUOff ( )

virtual

Set/Get the flag which joins the first triangle strip to the last one.

virtual void vtkParametricFunction::SetJoinV ( vtkTypeBool )

virtual

Set/Get the flag which joins the ends of the triangle strips.

virtual vtkTypeBool vtkParametricFunction::GetJoinV ( )

virtual

Set/Get the flag which joins the ends of the triangle strips.

virtual void vtkParametricFunction::JoinVOn ( )

virtual

Set/Get the flag which joins the ends of the triangle strips.

virtual void vtkParametricFunction::JoinVOff ( )

virtual

Set/Get the flag which joins the ends of the triangle strips.

virtual void vtkParametricFunction::SetJoinW ( vtkTypeBool )

virtual

Set/Get the flag which joins the ends of the triangle strips.

virtual vtkTypeBool vtkParametricFunction::GetJoinW ( )

virtual

Set/Get the flag which joins the ends of the triangle strips.

virtual void vtkParametricFunction::JoinWOn ( )

virtual

Set/Get the flag which joins the ends of the triangle strips.

virtual void vtkParametricFunction::JoinWOff ( )

virtual

Set/Get the flag which joins the ends of the triangle strips.

virtual void vtkParametricFunction::SetTwistU ( vtkTypeBool )

virtual

Set/Get the flag which joins the first triangle strip to the last one with a twist.

JoinU must also be set if this is set. Used when building some non-orientable surfaces.

virtual vtkTypeBool vtkParametricFunction::GetTwistU ( )

virtual

Set/Get the flag which joins the first triangle strip to the last one with a twist.

JoinU must also be set if this is set. Used when building some non-orientable surfaces.

virtual void vtkParametricFunction::TwistUOn ( )

virtual

Set/Get the flag which joins the first triangle strip to the last one with a twist.

JoinU must also be set if this is set. Used when building some non-orientable surfaces.

virtual void vtkParametricFunction::TwistUOff ( )

virtual

Set/Get the flag which joins the first triangle strip to the last one with a twist.

JoinU must also be set if this is set. Used when building some non-orientable surfaces.

virtual void vtkParametricFunction::SetTwistV ( vtkTypeBool )

virtual