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

vtkSpline - spline abstract class for interpolating splines More...

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

List of all members.

Public Member Functions

 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 void Compute ()
 Compute the coefficients for the spline.
virtual void DeepCopy (vtkSpline s)
 Deep copy of spline data.
virtual double Evaluate (double t)
 Interpolate the value of the spline at parametric location of t.
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.
override int IsA (string type)
 Undocumented Block.
new vtkSpline NewInstance ()
 Undocumented Block.
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.

Static Public Member Functions

static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkSpline SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkSpline"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "9vtkSpline"
 Automatically generated type registration mechanics.

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.

Private Member Functions

static internal void vtkSpline_AddPoint_01 (HandleRef pThis, double t, double x)
static internal void vtkSpline_ClampValueOff_02 (HandleRef pThis)
static internal void vtkSpline_ClampValueOn_03 (HandleRef pThis)
static internal void vtkSpline_ClosedOff_04 (HandleRef pThis)
static internal void vtkSpline_ClosedOn_05 (HandleRef pThis)
static internal void vtkSpline_Compute_06 (HandleRef pThis)
static internal void vtkSpline_DeepCopy_07 (HandleRef pThis, HandleRef s)
static internal double vtkSpline_Evaluate_08 (HandleRef pThis, double t)
static internal int vtkSpline_GetClampValue_09 (HandleRef pThis)
static internal int vtkSpline_GetClosed_10 (HandleRef pThis)
static internal int vtkSpline_GetLeftConstraint_11 (HandleRef pThis)
static internal int vtkSpline_GetLeftConstraintMaxValue_12 (HandleRef pThis)
static internal int vtkSpline_GetLeftConstraintMinValue_13 (HandleRef pThis)
static internal double vtkSpline_GetLeftValue_14 (HandleRef pThis)
static internal uint vtkSpline_GetMTime_15 (HandleRef pThis)
static internal int vtkSpline_GetNumberOfPoints_16 (HandleRef pThis)
static internal void vtkSpline_GetParametricRange_17 (HandleRef pThis, IntPtr tRange)
static internal int vtkSpline_GetRightConstraint_18 (HandleRef pThis)
static internal int vtkSpline_GetRightConstraintMaxValue_19 (HandleRef pThis)
static internal int vtkSpline_GetRightConstraintMinValue_20 (HandleRef pThis)
static internal double vtkSpline_GetRightValue_21 (HandleRef pThis)
static internal int vtkSpline_IsA_22 (HandleRef pThis, string type)
static internal int vtkSpline_IsTypeOf_23 (string type)
static internal IntPtr vtkSpline_NewInstance_24 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSpline_RemoveAllPoints_25 (HandleRef pThis)
static internal void vtkSpline_RemovePoint_26 (HandleRef pThis, double t)
static internal IntPtr vtkSpline_SafeDownCast_27 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSpline_SetClampValue_28 (HandleRef pThis, int _arg)
static internal void vtkSpline_SetClosed_29 (HandleRef pThis, int _arg)
static internal void vtkSpline_SetLeftConstraint_30 (HandleRef pThis, int _arg)
static internal void vtkSpline_SetLeftValue_31 (HandleRef pThis, double _arg)
static internal void vtkSpline_SetParametricRange_32 (HandleRef pThis, double tMin, double tMax)
static internal void vtkSpline_SetParametricRange_33 (HandleRef pThis, IntPtr tRange)
static internal void vtkSpline_SetRightConstraint_34 (HandleRef pThis, int _arg)
static internal void vtkSpline_SetRightValue_35 (HandleRef pThis, double _arg)

Static Private Member Functions

static vtkSpline ()
 Automatically generated type registration mechanics.

Detailed Description

vtkSpline - spline abstract class for interpolating splines

Description vtkSpline interpolates a set of data points (i.e., interpolation means that the spline passes through the points). vtkSpline is an abstract class: its subclasses vtkCardinalSpline and vtkKochenekSpline do the interpolation. Note that this spline maps the 1D parametric coordinate t into a single value x. Thus if you want to use the spline to interpolate points (i.e. x[3]), you have to create three splines for each of the x-y-z coordinates. Fortunately, the vtkParametricSpline class does this for you.

Typically a spline is used by adding a sequence of parametric coordinate / data (t,x) values followed by use of an evaluation function (e.g., vtkCardinalSpline::Evaluate()). Since these splines are 1D, a point in this context is an independent / dependent variable pair.

