parametric function for 1D interpolating splines More...

#include <vtkParametricSpline.h>

Inheritance diagram for vtkParametricSpline:

Collaboration diagram for vtkParametricSpline:

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.

vtkParametricSpline *	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 u[3], double Pt[3], double Du[9]) override
	Evaluate the spline at parametric coordinate u[0] returning the point coordinate Pt[3].

double	EvaluateScalar (double u[3], double Pt[3], double Du[9]) override
	Evaluate a scalar value at parametric coordinate u[0] and Pt[3].


void	SetXSpline (vtkSpline *)
	By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes).

void	SetYSpline (vtkSpline *)
	By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes).

void	SetZSpline (vtkSpline *)
	By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes).

virtual vtkSpline *	GetXSpline ()
	By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes).

virtual vtkSpline *	GetYSpline ()
	By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes).

virtual vtkSpline *	GetZSpline ()
	By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes).


void	SetPoints (vtkPoints *)
	Specify the list of points defining the spline.

virtual vtkPoints *	GetPoints ()
	Specify the list of points defining the spline.


void	SetNumberOfPoints (vtkIdType numPts)
	Another API to set the points.

void	SetPoint (vtkIdType index, double x, double y, double z)
	Another API to set the points.


virtual void	SetClosed (vtkTypeBool)
	Control whether the spline is open or closed.

virtual vtkTypeBool	GetClosed ()
	Control whether the spline is open or closed.

virtual void	ClosedOn ()
	Control whether the spline is open or closed.

virtual void	ClosedOff ()
	Control whether the spline is open or closed.


virtual void	SetParameterizeByLength (vtkTypeBool)
	Control whether the spline is parameterized by length or by point index.

virtual vtkTypeBool	GetParameterizeByLength ()
	Control whether the spline is parameterized by length or by point index.

virtual void	ParameterizeByLengthOn ()
	Control whether the spline is parameterized by length or by point index.

virtual void	ParameterizeByLengthOff ()
	Control whether the spline is parameterized by length or by point index.


virtual void	SetLeftConstraint (int)
	Set the type of constraint of the left(right) end points.

virtual int	GetLeftConstraint ()
	Set the type of constraint of the left(right) end points.

virtual void	SetRightConstraint (int)
	Set the type of constraint of the left(right) end points.

virtual int	GetRightConstraint ()
	Set the type of constraint of the left(right) end points.


virtual void	SetLeftValue (double)
	The values of the derivative on the left and right sides.

virtual double	GetLeftValue ()
	The values of the derivative on the left and right sides.

virtual void	SetRightValue (double)
	The values of the derivative on the left and right sides.

virtual double	GetRightValue ()
	The values of the derivative on the left and right sides.

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)

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.

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.

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

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

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

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.

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

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

static vtkParametricSpline *	SafeDownCast (vtkObjectBase *o)

static vtkParametricSpline *	New ()
	Construct the spline with the following parameters: MinimumU = 0, MaximumU = 1, JoinU = 0 (unless the spline is closed, then JoinU = 1), TwistU = 0, DerivativesSupplied = 0 (the other vtkParametricFunction parameters are ignored).

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

	vtkParametricSpline ()

	~vtkParametricSpline () override

int	Initialize ()

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

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkPoints *	Points

vtkSpline *	XSpline

vtkSpline *	YSpline

vtkSpline *	ZSpline

vtkTypeBool	Closed

int	LeftConstraint

int	RightConstraint

double	LeftValue

double	RightValue

vtkTypeBool	ParameterizeByLength

vtkMTimeType	InitializeTime

double	Length

double	ClosedLength

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

parametric function for 1D interpolating splines

vtkParametricSpline is a parametric function for 1D interpolating splines. vtkParametricSpline maps the single parameter u into a 3D point (x,y,z) using three instances of interpolating splines. This family of 1D splines is guaranteed to be parameterized in the interval [0,1]. Attempting to evaluate outside this interval will cause the parameter u to be clamped in the range [0,1].

When constructed, this class creates instances of vtkCardinalSpline for each of the x-y-z coordinates. The user may choose to replace these with their own instances of subclasses of vtkSpline.

Warning: If you wish to tessellate the spline, use the class vtkParametricFunctionSource.

See also: vtkSpline vtkKochanekSpline vtkCardinalSpline

Online Examples:

ParametricObjectsDemo

ExtrudePolyDataAlongLine

TubesFromSplines

Definition at line 136 of file vtkParametricSpline.h.

Member Typedef Documentation

◆ Superclass

typedef vtkParametricFunction vtkParametricSpline::Superclass

Definition at line 139 of file vtkParametricSpline.h.

Constructor & Destructor Documentation

◆ vtkParametricSpline()

vtkParametricSpline::vtkParametricSpline ( )

protected

◆ ~vtkParametricSpline()

vtkParametricSpline::~vtkParametricSpline ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkParametricSpline::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkParametricFunction.

◆ NewInstance()

vtkParametricSpline * vtkParametricSpline::NewInstance ( ) const

◆ PrintSelf()

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

static

Construct the spline with the following parameters: MinimumU = 0, MaximumU = 1, JoinU = 0 (unless the spline is closed, then JoinU = 1), TwistU = 0, DerivativesSupplied = 0 (the other vtkParametricFunction parameters are ignored).

◆ GetDimension()

int vtkParametricSpline::GetDimension ( )

inlineoverridevirtual

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 153 of file vtkParametricSpline.h.

◆ Evaluate()

void vtkParametricSpline::Evaluate	(	double	u[3],
		double	Pt[3],
		double	Du[9]
	)

overridevirtual

Evaluate the spline at parametric coordinate u[0] returning the point coordinate Pt[3].

Implements vtkParametricFunction.

◆ EvaluateScalar()

double vtkParametricSpline::EvaluateScalar	(	double	u[3],
		double	Pt[3],
		double	Du[9]
	)

overridevirtual

Evaluate a scalar value at parametric coordinate u[0] and Pt[3].

The scalar value is just the parameter u[0].

Implements vtkParametricFunction.