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 Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkKochanekSplineNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Compute () override
 Compute Kochanek Spline coefficients. More...
 
double Evaluate (double t) override
 Evaluate a 1D Kochanek spline. More...
 
virtual void SetDefaultBias (double)
 Set the bias for all points. More...
 
virtual double GetDefaultBias ()
 
virtual void SetDefaultTension (double)
 Set the tension for all points. More...
 
virtual double GetDefaultTension ()
 
virtual void SetDefaultContinuity (double)
 Set the continuity for all points. More...
 
virtual double GetDefaultContinuity ()
 
void DeepCopy (vtkSpline *s) override
 Deep copy of cardinal spline data. More...
 
- Public Member Functions inherited from vtkSpline
vtkSplineNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetParametricRange (double tMin, double tMax)
 Set/Get the parametric range. More...
 
void SetParametricRange (double tRange[2])
 
void GetParametricRange (double tRange[2]) const
 
virtual void SetClampValue (vtkTypeBool)
 Set/Get ClampValue. More...
 
virtual vtkTypeBool GetClampValue ()
 
virtual void ClampValueOn ()
 
virtual void ClampValueOff ()
 
int GetNumberOfPoints ()
 Return the number of points inserted thus far. More...
 
void AddPoint (double t, double x)
 Add a pair of points to be fit with the spline. More...
 
void RemovePoint (double t)
 Remove a point from the data to be fit with the spline. More...
 
void RemoveAllPoints ()
 Remove all points from the data. More...
 
virtual void SetClosed (vtkTypeBool)
 Control whether the spline is open or closed. More...
 
virtual vtkTypeBool GetClosed ()
 
virtual void ClosedOn ()
 
virtual void ClosedOff ()
 
virtual void SetLeftConstraint (int)
 Set the type of constraint of the left(right) end points. More...
 
virtual int GetLeftConstraint ()
 
virtual void SetRightConstraint (int)
 
virtual int GetRightConstraint ()
 
virtual void SetLeftValue (double)
 The values of the derivative on the left and right sides. More...
 
virtual double GetLeftValue ()
 
virtual void SetRightValue (double)
 
virtual double GetRightValue ()
 
vtkMTimeType GetMTime () override
 Return the MTime also considering the Piecewise function. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkKochanekSplineSafeDownCast (vtkObjectBase *o)
 
static vtkKochanekSplineNew ()
 Construct a KochanekSpline with the following defaults: DefaultBias = 0, DefaultTension = 0, DefaultContinuity = 0. More...
 
- Static Public Member Functions inherited from vtkSpline
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSplineSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkKochanekSpline ()
 
 ~vtkKochanekSpline () override
 
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 () override
 
double ComputeLeftDerivative ()
 
double ComputeRightDerivative ()
 
int FindIndex (int size, double t)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double DefaultBias
 
double DefaultTension
 
double DefaultContinuity
 
- Protected Attributes inherited from vtkSpline
vtkMTimeType ComputeTime
 
vtkTypeBool ClampValue
 
double * Intervals
 
double * Coefficients
 
int LeftConstraint
 
double LeftValue
 
int RightConstraint
 
double RightValue
 
vtkPiecewiseFunctionPiecewiseFunction
 
vtkTypeBool Closed
 
double ParametricRange [2]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

computes an interpolating spline using a Kochanek basis.

Implements the Kochanek 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

Definition at line 51 of file vtkKochanekSpline.h.

Member Typedef Documentation

◆ Superclass

Definition at line 54 of file vtkKochanekSpline.h.

Constructor & Destructor Documentation

◆ vtkKochanekSpline()

vtkKochanekSpline::vtkKochanekSpline ( )
protected

◆ ~vtkKochanekSpline()

vtkKochanekSpline::~vtkKochanekSpline ( )
inlineoverrideprotected

Definition at line 104 of file vtkKochanekSpline.h.

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkKochanekSpline::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

static vtkKochanekSpline* vtkKochanekSpline::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkKochanekSpline::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkSpline.

◆ NewInstance()

vtkKochanekSpline* vtkKochanekSpline::NewInstance ( ) const

◆ PrintSelf()

void vtkKochanekSpline::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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

◆ New()

static vtkKochanekSpline* vtkKochanekSpline::New ( )
static

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

◆ Compute()

void vtkKochanekSpline::Compute ( )
overridevirtual

Compute Kochanek Spline coefficients.

Implements vtkSpline.

◆ Evaluate()

double vtkKochanekSpline::Evaluate ( double  t)
overridevirtual

Evaluate a 1D Kochanek spline.

Implements vtkSpline.

◆ SetDefaultBias()

virtual void vtkKochanekSpline::SetDefaultBias ( double  )
virtual

Set the bias for all points.

Default is 0.

◆ GetDefaultBias()

virtual double vtkKochanekSpline::GetDefaultBias ( )
virtual

◆ SetDefaultTension()

virtual void vtkKochanekSpline::SetDefaultTension ( double  )
virtual

Set the tension for all points.

Default is 0.

◆ GetDefaultTension()

virtual double vtkKochanekSpline::GetDefaultTension ( )
virtual

◆ SetDefaultContinuity()

virtual void vtkKochanekSpline::SetDefaultContinuity ( double  )
virtual

Set the continuity for all points.

Default is 0.

◆ GetDefaultContinuity()

virtual double vtkKochanekSpline::GetDefaultContinuity ( )
virtual

◆ DeepCopy()

void vtkKochanekSpline::DeepCopy ( vtkSpline s)
overridevirtual

Deep copy of cardinal spline data.

Reimplemented from vtkSpline.

◆ Fit1D()

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

◆ DefaultBias

double vtkKochanekSpline::DefaultBias
protected

Definition at line 110 of file vtkKochanekSpline.h.

◆ DefaultTension

double vtkKochanekSpline::DefaultTension
protected

Definition at line 111 of file vtkKochanekSpline.h.

◆ DefaultContinuity

double vtkKochanekSpline::DefaultContinuity
protected

Definition at line 112 of file vtkKochanekSpline.h.


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