VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkKochanekSpline Class Reference

computes an interpolating spline using a Kochanek basis. More...

#include <vtkKochanekSpline.h>

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

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 
vtkKochanekSplineNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void Compute ()
 
double Evaluate (double t)
 
virtual void DeepCopy (vtkSpline *s)
 
virtual void SetDefaultBias (double)
 
virtual double GetDefaultBias ()
 
virtual void SetDefaultTension (double)
 
virtual double GetDefaultTension ()
 
virtual void SetDefaultContinuity (double)
 
virtual double GetDefaultContinuity ()
 
- Public Member Functions inherited from vtkSpline
vtkSplineNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int GetNumberOfPoints ()
 
void AddPoint (double t, double x)
 
void RemovePoint (double t)
 
void RemoveAllPoints ()
 
unsigned long GetMTime ()
 
void SetParametricRange (double tMin, double tMax)
 
void SetParametricRange (double tRange[2])
 
void GetParametricRange (double tRange[2]) const
 
virtual void SetClampValue (int)
 
virtual int GetClampValue ()
 
virtual void ClampValueOn ()
 
virtual void ClampValueOff ()
 
virtual void SetClosed (int)
 
virtual int GetClosed ()
 
virtual void ClosedOn ()
 
virtual void ClosedOff ()
 
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 vtkKochanekSplineSafeDownCast (vtkObjectBase *o)
 
static vtkKochanekSplineNew ()
 
- Static Public Member Functions inherited from vtkSpline
static int IsTypeOf (const char *type)
 
static vtkSplineSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkKochanekSpline ()
 
 ~vtkKochanekSpline ()
 
void Fit1D (int n, double *x, double *y, double tension, double bias, double continuity, double coefficients[][4], int leftConstraint, double leftValue, int rightConstraint, double rightValue)
 
- Protected Member Functions inherited from vtkSpline
 vtkSpline ()
 
 ~vtkSpline ()
 
double ComputeLeftDerivative ()
 
double ComputeRightDerivative ()
 
int FindIndex (int size, double t)
 

Protected Attributes

double DefaultBias
 
double DefaultTension
 
double DefaultContinuity
 
- Protected Attributes inherited from vtkSpline
unsigned long ComputeTime
 
int ClampValue
 
double * Intervals
 
double * Coefficients
 
int LeftConstraint
 
double LeftValue
 
int RightConstraint
 
double RightValue
 
vtkPiecewiseFunction * PiecewiseFunction
 
int Closed
 
double ParametricRange [2]
 

Detailed Description

computes an interpolating spline using a Kochanek basis.

Implements the Kochenek interpolating spline described in: Kochanek, D., Bartels, R., "Interpolating Splines with Local Tension, Continuity, and Bias Control," Computer Graphics, vol. 18, no. 3, pp. 33-41, July 1984. These splines give the user more control over the shape of the curve than the cardinal splines implemented in vtkCardinalSpline. Three parameters can be specified. All have a range from -1 to 1.

Tension controls how sharply the curve bends at an input point. A value of -1 produces more slack in the curve. A value of 1 tightens the curve.

Continuity controls the continuity of the first derivative at input points.

Bias controls the direction of the curve at it passes through an input point. A value of -1 undershoots the point while a value of 1 overshoots the point.

These three parameters give the user broad control over the shape of the interpolating spline. The original Kochanek paper describes the effects nicely and is recommended reading.

See Also
vtkSpline vtkCardinalSpline
Examples:
vtkKochanekSpline (Examples)
Tests:
vtkKochanekSpline (Tests)

Definition at line 56 of file vtkKochanekSpline.h.

Member Typedef Documentation

Definition at line 59 of file vtkKochanekSpline.h.

Constructor & Destructor Documentation

vtkKochanekSpline::vtkKochanekSpline ( )
protected
vtkKochanekSpline::~vtkKochanekSpline ( )
inlineprotected

Definition at line 95 of file vtkKochanekSpline.h.

Member Function Documentation

static int vtkKochanekSpline::IsTypeOf ( const char *  type)
static
virtual int vtkKochanekSpline::IsA ( const char *  type)
virtual

Reimplemented from vtkSpline.

static vtkKochanekSpline* vtkKochanekSpline::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkKochanekSpline::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkSpline.

vtkKochanekSpline* vtkKochanekSpline::NewInstance ( ) const
void vtkKochanekSpline::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkKochanekSpline* vtkKochanekSpline::New ( )
static

Construct a KochanekSpline with the following defaults: DefaultBias = 0, DefaultTension = 0, DefaultContinuity = 0.

void vtkKochanekSpline::Compute ( )
virtual

Compute Kochanek Spline coefficients.

Implements vtkSpline.

double vtkKochanekSpline::Evaluate ( double  t)
virtual

Evaluate a 1D Kochanek spline.

Implements vtkSpline.

virtual void vtkKochanekSpline::SetDefaultBias ( double  )
virtual

Set the bias for all points. Default is 0.

virtual double vtkKochanekSpline::GetDefaultBias ( )
virtual

Set the bias for all points. Default is 0.

virtual void vtkKochanekSpline::SetDefaultTension ( double  )
virtual

Set the tension for all points. Default is 0.

virtual double vtkKochanekSpline::GetDefaultTension ( )
virtual

Set the tension for all points. Default is 0.

virtual void vtkKochanekSpline::SetDefaultContinuity ( double  )
virtual

Set the continuity for all points. Default is 0.

virtual double vtkKochanekSpline::GetDefaultContinuity ( )
virtual

Set the continuity for all points. Default is 0.

virtual void vtkKochanekSpline::DeepCopy ( vtkSpline s)
virtual

Deep copy of cardinal spline data.

Reimplemented from vtkSpline.

void vtkKochanekSpline::Fit1D ( int  n,
double *  x,
double *  y,
double  tension,
double  bias,
double  continuity,
double  coefficients[][4],
int  leftConstraint,
double  leftValue,
int  rightConstraint,
double  rightValue 
)
protected

Member Data Documentation

double vtkKochanekSpline::DefaultBias
protected

Definition at line 101 of file vtkKochanekSpline.h.

double vtkKochanekSpline::DefaultTension
protected

Definition at line 102 of file vtkKochanekSpline.h.

double vtkKochanekSpline::DefaultContinuity
protected

Definition at line 103 of file vtkKochanekSpline.h.


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