vtkTemporalPathLineFilter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkTemporalPathLineFilter_h
#define vtkTemporalPathLineFilter_h

#include "vtkFiltersGeneralModule.h" // For export macro
#include "vtkPolyDataAlgorithm.h"
#include "vtkTemporalAlgorithm.h" // For temporal algorithm

#ifndef __VTK_WRAP__
#define vtkPolyDataAlgorithm vtkTemporalAlgorithm<vtkPolyDataAlgorithm>
#endif

VTK_ABI_NAMESPACE_BEGIN
class vtkPoints;
class vtkCellArray;
class vtkMergePoints;
class vtkFloatArray;

VTK_ABI_NAMESPACE_END
#include "vtkSmartPointer.h" // for memory safety
#include <set>               // Because we want to use it
VTK_ABI_NAMESPACE_BEGIN
class ParticleTrail;
class vtkTemporalPathLineFilterInternals;
typedef vtkSmartPointer<ParticleTrail> TrailPointer;

// Excluded from JavaScript wrapping because it defines vtkPolyDataAlgorithm as
// vtkTemporalAlgorithm<vtkPolyDataAlgorithm> which confuses other filters in VTK::FiltersCore
class VTKFILTERSGENERAL_EXPORT VTK_WRAPEXCLUDE_JAVASCRIPT vtkTemporalPathLineFilter
  : public vtkPolyDataAlgorithm
{
public:

  vtkTypeMacro(vtkTemporalPathLineFilter, vtkPolyDataAlgorithm);
#ifndef __VTK_WRAP__
#undef vtkPassInputTypeAlgorithm
#endif
  static vtkTemporalPathLineFilter* New();
  void PrintSelf(ostream& os, vtkIndent indent) override;

#if defined(__VTK_WRAP__) || defined(__WRAP_GCCXML)
  vtkCreateWrappedTemporalAlgorithmInterface();
#endif


  vtkSetMacro(MaskPoints, int);
  vtkGetMacro(MaskPoints, int);


  vtkSetMacro(MaxTrackLength, unsigned int);
  vtkGetMacro(MaxTrackLength, unsigned int);


  vtkSetStringMacro(IdChannelArray);
  vtkGetStringMacro(IdChannelArray);


  vtkSetVector3Macro(MaxStepDistance, double);
  vtkGetVector3Macro(MaxStepDistance, double);


  vtkSetMacro(KeepDeadTrails, bool);
  vtkGetMacro(KeepDeadTrails, bool);

  void Flush();

  void SetSelectionConnection(vtkAlgorithmOutput* algOutput);

  void SetSelectionData(vtkDataSet* input);

protected:
  vtkTemporalPathLineFilter();
  ~vtkTemporalPathLineFilter() override;

  //
  // Make sure the pipeline knows what type we expect as input
  //
  int FillInputPortInformation(int port, vtkInformation* info) override;
  int FillOutputPortInformation(int port, vtkInformation* info) override;

  int Initialize(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int Execute(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int Finalize(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  void IncrementTrail(TrailPointer trail, vtkDataSet* input, vtkIdType i);

  TrailPointer GetTrail(vtkIdType i);

  // void Initialize(vtkDataSet* input, vtkDataSet* selection,
  //  vtkPolyData* pathLines, vtkPolyData* particles);

  // internal data variables
  int NumberOfTimeSteps = 0;
  int MaskPoints = 200;
  unsigned int MaxTrackLength = 10;
  unsigned int LastTrackLength = 10;
  char* IdChannelArray = nullptr;
  double MaxStepDistance[3] = { 1, 1, 1 };
  double LatestTime;
  bool KeepDeadTrails = false;
  bool BackwardTime = false;
  //

  vtkSmartPointer<vtkCellArray> PolyLines;
  vtkSmartPointer<vtkCellArray> Vertices;
  vtkSmartPointer<vtkPoints> LineCoordinates;
  vtkSmartPointer<vtkPoints> VertexCoordinates;
  vtkSmartPointer<vtkFloatArray> TrailId;
  vtkSmartPointer<vtkTemporalPathLineFilterInternals> Internals;

  void AccumulateTrails(vtkDataSet* input, vtkDataSet* selection);
  void ClearTrailMarks();
  void ProcessTrails(vtkDataSet* input, vtkDataSet* selection);
  void RemoveDeadTrails();
  void PostExecute(vtkDataSet* input, vtkPolyData* pathLines, vtkPolyData* particles);
  void InitializeExecute(vtkDataSet* input, vtkPolyData* pathLines);

  //
private:
  vtkTemporalPathLineFilter(const vtkTemporalPathLineFilter&) = delete;
  void operator=(const vtkTemporalPathLineFilter&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif