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

vtkTemporalPathLineFilter - Generate a Polydata Pointset from any Dataset. More...

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

List of all members.

Public Member Functions

 vtkTemporalPathLineFilter (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkTemporalPathLineFilter ()
 Standard Type-Macro.
void Flush ()
 Flush will wipe any existing data so that traces can be restarted from whatever time step is next supplied.
virtual string GetIdChannelArray ()
 Specify the name of a scalar array which will be used to fetch the index of each point. This is necessary only if the particles change position (Id order) on each time step. The Id can be used to identify particles at each step and hence track them properly. If this array is NULL, the global point ids are used. If an Id array cannot otherwise be found, the point index is used as the ID.
virtual int GetKeepDeadTrails ()
 When a particle 'disappears', the trail belonging to it is removed from the list. When this flag is enabled, dead trails will persist until the next time the list is cleared. Use carefully as it may cause excessive memory consumption if left on by mistake.
virtual int GetMaskPoints ()
 Set the number of particles to track as a ratio of the input example: setting MaskPoints to 10 will track every 10th point.
virtual double[] GetMaxStepDistance ()
 If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part kept).
virtual void GetMaxStepDistance (ref double _arg1, ref double _arg2, ref double _arg3)
 If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part kept).
virtual void GetMaxStepDistance (IntPtr _arg)
 If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part kept).
virtual uint GetMaxTrackLength ()
 If the Particles being traced animate for a long time, the trails or traces will become long and stringy. Setting the MaxTraceTimeLength will limit how much of the trace is displayed. Tracks longer then the Max will disappear and the trace will apppear like a snake of fixed length which progresses as the particle moves.
override int IsA (string type)
 Standard Type-Macro.
new vtkTemporalPathLineFilter NewInstance ()
 Standard Type-Macro.
virtual void SetIdChannelArray (string _arg)
 Specify the name of a scalar array which will be used to fetch the index of each point. This is necessary only if the particles change position (Id order) on each time step. The Id can be used to identify particles at each step and hence track them properly. If this array is NULL, the global point ids are used. If an Id array cannot otherwise be found, the point index is used as the ID.
virtual void SetKeepDeadTrails (int _arg)
 When a particle 'disappears', the trail belonging to it is removed from the list. When this flag is enabled, dead trails will persist until the next time the list is cleared. Use carefully as it may cause excessive memory consumption if left on by mistake.
virtual void SetMaskPoints (int _arg)
 Set the number of particles to track as a ratio of the input example: setting MaskPoints to 10 will track every 10th point.
virtual void SetMaxStepDistance (double _arg1, double _arg2, double _arg3)
 If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part kept).
virtual void SetMaxStepDistance (IntPtr _arg)
 If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part kept).
virtual void SetMaxTrackLength (uint _arg)
 If the Particles being traced animate for a long time, the trails or traces will become long and stringy. Setting the MaxTraceTimeLength will limit how much of the trace is displayed. Tracks longer then the Max will disappear and the trace will apppear like a snake of fixed length which progresses as the particle moves.
void SetSelection (vtkDataSet input)
 Set a second input which is a selection. Particles with the same Id in the selection as the primary input will be chosen for pathlines Note that you must have the same IdChannelArray in the selection as the input.
void SetSelectionConnection (vtkAlgorithmOutput algOutput)
 Set a second input which is a selection. Particles with the same Id in the selection as the primary input will be chosen for pathlines Note that you must have the same IdChannelArray in the selection as the input.

Static Public Member Functions

static new
vtkTemporalPathLineFilter 
New ()
 Standard Type-Macro.
static new int IsTypeOf (string type)
 Standard Type-Macro.
static new
vtkTemporalPathLineFilter 
SafeDownCast (vtkObjectBase o)
 Standard Type-Macro.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "25vtkTemporalPathLineFilter"
 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 vtkTemporalPathLineFilter_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTemporalPathLineFilter_Flush_01 (HandleRef pThis)
static internal IntPtr vtkTemporalPathLineFilter_GetIdChannelArray_02 (HandleRef pThis)
static internal int vtkTemporalPathLineFilter_GetKeepDeadTrails_03 (HandleRef pThis)
static internal int vtkTemporalPathLineFilter_GetMaskPoints_04 (HandleRef pThis)
static internal IntPtr vtkTemporalPathLineFilter_GetMaxStepDistance_05 (HandleRef pThis)
static internal void vtkTemporalPathLineFilter_GetMaxStepDistance_06 (HandleRef pThis, ref double _arg1, ref double _arg2, ref double _arg3)
static internal void vtkTemporalPathLineFilter_GetMaxStepDistance_07 (HandleRef pThis, IntPtr _arg)
static internal uint vtkTemporalPathLineFilter_GetMaxTrackLength_08 (HandleRef pThis)
static internal int vtkTemporalPathLineFilter_IsA_09 (HandleRef pThis, string type)
static internal int vtkTemporalPathLineFilter_IsTypeOf_10 (string type)
static internal IntPtr vtkTemporalPathLineFilter_NewInstance_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkTemporalPathLineFilter_SafeDownCast_13 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTemporalPathLineFilter_SetIdChannelArray_14 (HandleRef pThis, string _arg)
static internal void vtkTemporalPathLineFilter_SetKeepDeadTrails_15 (HandleRef pThis, int _arg)
static internal void vtkTemporalPathLineFilter_SetMaskPoints_16 (HandleRef pThis, int _arg)
static internal void vtkTemporalPathLineFilter_SetMaxStepDistance_17 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkTemporalPathLineFilter_SetMaxStepDistance_18 (HandleRef pThis, IntPtr _arg)
static internal void vtkTemporalPathLineFilter_SetMaxTrackLength_19 (HandleRef pThis, uint _arg)
static internal void vtkTemporalPathLineFilter_SetSelection_20 (HandleRef pThis, HandleRef input)
static internal void vtkTemporalPathLineFilter_SetSelectionConnection_21 (HandleRef pThis, HandleRef algOutput)

