vtkForceDirectedLayoutStrategy.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
 
#ifndef vtkForceDirectedLayoutStrategy_h
#define vtkForceDirectedLayoutStrategy_h
 
#include "vtkGraphLayoutStrategy.h"
#include "vtkInfovisLayoutModule.h" // For export macro
 
VTK_ABI_NAMESPACE_BEGIN
class VTKINFOVISLAYOUT_EXPORT vtkForceDirectedLayoutStrategy : public vtkGraphLayoutStrategy
{
public:
  static vtkForceDirectedLayoutStrategy* New();
 
  vtkTypeMacro(vtkForceDirectedLayoutStrategy, vtkGraphLayoutStrategy);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetClampMacro(RandomSeed, int, 0, VTK_INT_MAX);
  vtkGetMacro(RandomSeed, int);


  vtkSetVector6Macro(GraphBounds, double);
  vtkGetVectorMacro(GraphBounds, double, 6);


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


  vtkSetClampMacro(MaxNumberOfIterations, int, 0, VTK_INT_MAX);
  vtkGetMacro(MaxNumberOfIterations, int);


  vtkSetClampMacro(IterationsPerLayout, int, 0, VTK_INT_MAX);
  vtkGetMacro(IterationsPerLayout, int);


  vtkSetClampMacro(CoolDownRate, double, 0.01, VTK_DOUBLE_MAX);
  vtkGetMacro(CoolDownRate, double);


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


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


  vtkSetClampMacro(InitialTemperature, float, 0.0, VTK_FLOAT_MAX);
  vtkGetMacro(InitialTemperature, float);

  void Initialize() override;

  void Layout() override;

  int IsLayoutComplete() override { return this->LayoutComplete; }
 
protected:
  vtkForceDirectedLayoutStrategy();
  ~vtkForceDirectedLayoutStrategy() override;
 
  double GraphBounds[6];
  vtkTypeBool AutomaticBoundsComputation; // Boolean controls automatic bounds calc.
  int MaxNumberOfIterations;              // Maximum number of iterations.
  double CoolDownRate;                    // Cool-down rate.  Note:  Higher # = Slower rate.
  double InitialTemperature;
  vtkTypeBool ThreeDimensionalLayout; // Boolean for a third dimension.
  vtkTypeBool RandomInitialPoints;    // Boolean for having random points
private:
  // A vertex contains a position and a displacement.
  struct vtkLayoutVertex_t
  {
    double x[3];
    double d[3];
  };
  using vtkLayoutVertex = struct vtkLayoutVertex_t;
 
  // An edge consists of two vertices joined together.
  // This struct acts as a "pointer" to those two vertices.
  struct vtkLayoutEdge_t
  {
    int t;
    int u;
  };
  using vtkLayoutEdge = struct vtkLayoutEdge_t;
 
  int RandomSeed;
  int IterationsPerLayout;
  int TotalIterations;
  int LayoutComplete;
  double Temp;
  double optDist;
  vtkLayoutVertex* v;
  vtkLayoutEdge* e;
 
  vtkForceDirectedLayoutStrategy(const vtkForceDirectedLayoutStrategy&) = delete;
  void operator=(const vtkForceDirectedLayoutStrategy&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif