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

vtkTupleInterpolator - interpolate a tuple of arbitray size More...

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

List of all members.

Public Types

enum  INTERPOLATION_TYPE_LINEAR_WrapperEnum { INTERPOLATION_TYPE_LINEAR = 0, INTERPOLATION_TYPE_SPLINE = 1 }
 Interpolate the list of tuples and determine a new tuple (i.e., fill in the tuple provided). If t is outside the range of (min,max) values, then t is clamped. Note that each component of tuple[] is interpolated independently. More...

Public Member Functions

 vtkTupleInterpolator (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkTupleInterpolator ()
 Instantiate the class.
void AddTuple (double t, IntPtr tuple)
 Add another tuple to the list of tuples to be interpolated. Note that using the same time t value more than once replaces the previous tuple value at t. At least two tuples must be added to define an interpolation function.
virtual vtkSpline GetInterpolatingSpline ()
 If the InterpolationType is set to spline, then this method applies. By default Kochanek interpolation is used, but you can specify any instance of vtkSpline to use. Note that the actual interpolating splines are created by invoking NewInstance() followed by DeepCopy() on the interpolating spline specified here, for each tuple component to interpolate.
virtual int GetInterpolationType ()
 Specify which type of function to use for interpolation. By default spline interpolation (SetInterpolationFunctionToSpline()) is used (i.e., a Kochanek spline) and the InterpolatingSpline instance variable is used to birth the actual interpolation splines via a combination of NewInstance() and DeepCopy(). You may also choose to use linear interpolation by invoking SetInterpolationFunctionToLinear(). Note that changing the type of interpolation causes previously inserted data to be discarded.
double GetMaximumT ()
 Obtain some information about the interpolation range. The numbers returned (corresponding to parameter t, usually thought of as time) are undefined if the list of transforms is empty. This is a convenience method for interpolation.
double GetMinimumT ()
 Obtain some information about the interpolation range. The numbers returned (corresponding to parameter t, usually thought of as time) are undefined if the list of transforms is empty. This is a convenience method for interpolation.
virtual int GetNumberOfComponents ()
 Specify the number of tuple components to interpolate. Note that setting this value discards any previously inserted data.
int GetNumberOfTuples ()
 Return the number of tuples in the list of tuples to be interpolated.
void Initialize ()
 Reset the class so that it contains no (t,tuple) information.
void InterpolateTuple (double t, IntPtr tuple)
 Interpolate the list of tuples and determine a new tuple (i.e., fill in the tuple provided). If t is outside the range of (min,max) values, then t is clamped. Note that each component of tuple[] is interpolated independently.
override int IsA (string type)
 Undocumented Block.
new vtkTupleInterpolator NewInstance ()
 Undocumented Block.
void RemoveTuple (double t)
 Delete the tuple at a particular parameter t. If there is no tuple defined at t, then the method does nothing.
void SetInterpolatingSpline (vtkSpline arg0)
 If the InterpolationType is set to spline, then this method applies. By default Kochanek interpolation is used, but you can specify any instance of vtkSpline to use. Note that the actual interpolating splines are created by invoking NewInstance() followed by DeepCopy() on the interpolating spline specified here, for each tuple component to interpolate.
void SetInterpolationType (int type)
 Specify which type of function to use for interpolation. By default spline interpolation (SetInterpolationFunctionToSpline()) is used (i.e., a Kochanek spline) and the InterpolatingSpline instance variable is used to birth the actual interpolation splines via a combination of NewInstance() and DeepCopy(). You may also choose to use linear interpolation by invoking SetInterpolationFunctionToLinear(). Note that changing the type of interpolation causes previously inserted data to be discarded.
void SetInterpolationTypeToLinear ()
 Specify which type of function to use for interpolation. By default spline interpolation (SetInterpolationFunctionToSpline()) is used (i.e., a Kochanek spline) and the InterpolatingSpline instance variable is used to birth the actual interpolation splines via a combination of NewInstance() and DeepCopy(). You may also choose to use linear interpolation by invoking SetInterpolationFunctionToLinear(). Note that changing the type of interpolation causes previously inserted data to be discarded.
void SetInterpolationTypeToSpline ()
 Specify which type of function to use for interpolation. By default spline interpolation (SetInterpolationFunctionToSpline()) is used (i.e., a Kochanek spline) and the InterpolatingSpline instance variable is used to birth the actual interpolation splines via a combination of NewInstance() and DeepCopy(). You may also choose to use linear interpolation by invoking SetInterpolationFunctionToLinear(). Note that changing the type of interpolation causes previously inserted data to be discarded.
void SetNumberOfComponents (int numComp)
 Specify the number of tuple components to interpolate. Note that setting this value discards any previously inserted data.

Static Public Member Functions

static new vtkTupleInterpolator New ()
 Instantiate the class.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkTupleInterpolator SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "20vtkTupleInterpolator"
 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 IntPtr vtkTupleInterpolator_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTupleInterpolator_AddTuple_01 (HandleRef pThis, double t, IntPtr tuple)
static internal IntPtr vtkTupleInterpolator_GetInterpolatingSpline_02 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkTupleInterpolator_GetInterpolationType_03 (HandleRef pThis)
static internal double vtkTupleInterpolator_GetMaximumT_04 (HandleRef pThis)
static internal double vtkTupleInterpolator_GetMinimumT_05 (HandleRef pThis)
static internal int vtkTupleInterpolator_GetNumberOfComponents_06 (HandleRef pThis)
static internal int vtkTupleInterpolator_GetNumberOfTuples_07 (HandleRef pThis)
static internal void vtkTupleInterpolator_Initialize_08 (HandleRef pThis)
static internal void vtkTupleInterpolator_InterpolateTuple_09 (HandleRef pThis, double t, IntPtr tuple)
static internal int vtkTupleInterpolator_IsA_10 (HandleRef pThis, string type)
static internal int vtkTupleInterpolator_IsTypeOf_11 (string type)
static internal IntPtr vtkTupleInterpolator_NewInstance_13 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTupleInterpolator_RemoveTuple_14 (HandleRef pThis, double t)
static internal IntPtr vtkTupleInterpolator_SafeDownCast_15 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTupleInterpolator_SetInterpolatingSpline_16 (HandleRef pThis, HandleRef arg0)
static internal void vtkTupleInterpolator_SetInterpolationType_17 (HandleRef pThis, int type)
static internal void vtkTupleInterpolator_SetInterpolationTypeToLinear_18 (HandleRef pThis)
static internal void vtkTupleInterpolator_SetInterpolationTypeToSpline_19 (HandleRef pThis)
static internal void vtkTupleInterpolator_SetNumberOfComponents_20 (HandleRef pThis, int numComp)

Static Private Member Functions

static vtkTupleInterpolator ()
 Automatically generated type registration mechanics.

Detailed Description

vtkTupleInterpolator - interpolate a tuple of arbitray size

Description This class is used to interpolate a tuple which may have an arbitrary number of components (but at least one component). The interpolation may be linear in form, or via a subclasses of vtkSpline.

To use this class, begin by specifying the number of components of the tuple and the interpolation function to use. Then specify at least one pair of (t,tuple) with the AddTuple() method. Next interpolate the tuples with the InterpolateTuple(t,tuple) method, where "t" must be in the range of (t_min,t_max) parameter values specified by the AddTuple() method (if not then t is clamped), and tuple[] is filled in by the method (make sure that tuple [] is long enough to hold the interpolated data).

You can control the type of interpolation to use. By default, the interpolation is based on a Kochanek spline. However, other types of splines can be specified. You can also set the interpolation method to linear, in which case the specified spline has no effect on the interpolation.


Member Enumeration Documentation

Interpolate the list of tuples and determine a new tuple (i.e., fill in the tuple provided). If t is outside the range of (min,max) values, then t is clamped. Note that each component of tuple[] is interpolated independently.

Enumerator:
INTERPOLATION_TYPE_LINEAR 

enum member

INTERPOLATION_TYPE_SPLINE 

enum member


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Instantiate the class.


Member Function Documentation

void Kitware.VTK.vtkTupleInterpolator.AddTuple ( double  t,
IntPtr  tuple 
)

Add another tuple to the list of tuples to be interpolated. Note that using the same time t value more than once replaces the previous tuple value at t. At least two tuples must be added to define an interpolation function.

override void Kitware.VTK.vtkTupleInterpolator.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.

If the InterpolationType is set to spline, then this method applies. By default Kochanek interpolation is used, but you can specify any instance of vtkSpline to use. Note that the actual interpolating splines are created by invoking NewInstance() followed by DeepCopy() on the interpolating spline specified here, for each tuple component to interpolate.

Here is the call graph for this function:

Specify which type of function to use for interpolation. By default spline interpolation (SetInterpolationFunctionToSpline()) is used (i.e., a Kochanek spline) and the InterpolatingSpline instance variable is used to birth the actual interpolation splines via a combination of NewInstance() and DeepCopy(). You may also choose to use linear interpolation by invoking SetInterpolationFunctionToLinear(). Note that changing the type of interpolation causes previously inserted data to be discarded.

Obtain some information about the interpolation range. The numbers returned (corresponding to parameter t, usually thought of as time) are undefined if the list of transforms is empty. This is a convenience method for interpolation.

Obtain some information about the interpolation range. The numbers returned (corresponding to parameter t, usually thought of as time) are undefined if the list of transforms is empty. This is a convenience method for interpolation.

Specify the number of tuple components to interpolate. Note that setting this value discards any previously inserted data.

Return the number of tuples in the list of tuples to be interpolated.

Reset the class so that it contains no (t,tuple) information.

void Kitware.VTK.vtkTupleInterpolator.InterpolateTuple ( double  t,
IntPtr  tuple 
)

Interpolate the list of tuples and determine a new tuple (i.e., fill in the tuple provided). If t is outside the range of (min,max) values, then t is clamped. Note that each component of tuple[] is interpolated independently.

override int Kitware.VTK.vtkTupleInterpolator.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

static new int Kitware.VTK.vtkTupleInterpolator.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Instantiate the class.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Delete the tuple at a particular parameter t. If there is no tuple defined at t, then the method does nothing.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

If the InterpolationType is set to spline, then this method applies. By default Kochanek interpolation is used, but you can specify any instance of vtkSpline to use. Note that the actual interpolating splines are created by invoking NewInstance() followed by DeepCopy() on the interpolating spline specified here, for each tuple component to interpolate.

Specify which type of function to use for interpolation. By default spline interpolation (SetInterpolationFunctionToSpline()) is used (i.e., a Kochanek spline) and the InterpolatingSpline instance variable is used to birth the actual interpolation splines via a combination of NewInstance() and DeepCopy(). You may also choose to use linear interpolation by invoking SetInterpolationFunctionToLinear(). Note that changing the type of interpolation causes previously inserted data to be discarded.

Specify which type of function to use for interpolation. By default spline interpolation (SetInterpolationFunctionToSpline()) is used (i.e., a Kochanek spline) and the InterpolatingSpline instance variable is used to birth the actual interpolation splines via a combination of NewInstance() and DeepCopy(). You may also choose to use linear interpolation by invoking SetInterpolationFunctionToLinear(). Note that changing the type of interpolation causes previously inserted data to be discarded.

Specify which type of function to use for interpolation. By default spline interpolation (SetInterpolationFunctionToSpline()) is used (i.e., a Kochanek spline) and the InterpolatingSpline instance variable is used to birth the actual interpolation splines via a combination of NewInstance() and DeepCopy(). You may also choose to use linear interpolation by invoking SetInterpolationFunctionToLinear(). Note that changing the type of interpolation causes previously inserted data to be discarded.

Specify the number of tuple components to interpolate. Note that setting this value discards any previously inserted data.

static internal void Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_AddTuple_01 ( HandleRef  pThis,
double  t,
IntPtr  tuple 
) [private]
static internal IntPtr Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_GetInterpolatingSpline_02 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_GetInterpolationType_03 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_GetMaximumT_04 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_GetMinimumT_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_GetNumberOfComponents_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_GetNumberOfTuples_07 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_Initialize_08 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_InterpolateTuple_09 ( HandleRef  pThis,
double  t,
IntPtr  tuple 
) [private]
static internal int Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_IsA_10 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_IsTypeOf_11 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_NewInstance_13 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_RemoveTuple_14 ( HandleRef  pThis,
double  t 
) [private]
static internal IntPtr Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_SafeDownCast_15 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_SetInterpolatingSpline_16 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_SetInterpolationType_17 ( HandleRef  pThis,
int  type 
) [private]
static internal void Kitware.VTK.vtkTupleInterpolator.vtkTupleInterpolator_SetNumberOfComponents_20 ( HandleRef  pThis,
int  numComp 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkTupleInterpolator.MRClassNameKey = "20vtkTupleInterpolator" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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