vtkSimple2DLayoutStrategy.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 vtkSimple2DLayoutStrategy_h
#define vtkSimple2DLayoutStrategy_h
 
#include "vtkGraphLayoutStrategy.h"
#include "vtkInfovisLayoutModule.h" // For export macro
 
VTK_ABI_NAMESPACE_BEGIN
class vtkFloatArray;
 
class VTKINFOVISLAYOUT_EXPORT vtkSimple2DLayoutStrategy : public vtkGraphLayoutStrategy
{
public:
  static vtkSimple2DLayoutStrategy* New();
 
  vtkTypeMacro(vtkSimple2DLayoutStrategy, vtkGraphLayoutStrategy);
  void PrintSelf(ostream& os, vtkIndent indent) override;


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


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


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


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


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


  vtkSetMacro(Jitter, bool);
  vtkGetMacro(Jitter, bool);


  vtkSetMacro(RestDistance, float);
  vtkGetMacro(RestDistance, float);

  void Initialize() override;

  void Layout() override;

  int IsLayoutComplete() override { return this->LayoutComplete; }
 
protected:
  vtkSimple2DLayoutStrategy();
  ~vtkSimple2DLayoutStrategy() override;
 
  int MaxNumberOfIterations; // Maximum number of iterations.
  float InitialTemperature;
  float CoolDownRate; // Cool-down rate.  Note:  Higher # = Slower rate.
 
private:
  // An edge consists of two vertices joined together.
  // This struct acts as a "pointer" to those two vertices.
  struct vtkLayoutEdge_t
  {
    vtkIdType from;
    vtkIdType to;
    float weight;
  };
  using vtkLayoutEdge = struct vtkLayoutEdge_t;
 
  // These are for storage of repulsion and attraction
  vtkFloatArray* RepulsionArray;
  vtkFloatArray* AttractionArray;
  vtkLayoutEdge* EdgeArray;
 
  int RandomSeed;
  int IterationsPerLayout;
  int TotalIterations;
  int LayoutComplete;
  float Temp;
  float RestDistance;
  bool Jitter;
 
  vtkSimple2DLayoutStrategy(const vtkSimple2DLayoutStrategy&) = delete;
  void operator=(const vtkSimple2DLayoutStrategy&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif