vtkGraphGeodesicPath.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 vtkGraphGeodesicPath_h
#define vtkGraphGeodesicPath_h
 
#include "vtkFiltersModelingModule.h" // For export macro
#include "vtkGeodesicPath.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDijkstraGraphInternals;
class vtkIdList;
 
class VTKFILTERSMODELING_EXPORT vtkGraphGeodesicPath : public vtkGeodesicPath
{
public:

  vtkTypeMacro(vtkGraphGeodesicPath, vtkGeodesicPath);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void GetCumulativeWeights(vtkDoubleArray* weights);

  vtkGetObjectMacro(IdList, vtkIdList);


  vtkSetMacro(StopWhenEndReached, vtkTypeBool);
  vtkGetMacro(StopWhenEndReached, vtkTypeBool);
  vtkBooleanMacro(StopWhenEndReached, vtkTypeBool);


  vtkGetMacro(StartVertex, vtkIdType);
  vtkSetMacro(StartVertex, vtkIdType);


  vtkGetMacro(EndVertex, vtkIdType);
  vtkSetMacro(EndVertex, vtkIdType);


  void SetUseScalarWeights(vtkTypeBool);
  vtkGetMacro(UseScalarWeights, vtkTypeBool);
  vtkBooleanMacro(UseScalarWeights, vtkTypeBool);


  vtkSetMacro(RepelPathFromVertices, vtkTypeBool);
  vtkGetMacro(RepelPathFromVertices, vtkTypeBool);
  vtkBooleanMacro(RepelPathFromVertices, vtkTypeBool);


  void SetRepelVertices(vtkPoints*);
  vtkGetObjectMacro(RepelVertices, vtkPoints);


  void SetProcessedFieldArrayName(const std::string& name);
  vtkGetMacro(ProcessedFieldArrayName, const std::string&);
 
protected:
  vtkGraphGeodesicPath();
  ~vtkGraphGeodesicPath() override;

  virtual void GetNodeFromIndex(vtkDataSet* inData, vtkIdType u, double pt[3]);

  virtual vtkIdType GetNumberOfNodes(vtkDataSet* inData);

  virtual void DiscardRepelVertices(vtkDataSet* inData, int startv, int endv);

  virtual void BuildAdjacency(vtkDataSet* inData) = 0;

  virtual double CalculateStaticEdgeCost(vtkDataSet* inData, vtkIdType u, vtkIdType v) = 0;

  virtual double CalculateDynamicEdgeCost(vtkDataSet*, vtkIdType, vtkIdType) { return 0.0; }

  virtual void ShortestPath(vtkDataSet* inData, int startv, int endv);

  void Initialize(vtkDataSet* inData);

  void Reset();

  void Relax(int u, int v, double w);

  void TraceShortestPath(
    vtkDataSet* inData, vtkPolyData* outPoly, vtkIdType startv, vtkIdType endv);
 
  vtkTimeStamp AdjacencyBuildTime;
  vtkTimeStamp AdjacencyParametersTime;
 
  int NumberOfVertices = 0;
 
  // The vertex ids on the shortest path.
  vtkIdList* IdList;
 
  // Internalized STL containers.
  std::unique_ptr<vtkDijkstraGraphInternals> Internals;
 
  vtkTypeBool StopWhenEndReached = 0;
  vtkTypeBool UseScalarWeights = 0;
  vtkTypeBool RepelPathFromVertices = 0;
 
  vtkPoints* RepelVertices = nullptr;
 
  std::string ProcessedFieldArrayName;
 
  vtkIdType StartVertex = 0;
  vtkIdType EndVertex = 0;
 
private:
  vtkGraphGeodesicPath(const vtkGraphGeodesicPath&) = delete;
  void operator=(const vtkGraphGeodesicPath&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif