vtkParametricSpline Class Reference

#include <vtkParametricSpline.h>

Inheritance diagram for vtkParametricSpline:

[legend]

Collaboration diagram for vtkParametricSpline:

[legend]

List of all members.

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 51 of file vtkParametricSpline.h.


Public Types
typedef vtkParametricFunction	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
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 ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkParametricSpline *	SafeDownCast (vtkObject *o)
static vtkParametricSpline *	New ()
Protected Member Functions
	vtkParametricSpline ()
	~vtkParametricSpline ()
int	Initialize ()
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

Member Typedef Documentation

typedef vtkParametricFunction vtkParametricSpline::Superclass

Reimplemented from vtkParametricFunction.

Definition at line 54 of file vtkParametricSpline.h.

Constructor & Destructor Documentation

vtkParametricSpline::vtkParametricSpline ( ) [protected]

vtkParametricSpline::~vtkParametricSpline ( ) [protected]

Member Function Documentation

virtual const char* vtkParametricSpline::GetClassName ( ) [virtual]

Reimplemented from vtkParametricFunction.

static int vtkParametricSpline::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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.

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 ( vtkObject * o ) [static]

Reimplemented from vtkParametricFunction.

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

Reimplemented from vtkObject.

virtual int vtkParametricSpline::GetDimension ( ) [inline, virtual]

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 64 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 * )