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.vtkCachingInterpolatedVelocityField Class Reference

vtkCachingInterpolatedVelocityField - Interface for obtaining interpolated velocity values More...

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

List of all members.

Public Member Functions

 vtkCachingInterpolatedVelocityField (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkCachingInterpolatedVelocityField ()
 Construct a vtkCachingInterpolatedVelocityField with no initial data set. LastCellId is set to -1.
void ClearLastCellInfo ()
 Set the last cell id to -1 so that the next search does not start from the previous cell.
override int FunctionValues (IntPtr x, IntPtr f)
 Evaluate the velocity field, f={u,v,w}, at {x, y, z}. returns 1 if valid, 0 if test failed.
virtual int GetCacheMiss ()
 Caching statistics.
virtual int GetCellCacheHit ()
 Caching statistics.
virtual int GetDataSetCacheHit ()
 Caching statistics.
int GetLastLocalCoordinates (IntPtr pcoords)
 Returns the interpolation weights/pcoords cached from last evaluation if the cached cell is valid (returns 1). Otherwise, it does not change w and returns 0.
int GetLastWeights (IntPtr w)
 Returns the interpolation weights/pcoords cached from last evaluation if the cached cell is valid (returns 1). Otherwise, it does not change w and returns 0.
virtual string GetVectorsSelection ()
 If you want to work with an arbitrary vector array, then set its name here. By default this in NULL and the filter will use the active vector array.
virtual int InsideTest (IntPtr x)
 Evaluate the velocity field, f={u,v,w}, at {x, y, z}. returns 1 if valid, 0 if test failed.
override int IsA (string type)
 *Undocumented Block
new
vtkCachingInterpolatedVelocityField 
NewInstance ()
 *Undocumented Block
void SelectVectors (string fieldName)
 If you want to work with an arbitrary vector array, then set its name here. By default this in NULL and the filter will use the active vector array.
virtual void SetDataSet (int I, vtkDataSet dataset, bool staticdataset, vtkAbstractCellLocator locator)
 Add a dataset used by the interpolation function evaluation.
void SetLastCellInfo (int c, int datasetindex)
 Return the cell id cached from last evaluation.
- Public Member Functions inherited from Kitware.VTK.vtkFunctionSet
 vtkFunctionSet (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
virtual int GetNumberOfFunctions ()
 Return the number of functions. Note that this is constant for a given type of set of functions and can not be changed at run time.
virtual int GetNumberOfIndependentVariables ()
 Return the number of independent variables. Note that this is constant for a given type of set of functions and can not be changed at run time.
- 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.
virtual uint GetMTime ()
 Return this object's modified time.
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
vtkCachingInterpolatedVelocityField 
New ()
 Construct a vtkCachingInterpolatedVelocityField with no initial data set. LastCellId is set to -1.
static new int IsTypeOf (string type)
 *Undocumented Block
static new
vtkCachingInterpolatedVelocityField 
SafeDownCast (vtkObjectBase o)
 *Undocumented Block

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkCachingInterpolatedVelocityField"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkFunctionSet
- 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 = "35vtkCachingInterpolatedVelocityField"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkFunctionSet
- 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 vtkCachingInterpolatedVelocityField ()
 Automatically generated type registration mechanics.

Detailed Description

vtkCachingInterpolatedVelocityField - Interface for obtaining interpolated velocity values

Description vtkCachingInterpolatedVelocityField acts as a continuous velocity field by performing cell interpolation on the underlying vtkDataSet. This is a concrete sub-class of vtkFunctionSet with NumberOfIndependentVariables = 4 (x,y,z,t) and NumberOfFunctions = 3 (u,v,w). Normally, every time an evaluation is performed, the cell which contains the point (x,y,z) has to be found by calling FindCell. This is a computationally expensive operation. In certain cases, the cell search can be avoided or shortened by providing a guess for the cell id. For example, in streamline integration, the next evaluation is usually in the same or a neighbour cell. For this reason, vtkCachingInterpolatedVelocityField stores the last cell id. If caching is turned on, it uses this id as the starting point.


Constructor & Destructor Documentation

static Kitware.VTK.vtkCachingInterpolatedVelocityField.vtkCachingInterpolatedVelocityField ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkCachingInterpolatedVelocityField.vtkCachingInterpolatedVelocityField ( )

Construct a vtkCachingInterpolatedVelocityField with no initial data set. LastCellId is set to -1.


Member Function Documentation

void Kitware.VTK.vtkCachingInterpolatedVelocityField.ClearLastCellInfo ( )

Set the last cell id to -1 so that the next search does not start from the previous cell.

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

override int Kitware.VTK.vtkCachingInterpolatedVelocityField.FunctionValues ( IntPtr  x,
IntPtr  f 
)
virtual

Evaluate the velocity field, f={u,v,w}, at {x, y, z}. returns 1 if valid, 0 if test failed.

Reimplemented from Kitware.VTK.vtkFunctionSet.

virtual int Kitware.VTK.vtkCachingInterpolatedVelocityField.GetCacheMiss ( )
virtual

Caching statistics.

virtual int Kitware.VTK.vtkCachingInterpolatedVelocityField.GetCellCacheHit ( )
virtual

Caching statistics.

virtual int Kitware.VTK.vtkCachingInterpolatedVelocityField.GetDataSetCacheHit ( )
virtual

Caching statistics.

int Kitware.VTK.vtkCachingInterpolatedVelocityField.GetLastLocalCoordinates ( IntPtr  pcoords)

Returns the interpolation weights/pcoords cached from last evaluation if the cached cell is valid (returns 1). Otherwise, it does not change w and returns 0.

int Kitware.VTK.vtkCachingInterpolatedVelocityField.GetLastWeights ( IntPtr  w)

Returns the interpolation weights/pcoords cached from last evaluation if the cached cell is valid (returns 1). Otherwise, it does not change w and returns 0.

virtual string Kitware.VTK.vtkCachingInterpolatedVelocityField.GetVectorsSelection ( )
virtual

If you want to work with an arbitrary vector array, then set its name here. By default this in NULL and the filter will use the active vector array.

virtual int Kitware.VTK.vtkCachingInterpolatedVelocityField.InsideTest ( IntPtr  x)
virtual

Evaluate the velocity field, f={u,v,w}, at {x, y, z}. returns 1 if valid, 0 if test failed.

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

*Undocumented Block

Reimplemented from Kitware.VTK.vtkFunctionSet.

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

*Undocumented Block

Reimplemented from Kitware.VTK.vtkFunctionSet.

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

Construct a vtkCachingInterpolatedVelocityField with no initial data set. LastCellId is set to -1.

Reimplemented from Kitware.VTK.vtkObject.

new vtkCachingInterpolatedVelocityField Kitware.VTK.vtkCachingInterpolatedVelocityField.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkFunctionSet.

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

*Undocumented Block

Reimplemented from Kitware.VTK.vtkFunctionSet.

Here is the call graph for this function:

void Kitware.VTK.vtkCachingInterpolatedVelocityField.SelectVectors ( string  fieldName)

If you want to work with an arbitrary vector array, then set its name here. By default this in NULL and the filter will use the active vector array.

virtual void Kitware.VTK.vtkCachingInterpolatedVelocityField.SetDataSet ( int  I,
vtkDataSet  dataset,
bool  staticdataset,
vtkAbstractCellLocator  locator 
)
virtual

Add a dataset used by the interpolation function evaluation.

void Kitware.VTK.vtkCachingInterpolatedVelocityField.SetLastCellInfo ( int  c,
int  datasetindex 
)

Return the cell id cached from last evaluation.


Member Data Documentation

new readonly string Kitware.VTK.vtkCachingInterpolatedVelocityField.MRClassNameKey = "35vtkCachingInterpolatedVelocityField"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkFunctionSet.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkFunctionSet.


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