Splines can also be set up to be closed or open. Closed splines continue from the last point to the first point with continuous function and derivative values. (You don't need to duplicate the first point to close the spline, just set ClosedOn.)

This implementation of splines does not use a normalized parametric coordinate. If the spline is open, then the parameter space is (tMin <= t <= tMax) where tMin and tMax are the minimum and maximum parametric values seen when performing AddPoint(). If the spline is closed, then the parameter space is (tMin <= t <= (tMax+1)) where tMin and tMax are the minimum and maximum parametric values seen when performing AddPoint(). Note, however, that this behavior can be changed by explicitly setting the ParametricRange(tMin,tMax). If set, the parameter space remains (tMin <= t <= tMax), except that additions of data with parametric values outside this range are clamped within this range.


Constructor & Destructor Documentation

static Kitware.VTK.vtkSpline.vtkSpline ( ) [static, private]

Automatically generated type registration mechanics.

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

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


Member Function Documentation

void Kitware.VTK.vtkSpline.AddPoint ( double  t,
double  x 
)

Add a pair of points to be fit with the spline.

virtual void Kitware.VTK.vtkSpline.ClampValueOff ( ) [virtual]

Set/Get ClampValue. If On, results of the interpolation will be clamped to the min/max of the input data.

virtual void Kitware.VTK.vtkSpline.ClampValueOn ( ) [virtual]

Set/Get ClampValue. If On, results of the interpolation will be clamped to the min/max of the input data.

virtual void Kitware.VTK.vtkSpline.ClosedOff ( ) [virtual]

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 Kitware.VTK.vtkSpline.ClosedOn ( ) [virtual]

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 Kitware.VTK.vtkSpline.Compute ( ) [virtual]

Compute the coefficients for the spline.

Reimplemented in Kitware.VTK.vtkKochanekSpline, Kitware.VTK.vtkCardinalSpline, and Kitware.VTK.vtkSCurveSpline.

virtual void Kitware.VTK.vtkSpline.DeepCopy ( vtkSpline  s) [virtual]
override void Kitware.VTK.vtkSpline.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.vtkObject.

Reimplemented in Kitware.VTK.vtkKochanekSpline, Kitware.VTK.vtkCardinalSpline, and Kitware.VTK.vtkSCurveSpline.

virtual double Kitware.VTK.vtkSpline.Evaluate ( double  t) [virtual]

Interpolate the value of the spline at parametric location of t.

Reimplemented in Kitware.VTK.vtkKochanekSpline, Kitware.VTK.vtkCardinalSpline, and Kitware.VTK.vtkSCurveSpline.

virtual int Kitware.VTK.vtkSpline.GetClampValue ( ) [virtual]

Set/Get ClampValue. If On, results of the interpolation will be clamped to the min/max of the input data.

virtual int Kitware.VTK.vtkSpline.GetClosed ( ) [virtual]

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 Kitware.VTK.vtkSpline.GetLeftConstraint ( ) [virtual]

Set the type of constraint of the left(right) end points. Four constraints are available:

0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points.

1: the first derivative at left(right) most point is set to Left(Right)Value.

2: the second derivative at left(right) most point is set to Left(Right)Value.

3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

Set the type of constraint of the left(right) end points. Four constraints are available:

0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points.

1: the first derivative at left(right) most point is set to Left(Right)Value.

2: the second derivative at left(right) most point is set to Left(Right)Value.

3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

Set the type of constraint of the left(right) end points. Four constraints are available:

0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points.

1: the first derivative at left(right) most point is set to Left(Right)Value.

2: the second derivative at left(right) most point is set to Left(Right)Value.

3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

virtual double Kitware.VTK.vtkSpline.GetLeftValue ( ) [virtual]

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 Kitware.VTK.vtkSpline.GetMTime ( ) [virtual]

Return the MTime also considering the Piecewise function.

Reimplemented from Kitware.VTK.vtkObject.

Return the number of points inserted thus far.

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 Kitware.VTK.vtkSpline.GetRightConstraint ( ) [virtual]

Set the type of constraint of the left(right) end points. Four constraints are available:

0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points.

1: the first derivative at left(right) most point is set to Left(Right)Value.

2: the second derivative at left(right) most point is set to Left(Right)Value.

3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

Set the type of constraint of the left(right) end points. Four constraints are available:

0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points.

1: the first derivative at left(right) most point is set to Left(Right)Value.

2: the second derivative at left(right) most point is set to Left(Right)Value.

3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

Set the type of constraint of the left(right) end points. Four constraints are available:

0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points.

1: the first derivative at left(right) most point is set to Left(Right)Value.

2: the second derivative at left(right) most point is set to Left(Right)Value.

3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

virtual double Kitware.VTK.vtkSpline.GetRightValue ( ) [virtual]

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 int Kitware.VTK.vtkSpline.IsA ( string  type) [virtual]
static new int Kitware.VTK.vtkSpline.IsTypeOf ( string  type) [static]

Remove all points from the data.

Remove a point from the data to be fit with the spline.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkKochanekSpline, Kitware.VTK.vtkSCurveSpline, and Kitware.VTK.vtkCardinalSpline.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkSpline.SetClampValue ( int  _arg) [virtual]

Set/Get ClampValue. If On, results of the interpolation will be clamped to the min/max of the input data.

virtual void Kitware.VTK.vtkSpline.SetClosed ( int  _arg) [virtual]

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 Kitware.VTK.vtkSpline.SetLeftConstraint ( int  _arg) [virtual]

Set the type of constraint of the left(right) end points. Four constraints are available:

0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points.

1: the first derivative at left(right) most point is set to Left(Right)Value.

2: the second derivative at left(right) most point is set to Left(Right)Value.

3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

virtual void Kitware.VTK.vtkSpline.SetLeftValue ( double  _arg) [virtual]

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 Kitware.VTK.vtkSpline.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.

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 Kitware.VTK.vtkSpline.SetRightConstraint ( int  _arg) [virtual]

Set the type of constraint of the left(right) end points. Four constraints are available:

0: the first derivative at left(right) most point is determined from the line defined from the first(last) two points.

1: the first derivative at left(right) most point is set to Left(Right)Value.

2: the second derivative at left(right) most point is set to Left(Right)Value.

3: the second derivative at left(right)most points is Left(Right)Value times second derivative at first interior point.

virtual void Kitware.VTK.vtkSpline.SetRightValue ( double  _arg) [virtual]

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.

static internal void Kitware.VTK.vtkSpline.vtkSpline_AddPoint_01 ( HandleRef  pThis,
double  t,
double  x 
) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_ClampValueOff_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_ClampValueOn_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_ClosedOff_04 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_ClosedOn_05 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_Compute_06 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_DeepCopy_07 ( HandleRef  pThis,
HandleRef  s 
) [private]
static internal double Kitware.VTK.vtkSpline.vtkSpline_Evaluate_08 ( HandleRef  pThis,
double  t 
) [private]
static internal int Kitware.VTK.vtkSpline.vtkSpline_GetClampValue_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSpline.vtkSpline_GetClosed_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSpline.vtkSpline_GetLeftConstraint_11 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSpline.vtkSpline_GetLeftConstraintMaxValue_12 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSpline.vtkSpline_GetLeftConstraintMinValue_13 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkSpline.vtkSpline_GetLeftValue_14 ( HandleRef  pThis) [private]
static internal uint Kitware.VTK.vtkSpline.vtkSpline_GetMTime_15 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSpline.vtkSpline_GetNumberOfPoints_16 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_GetParametricRange_17 ( HandleRef  pThis,
IntPtr  tRange 
) [private]
static internal int Kitware.VTK.vtkSpline.vtkSpline_GetRightConstraint_18 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSpline.vtkSpline_GetRightConstraintMaxValue_19 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSpline.vtkSpline_GetRightConstraintMinValue_20 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkSpline.vtkSpline_GetRightValue_21 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSpline.vtkSpline_IsA_22 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkSpline.vtkSpline_IsTypeOf_23 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkSpline.vtkSpline_NewInstance_24 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_RemoveAllPoints_25 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_RemovePoint_26 ( HandleRef  pThis,
double  t 
) [private]
static internal IntPtr Kitware.VTK.vtkSpline.vtkSpline_SafeDownCast_27 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_SetClampValue_28 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_SetClosed_29 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_SetLeftConstraint_30 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_SetLeftValue_31 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_SetParametricRange_32 ( HandleRef  pThis,
double  tMin,
double  tMax 
) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_SetParametricRange_33 ( HandleRef  pThis,
IntPtr  tRange 
) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_SetRightConstraint_34 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkSpline.vtkSpline_SetRightValue_35 ( HandleRef  pThis,
double  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkSpline.MRClassNameKey = "9vtkSpline" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkKochanekSpline, Kitware.VTK.vtkCardinalSpline, and Kitware.VTK.vtkSCurveSpline.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkKochanekSpline, Kitware.VTK.vtkCardinalSpline, and Kitware.VTK.vtkSCurveSpline.


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