ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Private Member Functions
Kitware.VTK.vtkKochanekSpline Class Reference

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

Inheritance diagram for Kitware.VTK.vtkKochanekSpline:
[legend]
Collaboration diagram for Kitware.VTK.vtkKochanekSpline:
[legend]

List of all members.

Public Member Functions

 vtkKochanekSpline (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkKochanekSpline ()
 Construct a KochanekSpline with the following defaults: DefaultBias = 0, DefaultTension = 0, DefaultContinuity = 0.
override void Compute ()
 Compute Kochanek Spline coefficients.
override void DeepCopy (vtkSpline s)
 Deep copy of cardinal spline data.
override double Evaluate (double t)
 Evaluate a 1D Kochanek spline.
virtual double GetDefaultBias ()
 Set the bias for all points. Default is 0.
virtual double GetDefaultContinuity ()
 Set the continuity for all points. Default is 0.
virtual double GetDefaultTension ()
 Set the tension for all points. Default is 0.
override int IsA (string type)
 *Undocumented Block
new vtkKochanekSpline NewInstance ()
 *Undocumented Block
virtual void SetDefaultBias (double _arg)
 Set the bias for all points. Default is 0.
virtual void SetDefaultContinuity (double _arg)
 Set the continuity for all points. Default is 0.
virtual void SetDefaultTension (double _arg)
 Set the tension for all points. Default is 0.
- Public Member Functions inherited from Kitware.VTK.vtkSpline
 vtkSpline (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
void AddPoint (double t, double x)
 Add a pair of points to be fit with the spline.
virtual void ClampValueOff ()
 Set/Get ClampValue. If On, results of the interpolation will be clamped to the min/max of the input data.
virtual void ClampValueOn ()
 Set/Get ClampValue. If On, results of the interpolation will be clamped to the min/max of the input data.
virtual void ClosedOff ()
 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 ClosedOn ()
 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 GetClampValue ()
 Set/Get ClampValue. If On, results of the interpolation will be clamped to the min/max of the input data.
virtual int GetClosed ()
 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 GetLeftConstraint ()
 Set the type of constraint of the left(right) end points. Four constraints are available:
virtual int GetLeftConstraintMaxValue ()
 Set the type of constraint of the left(right) end points. Four constraints are available:
virtual int GetLeftConstraintMinValue ()
 Set the type of constraint of the left(right) end points. Four constraints are available:
virtual double GetLeftValue ()
 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.
override uint GetMTime ()
 Return the MTime also considering the Piecewise function.
int GetNumberOfPoints ()
 Return the number of points inserted thus far.
void GetParametricRange (IntPtr tRange)
 Set/Get the parametric range. If not set, the range is determined implicitly by keeping track of the (min,max) parameter values for t. If set, the AddPoint() method will clamp the t value to lie within the specified range.
virtual int GetRightConstraint ()
 Set the type of constraint of the left(right) end points. Four constraints are available:
virtual int GetRightConstraintMaxValue ()
 Set the type of constraint of the left(right) end points. Four constraints are available:
virtual int GetRightConstraintMinValue ()
 Set the type of constraint of the left(right) end points. Four constraints are available:
virtual double GetRightValue ()
 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.
void RemoveAllPoints ()
 Remove all points from the data.
void RemovePoint (double t)
 Remove a point from the data to be fit with the spline.
virtual void SetClampValue (int _arg)
 Set/Get ClampValue. If On, results of the interpolation will be clamped to the min/max of the input data.
virtual void SetClosed (int _arg)
 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 SetLeftConstraint (int _arg)
 Set the type of constraint of the left(right) end points. Four constraints are available:
virtual void SetLeftValue (double _arg)
 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.
void SetParametricRange (double tMin, double tMax)
 Set/Get the parametric range. If not set, the range is determined implicitly by keeping track of the (min,max) parameter values for t. If set, the AddPoint() method will clamp the t value to lie within the specified range.
void SetParametricRange (IntPtr tRange)
 Set/Get the parametric range. If not set, the range is determined implicitly by keeping track of the (min,max) parameter values for t. If set, the AddPoint() method will clamp the t value to lie within the specified range.
virtual void SetRightConstraint (int _arg)
 Set the type of constraint of the left(right) end points. Four constraints are available:
virtual void SetRightValue (double _arg)
 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.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new vtkKochanekSpline New ()
 Construct a KochanekSpline with the following defaults: DefaultBias = 0, DefaultTension = 0, DefaultContinuity = 0.
static new int IsTypeOf (string type)
 *Undocumented Block
static new vtkKochanekSpline SafeDownCast (vtkObjectBase o)
 *Undocumented Block

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkKochanekSpline"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkSpline
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "17vtkKochanekSpline"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkSpline
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions

static vtkKochanekSpline ()
 Automatically generated type registration mechanics.

Detailed Description

vtkKochanekSpline - computes an interpolating spline using a Kochanek basis.

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


Constructor & Destructor Documentation

static Kitware.VTK.vtkKochanekSpline.vtkKochanekSpline ( )
staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkKochanekSpline.vtkKochanekSpline ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkKochanekSpline.vtkKochanekSpline ( )

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


Member Function Documentation

override void Kitware.VTK.vtkKochanekSpline.Compute ( )
virtual

Compute Kochanek Spline coefficients.

Reimplemented from Kitware.VTK.vtkSpline.

override void Kitware.VTK.vtkKochanekSpline.DeepCopy ( vtkSpline  s)
virtual

Deep copy of cardinal spline data.

Reimplemented from Kitware.VTK.vtkSpline.

override void Kitware.VTK.vtkKochanekSpline.Dispose ( bool  disposing)
protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkSpline.

override double Kitware.VTK.vtkKochanekSpline.Evaluate ( double  t)
virtual

Evaluate a 1D Kochanek spline.

Reimplemented from Kitware.VTK.vtkSpline.

virtual double Kitware.VTK.vtkKochanekSpline.GetDefaultBias ( )
virtual

Set the bias for all points. Default is 0.

virtual double Kitware.VTK.vtkKochanekSpline.GetDefaultContinuity ( )
virtual

Set the continuity for all points. Default is 0.

virtual double Kitware.VTK.vtkKochanekSpline.GetDefaultTension ( )
virtual

Set the tension for all points. Default is 0.

override int Kitware.VTK.vtkKochanekSpline.IsA ( string  type)
virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkSpline.

static new int Kitware.VTK.vtkKochanekSpline.IsTypeOf ( string  type)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkSpline.

static new vtkKochanekSpline Kitware.VTK.vtkKochanekSpline.New ( )
static

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

Reimplemented from Kitware.VTK.vtkObject.

new vtkKochanekSpline Kitware.VTK.vtkKochanekSpline.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkSpline.

static new vtkKochanekSpline Kitware.VTK.vtkKochanekSpline.SafeDownCast ( vtkObjectBase  o)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkSpline.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkKochanekSpline.SetDefaultBias ( double  _arg)
virtual

Set the bias for all points. Default is 0.

virtual void Kitware.VTK.vtkKochanekSpline.SetDefaultContinuity ( double  _arg)
virtual

Set the continuity for all points. Default is 0.

virtual void Kitware.VTK.vtkKochanekSpline.SetDefaultTension ( double  _arg)
virtual

Set the tension for all points. Default is 0.


Member Data Documentation

new readonly string Kitware.VTK.vtkKochanekSpline.MRClassNameKey = "17vtkKochanekSpline"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkSpline.

new const string Kitware.VTK.vtkKochanekSpline.MRFullTypeName = "Kitware.VTK.vtkKochanekSpline"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkSpline.


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