VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkParametricSpline Class Reference

parametric function for 1D interpolating splines More...

#include <vtkParametricSpline.h>

Inheritance diagram for vtkParametricSpline:
[legend]
Collaboration diagram for vtkParametricSpline:
[legend]

List of all members.

Public Types

typedef vtkParametricFunction Superclass
- Public Types inherited from vtkParametricFunction
- Public Types inherited from vtkObject

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 vtkSplineGetXSpline ()
virtual vtkSplineGetYSpline ()
virtual vtkSplineGetZSpline ()
void SetPoints (vtkPoints *)
virtual vtkPointsGetPoints ()
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
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 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 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
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
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 vtkParametricSplineSafeDownCast (vtkObject *o)
static vtkParametricSplineNew ()

Protected Member Functions

 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 &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkPointsPoints
vtkSplineXSpline
vtkSplineYSpline
vtkSplineZSpline
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
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int 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 51 of file vtkParametricSpline.h.


Member Typedef Documentation

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

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 )

By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes). The user may choose to create and assign their own instances of vtkSpline.

void vtkParametricSpline::SetYSpline ( vtkSpline )

By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes). The user may choose to create and assign their own instances of vtkSpline.

void vtkParametricSpline::SetZSpline ( vtkSpline )

By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes). The user may choose to create and assign their own instances of vtkSpline.

virtual vtkSpline* vtkParametricSpline::GetXSpline ( )
virtual

By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes). The user may choose to create and assign their own instances of vtkSpline.

virtual vtkSpline* vtkParametricSpline::GetYSpline ( )
virtual

By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes). The user may choose to create and assign their own instances of vtkSpline.

virtual vtkSpline* vtkParametricSpline::GetZSpline ( )
virtual

By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-z coordinate axes). The user may choose to create and assign their own instances of vtkSpline.

void vtkParametricSpline::SetPoints ( vtkPoints )

Specify the list of points defining the spline. Do this by specifying a vtkPoints array containing the points. Note that the order of the points in vtkPoints is the order that the splines will be fit.

virtual vtkPoints* vtkParametricSpline::GetPoints ( )
virtual

Specify the list of points defining the spline. Do this by specifying a vtkPoints array containing the points. Note that the order of the points in vtkPoints is the order that the splines will be fit.

void vtkParametricSpline::SetNumberOfPoints ( vtkIdType  numPts)

Another API to set the points. Set the number of points and then set the individual point coordinates.

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

Another API to set the points. Set the number of points and then set the individual point coordinates.

virtual void vtkParametricSpline::SetClosed ( int  )
virtual

Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous.

virtual int vtkParametricSpline::GetClosed ( )
virtual

Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous.

virtual void vtkParametricSpline::ClosedOn ( )
virtual

Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous.

virtual void vtkParametricSpline::ClosedOff ( )
virtual

Control whether the spline is open or closed. A closed spline forms a continuous loop: the first and last points are the same, and derivatives are continuous.

virtual void vtkParametricSpline::SetParameterizeByLength ( int  )
virtual

Control whether the spline is parameterized by length or by point index. Default is by length.

virtual int vtkParametricSpline::GetParameterizeByLength ( )
virtual

Control whether the spline is parameterized by length or by point index. Default is by length.

virtual void vtkParametricSpline::ParameterizeByLengthOn ( )
virtual

Control whether the spline is parameterized by length or by point index. Default is by length.

virtual void vtkParametricSpline::ParameterizeByLengthOff ( )
virtual

Control whether the spline is parameterized by length or by point index. Default is by length.

virtual void vtkParametricSpline::SetLeftConstraint ( int  )
virtual

Set the type of constraint of the left(right) end points. Four constraints are available: 0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points. 1: the first derivative at left(right) most point is set to Left(Right)Value. 2: the second derivative at left(right) most point is set to Left(Right)Value. 3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

virtual int vtkParametricSpline::GetLeftConstraint ( )
virtual

Set the type of constraint of the left(right) end points. Four constraints are available: 0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points. 1: the first derivative at left(right) most point is set to Left(Right)Value. 2: the second derivative at left(right) most point is set to Left(Right)Value. 3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

virtual void vtkParametricSpline::SetRightConstraint ( int  )
virtual

Set the type of constraint of the left(right) end points. Four constraints are available: 0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points. 1: the first derivative at left(right) most point is set to Left(Right)Value. 2: the second derivative at left(right) most point is set to Left(Right)Value. 3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

virtual int vtkParametricSpline::GetRightConstraint ( )
virtual

Set the type of constraint of the left(right) end points. Four constraints are available: 0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points. 1: the first derivative at left(right) most point is set to Left(Right)Value. 2: the second derivative at left(right) most point is set to Left(Right)Value. 3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

virtual void vtkParametricSpline::SetLeftValue ( double  )
virtual

The values of the derivative on the left and right sides. The value is used only if the left(right) constraint is type 1-3.

virtual double vtkParametricSpline::GetLeftValue ( )
virtual

The values of the derivative on the left and right sides. The value is used only if the left(right) constraint is type 1-3.

virtual void vtkParametricSpline::SetRightValue ( double  )
virtual

The values of the derivative on the left and right sides. The value is used only if the left(right) constraint is type 1-3.

virtual double vtkParametricSpline::GetRightValue ( )
virtual

The values of the derivative on the left and right sides. The value is used only if the left(right) constraint is type 1-3.

int vtkParametricSpline::Initialize ( )
protected

Member Data Documentation

vtkPoints* vtkParametricSpline::Points
protected

Definition at line 147 of file vtkParametricSpline.h.

vtkSpline* vtkParametricSpline::XSpline
protected

Definition at line 150 of file vtkParametricSpline.h.

vtkSpline* vtkParametricSpline::YSpline
protected

Definition at line 151 of file vtkParametricSpline.h.

vtkSpline* vtkParametricSpline::ZSpline
protected

Definition at line 152 of file vtkParametricSpline.h.

int vtkParametricSpline::Closed
protected

Definition at line 155 of file vtkParametricSpline.h.

int vtkParametricSpline::LeftConstraint
protected

Definition at line 156 of file vtkParametricSpline.h.

int vtkParametricSpline::RightConstraint
protected

Definition at line 157 of file vtkParametricSpline.h.

double vtkParametricSpline::LeftValue
protected

Definition at line 158 of file vtkParametricSpline.h.

double vtkParametricSpline::RightValue
protected

Definition at line 159 of file vtkParametricSpline.h.

int vtkParametricSpline::ParameterizeByLength
protected

Definition at line 160 of file vtkParametricSpline.h.

unsigned long vtkParametricSpline::InitializeTime
protected

Definition at line 163 of file vtkParametricSpline.h.

double vtkParametricSpline::Length
protected

Definition at line 167 of file vtkParametricSpline.h.

double vtkParametricSpline::ClosedLength
protected

Definition at line 168 of file vtkParametricSpline.h.


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