vtkDijkstraGraphGeodesicPath.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkDijkstraGraphGeodesicPath.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkDijkstraGraphGeodesicPath_h
#define vtkDijkstraGraphGeodesicPath_h
 
#include "vtkFiltersModelingModule.h" // For export macro
#include "vtkGraphGeodesicPath.h"
 
class vtkDijkstraGraphInternals;
class vtkIdList;
 
class VTKFILTERSMODELING_EXPORT vtkDijkstraGraphGeodesicPath : public vtkGraphGeodesicPath
{
public:
  static vtkDijkstraGraphGeodesicPath* New();
 
 
  vtkTypeMacro(vtkDijkstraGraphGeodesicPath, vtkGraphGeodesicPath);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  vtkGetObjectMacro(IdList, vtkIdList);
 
 
  vtkSetMacro(StopWhenEndReached, vtkTypeBool);
  vtkGetMacro(StopWhenEndReached, vtkTypeBool);
  vtkBooleanMacro(StopWhenEndReached, vtkTypeBool);
 
 
  vtkSetMacro(UseScalarWeights, vtkTypeBool);
  vtkGetMacro(UseScalarWeights, vtkTypeBool);
  vtkBooleanMacro(UseScalarWeights, vtkTypeBool);
 
 
  vtkSetMacro(RepelPathFromVertices, vtkTypeBool);
  vtkGetMacro(RepelPathFromVertices, vtkTypeBool);
  vtkBooleanMacro(RepelPathFromVertices, vtkTypeBool);
 
 
  virtual void SetRepelVertices(vtkPoints*);
  vtkGetObjectMacro(RepelVertices, vtkPoints);
 
  virtual void GetCumulativeWeights(vtkDoubleArray* weights);
 
protected:
  vtkDijkstraGraphGeodesicPath();
  ~vtkDijkstraGraphGeodesicPath() override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  // Build a graph description of the input.
  virtual void BuildAdjacency(vtkDataSet* inData);
 
  vtkTimeStamp AdjacencyBuildTime;
 
  // The fixed cost going from vertex u to v.
  virtual double CalculateStaticEdgeCost(vtkDataSet* inData, vtkIdType u, vtkIdType v);
 
  // The cost going from vertex u to v that may depend on one or more vertices
  // that precede u.
  virtual double CalculateDynamicEdgeCost(vtkDataSet*, vtkIdType, vtkIdType) { return 0.0; }
 
  void Initialize(vtkDataSet* inData);
 
  void Reset();
 
  // Calculate shortest path from vertex startv to vertex endv.
  virtual void ShortestPath(vtkDataSet* inData, int startv, int endv);
 
  // Relax edge u,v with weight w.
  void Relax(const int& u, const int& v, const double& w);
 
  // Backtrace the shortest path
  void TraceShortestPath(
    vtkDataSet* inData, vtkPolyData* outPoly, vtkIdType startv, vtkIdType endv);
 
  // The number of vertices.
  int NumberOfVertices;
 
  // The vertex ids on the shortest path.
  vtkIdList* IdList;
 
  // Internalized STL containers.
  vtkDijkstraGraphInternals* Internals;
 
  vtkTypeBool StopWhenEndReached;
  vtkTypeBool UseScalarWeights;
  vtkTypeBool RepelPathFromVertices;
 
  vtkPoints* RepelVertices;
 
private:
  vtkDijkstraGraphGeodesicPath(const vtkDijkstraGraphGeodesicPath&) = delete;
  void operator=(const vtkDijkstraGraphGeodesicPath&) = delete;
};
 
#endif