VTK
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 Types inherited from vtkObject
typedef vtkObjectBase 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 ()
- Public Member Functions inherited from vtkSpline
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 ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
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 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 Member Functions inherited from vtkSpline
 vtkSpline ()
 ~vtkSpline ()
double ComputeLeftDerivative ()
double ComputeRightDerivative ()
int FindIndex (int size, double t)
- 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

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
vtkPiecewiseFunctionPiecewiseFunction
int Closed
double ParametricRange [2]
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

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.

Member Typedef Documentation

Definition at line 58 of file vtkKochanekSpline.h.

Constructor & Destructor Documentation

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

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.

double vtkKochanekSpline::DefaultTension
protected

Definition at line 101 of file vtkKochanekSpline.h.

double vtkKochanekSpline::DefaultContinuity
protected

Definition at line 102 of file vtkKochanekSpline.h.


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