Static Private Member Functions

static vtkTemporalPathLineFilter ()
 Automatically generated type registration mechanics.

Detailed Description

vtkTemporalPathLineFilter - Generate a Polydata Pointset from any Dataset.

Description vtkTemporalPathLineFilter takes any dataset as input, it extracts the point locations of all cells over time to build up a polyline trail. The point number (index) is used as the 'key' if the points are randomly changing their respective order in the points list, then you should specify a scalar that represents the unique ID. This is intended to handle the output of a filter such as the TemporalStreamTracer.

Thanks John Bidiscombe of CSCS - Swiss National Supercomputing Centre for creating and contributing this class.

vtkTemporalStreamTracer


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Standard Type-Macro.


Member Function Documentation

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

Flush will wipe any existing data so that traces can be restarted from whatever time step is next supplied.

Specify the name of a scalar array which will be used to fetch the index of each point. This is necessary only if the particles change position (Id order) on each time step. The Id can be used to identify particles at each step and hence track them properly. If this array is NULL, the global point ids are used. If an Id array cannot otherwise be found, the point index is used as the ID.

When a particle 'disappears', the trail belonging to it is removed from the list. When this flag is enabled, dead trails will persist until the next time the list is cleared. Use carefully as it may cause excessive memory consumption if left on by mistake.

Set the number of particles to track as a ratio of the input example: setting MaskPoints to 10 will track every 10th point.

If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part kept).

virtual void Kitware.VTK.vtkTemporalPathLineFilter.GetMaxStepDistance ( ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [virtual]

If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part kept).

virtual void Kitware.VTK.vtkTemporalPathLineFilter.GetMaxStepDistance ( IntPtr  _arg) [virtual]

If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part kept).

If the Particles being traced animate for a long time, the trails or traces will become long and stringy. Setting the MaxTraceTimeLength will limit how much of the trace is displayed. Tracks longer then the Max will disappear and the trace will apppear like a snake of fixed length which progresses as the particle moves.

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

Standard Type-Macro.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

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

Standard Type-Macro.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Standard Type-Macro.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Standard Type-Macro.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Standard Type-Macro.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkTemporalPathLineFilter.SetIdChannelArray ( string  _arg) [virtual]

Specify the name of a scalar array which will be used to fetch the index of each point. This is necessary only if the particles change position (Id order) on each time step. The Id can be used to identify particles at each step and hence track them properly. If this array is NULL, the global point ids are used. If an Id array cannot otherwise be found, the point index is used as the ID.

virtual void Kitware.VTK.vtkTemporalPathLineFilter.SetKeepDeadTrails ( int  _arg) [virtual]

When a particle 'disappears', the trail belonging to it is removed from the list. When this flag is enabled, dead trails will persist until the next time the list is cleared. Use carefully as it may cause excessive memory consumption if left on by mistake.

virtual void Kitware.VTK.vtkTemporalPathLineFilter.SetMaskPoints ( int  _arg) [virtual]

Set the number of particles to track as a ratio of the input example: setting MaskPoints to 10 will track every 10th point.

virtual void Kitware.VTK.vtkTemporalPathLineFilter.SetMaxStepDistance ( double  _arg1,
double  _arg2,
double  _arg3 
) [virtual]

If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part kept).

virtual void Kitware.VTK.vtkTemporalPathLineFilter.SetMaxStepDistance ( IntPtr  _arg) [virtual]

If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part kept).

virtual void Kitware.VTK.vtkTemporalPathLineFilter.SetMaxTrackLength ( uint  _arg) [virtual]

If the Particles being traced animate for a long time, the trails or traces will become long and stringy. Setting the MaxTraceTimeLength will limit how much of the trace is displayed. Tracks longer then the Max will disappear and the trace will apppear like a snake of fixed length which progresses as the particle moves.

Set a second input which is a selection. Particles with the same Id in the selection as the primary input will be chosen for pathlines Note that you must have the same IdChannelArray in the selection as the input.

Set a second input which is a selection. Particles with the same Id in the selection as the primary input will be chosen for pathlines Note that you must have the same IdChannelArray in the selection as the input.

static internal void Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter_Flush_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter_GetIdChannelArray_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter_GetMaxStepDistance_06 ( HandleRef  pThis,
ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [private]
static internal void Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter_GetMaxStepDistance_07 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal int Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter_IsA_09 ( HandleRef  pThis,
string  type 
) [private]
static internal IntPtr Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter_NewInstance_12 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter_SafeDownCast_13 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter_SetIdChannelArray_14 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter_SetKeepDeadTrails_15 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter_SetMaskPoints_16 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter_SetMaxStepDistance_17 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter_SetMaxStepDistance_18 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter_SetMaxTrackLength_19 ( HandleRef  pThis,
uint  _arg 
) [private]
static internal void Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter_SetSelection_20 ( HandleRef  pThis,
HandleRef  input 
) [private]
static internal void Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter_SetSelectionConnection_21 ( HandleRef  pThis,
HandleRef  algOutput 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkTemporalPathLineFilter.MRClassNameKey = "25vtkTemporalPathLineFilter" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.


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