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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

vtkParametricSpline *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual int	GetDimension ()

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

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


void	SetXSpline (vtkSpline *)

void	SetYSpline (vtkSpline *)

void	SetZSpline (vtkSpline *)

virtual vtkSpline *	GetXSpline ()

virtual vtkSpline *	GetYSpline ()

virtual vtkSpline *	GetZSpline ()


void	SetPoints (vtkPoints *)

virtual vtkPoints *	GetPoints ()


void	SetNumberOfPoints (vtkIdType numPts)

void	SetPoint (vtkIdType index, double x, double y, double z)


virtual void	SetClosed (int)

virtual int	GetClosed ()

virtual void	ClosedOn ()

virtual void	ClosedOff ()


virtual void	SetParameterizeByLength (int)

virtual int	GetParameterizeByLength ()

virtual void	ParameterizeByLengthOn ()

virtual void	ParameterizeByLengthOff ()


virtual void	SetLeftConstraint (int)

virtual int	GetLeftConstraint ()

virtual void	SetRightConstraint (int)

virtual int	GetRightConstraint ()


virtual void	SetLeftValue (double)

virtual double	GetLeftValue ()

virtual void	SetRightValue (double)

virtual double	GetRightValue ()

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

static vtkParametricSpline *	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

	vtkParametricSpline ()

	~vtkParametricSpline ()

int	Initialize ()

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
vtkPoints *	Points

vtkSpline *	XSpline

vtkSpline *	YSpline

vtkSpline *	ZSpline

int	Closed

int	LeftConstraint

int	RightConstraint

double	LeftValue

double	RightValue

int	ParameterizeByLength

unsigned long	InitializeTime

double	Length

double	ClosedLength

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

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

Examples:: vtkParametricSpline (Examples)

Tests:: vtkParametricSpline (Tests)

Definition at line 52 of file vtkParametricSpline.h.

Member Typedef Documentation

typedef vtkParametricFunction vtkParametricSpline::Superclass

Definition at line 55 of file vtkParametricSpline.h.

Constructor & Destructor Documentation

vtkParametricSpline::vtkParametricSpline ( )

protected

vtkParametricSpline::~vtkParametricSpline ( )

protected

Member Function Documentation

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

static

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

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

static

virtual vtkObjectBase* vtkParametricSpline::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkParametricFunction.

vtkParametricSpline* vtkParametricSpline::NewInstance ( ) const

void vtkParametricSpline::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 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).

virtual int vtkParametricSpline::GetDimension ( )

inlinevirtual

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 65 of file vtkParametricSpline.h.

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

virtual

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

Implements vtkParametricFunction.

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

virtual

Evaluate a scalar value at parametric coordinate u[0] and Pt[3]. The scalar value is just the parameter u[0].

Implements vtkParametricFunction.

void vtkParametricSpline::SetXSpline ( vtkSpline * )