vtkKochanekSpline Class Reference

#include <vtkKochanekSpline.h>

Inheritance diagram for vtkKochanekSpline:

Inheritance graph
[legend]
Collaboration diagram for vtkKochanekSpline:

Collaboration graph
[legend]

List of all members.


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 55 of file vtkKochanekSpline.h.


Public Types

typedef vtkSpline Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
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 ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkKochanekSplineSafeDownCast (vtkObject *o)
static vtkKochanekSplineNew ()

Protected Member Functions

 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 Attributes

double DefaultBias
double DefaultTension
double DefaultContinuity

Member Typedef Documentation

Reimplemented from vtkSpline.

Definition at line 58 of file vtkKochanekSpline.h.


Constructor & Destructor Documentation

vtkKochanekSpline::vtkKochanekSpline (  )  [protected]

vtkKochanekSpline::~vtkKochanekSpline (  )  [inline, protected]

Definition at line 94 of file vtkKochanekSpline.h.


Member Function Documentation

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

Reimplemented from vtkSpline.

static int vtkKochanekSpline::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 vtkSpline.

virtual int vtkKochanekSpline::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 vtkSpline.

static vtkKochanekSpline* vtkKochanekSpline::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkSpline.

void vtkKochanekSpline::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 vtkSpline.

static vtkKochanekSpline* vtkKochanekSpline::New (  )  [static]

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

Reimplemented from vtkObject.

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 100 of file vtkKochanekSpline.h.

Definition at line 101 of file vtkKochanekSpline.h.

Definition at line 102 of file vtkKochanekSpline.h.


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

Generated on Mon Sep 27 18:31:50 2010 for VTK by  doxygen 1.5.6