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.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.
- Public Member Functions inherited from Kitware.VTK.vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkPolyDataAlgorithm ()
 *Undocumented Block
void AddInput (vtkDataObject arg0)
 Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
void AddInput (int arg0, vtkDataObject arg1)
 Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
vtkDataObject GetInput ()
 this method is not recommended for use, but lots of old style filters use it
vtkDataObject GetInput (int port)
 this method is not recommended for use, but lots of old style filters use it
vtkPolyData GetOutput ()
 Get the output data object for a port on this algorithm.
vtkPolyData GetOutput (int arg0)
 Get the output data object for a port on this algorithm.
vtkPolyData GetPolyDataInput (int port)
 this method is not recommended for use, but lots of old style filters use it
void SetInput (vtkDataObject arg0)
 Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
void SetInput (int arg0, vtkDataObject arg1)
 Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
virtual void SetOutput (vtkDataObject d)
 Get the output data object for a port on this algorithm.
- Public Member Functions inherited from Kitware.VTK.vtkAlgorithm
 vtkAlgorithm (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkAlgorithm ()
 *Undocumented Block
override void Register (vtkObjectBase o)
 Participate in garbage collection.
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void AddInputConnection (int port, vtkAlgorithmOutput input)
 Add a connection to the given input port index. See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is.
virtual void AddInputConnection (vtkAlgorithmOutput input)
 Add a connection to the given input port index. See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is.
virtual double ComputePriority ()
 Returns the priority of the piece described by the current update extent. The priority is a number between 0.0 and 1.0 with 0 meaning skippable (REQUEST_DATA not needed) and 1.0 meaning important.
void ConvertTotalInputToPortConnection (int ind, ref int port, ref int conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual int GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual uint GetErrorCode ()
 The error code contains a possible error that occured while reading or writing the file.
vtkExecutive GetExecutive ()
 Get this algorithm's executive. If it has none, a default executive will be created.
virtual vtkInformation GetInformation ()
 Set/Get the information object associated with this algorithm.
vtkInformation GetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
vtkAlgorithmOutput GetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
vtkDataObject GetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
vtkInformation GetInputPortInformation (int port)
 Get the information object associated with an input port. There is one input port per kind of input to the algorithm. Each input port tells executives what kind of data and downstream requests this algorithm can handle for that input.
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port.
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm.
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm.
vtkDataObject GetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
vtkAlgorithmOutput GetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.
vtkAlgorithmOutput GetOutputPort ()
 Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.
vtkInformation GetOutputPortInformation (int port)
 Get the information object associated with an output port. There is one output port per output from the algorithm. Each output port tells executives what kind of upstream requests this algorithm can handle for that output.
virtual double GetProgress ()
 Set/Get the execution progress of a process object.
virtual double GetProgressMaxValue ()
 Set/Get the execution progress of a process object.
virtual double GetProgressMinValue ()
 Set/Get the execution progress of a process object.
virtual string GetProgressText ()
 Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
int HasExecutive ()
 Check whether this algorithm has an assigned executive. This will NOT create a default executive.
virtual int ModifyRequest (vtkInformation request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. The default implementation is empty. Returns 1 on success, 0 on failure. When can be either vtkExecutive::BeforeForward or vtkExecutive::AfterForward.
int ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector outInfo)
 Version of ProcessRequest() that is wrapped. This converts the collection to an array and calls the other version.
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports.
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports.
void RemoveAllInputs ()
 Remove all the input data.
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput input)
 Remove a connection from the given input port index. See SetInputConnection() for details on input connection. This method is the complement to AddInputConnection() in that it removes only the connection specified without affecting other connections. Typical usage is.
virtual void SetAbortExecute (int _arg)
 Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void SetExecutive (vtkExecutive executive)
 Set this algorithm's executive. This algorithm is removed from any executive to which it has previously been assigned and then assigned to the given executive.
virtual void SetInformation (vtkInformation arg0)
 Set/Get the information object associated with this algorithm.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, string name)
 Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void SetInputArrayToProcess (int idx, vtkInformation info)
 Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void SetInputArrayToProcess (int idx, int port, int connection, string fieldAssociation, string attributeTypeorName)
 String based versions of SetInputArrayToProcess(). Because fieldAssociation and fieldAttributeType are enums, they cannot be easily accessed from scripting language. These methods provides an easy and safe way of passing association and attribute type information. Field association is one of the following:
virtual void SetInputConnection (int port, vtkAlgorithmOutput input)
 Set the connection for the given input port index. Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().
virtual void SetInputConnection (vtkAlgorithmOutput input)
 Set the connection for the given input port index. Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().
virtual void SetProgress (double _arg)
 Set/Get the execution progress of a process object.
void SetProgressText (string ptext)
 Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().
virtual void SetReleaseDataFlag (int arg0)
 Turn release data flag on or off for all output ports.
virtual void Update ()
 Bring this algorithm's outputs up-to-date.
int UpdateExtentIsEmpty (vtkDataObject output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. The source uses this call to determine whether to call Execute.
int UpdateExtentIsEmpty (vtkInformation pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. The source uses this call to determine whether to call Execute.
virtual void UpdateInformation ()
 Backward compatibility method to invoke UpdateInformation on executive.
void UpdateProgress (double amount)
 Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
- 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 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
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.
- Public Attributes inherited from Kitware.VTK.vtkPolyDataAlgorithm
- Public Attributes inherited from Kitware.VTK.vtkAlgorithm
- 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 = "25vtkTemporalPathLineFilter"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkPolyDataAlgorithm
- Static Public Attributes inherited from Kitware.VTK.vtkAlgorithm
- 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 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

static Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter ( )
staticprivate

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.

Kitware.VTK.vtkTemporalPathLineFilter.vtkTemporalPathLineFilter ( )

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.

void Kitware.VTK.vtkTemporalPathLineFilter.Flush ( )

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

virtual string Kitware.VTK.vtkTemporalPathLineFilter.GetIdChannelArray ( )
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 int Kitware.VTK.vtkTemporalPathLineFilter.GetKeepDeadTrails ( )
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 int Kitware.VTK.vtkTemporalPathLineFilter.GetMaskPoints ( )
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 double [] Kitware.VTK.vtkTemporalPathLineFilter.GetMaxStepDistance ( )
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 ( 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).

virtual uint Kitware.VTK.vtkTemporalPathLineFilter.GetMaxTrackLength ( )
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.

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.

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

Standard Type-Macro.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

new vtkTemporalPathLineFilter Kitware.VTK.vtkTemporalPathLineFilter.NewInstance ( )

Standard Type-Macro.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

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

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.

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


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: