vtkClustering2DLayoutStrategy.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 vtkClustering2DLayoutStrategy_h
#define vtkClustering2DLayoutStrategy_h
 
#include "vtkGraphLayoutStrategy.h"
#include "vtkInfovisLayoutModule.h" // For export macro
 
#include "vtkSmartPointer.h" // Required for smart pointer internal ivars.
 
VTK_ABI_NAMESPACE_BEGIN
class vtkFastSplatter;
class vtkImageData;
class vtkIntArray;
class vtkFloatArray;
 
class VTKINFOVISLAYOUT_EXPORT vtkClustering2DLayoutStrategy : public vtkGraphLayoutStrategy
{
public:
  static vtkClustering2DLayoutStrategy* New();
 
  vtkTypeMacro(vtkClustering2DLayoutStrategy, 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(RestDistance, float);
  vtkGetMacro(RestDistance, float);
 
  void Initialize() override;
 
  void Layout() override;
 
  int IsLayoutComplete() override { return this->LayoutComplete; }
 
protected:
  vtkClustering2DLayoutStrategy();
  ~vtkClustering2DLayoutStrategy() 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;
    int dead_edge; // I'm making this an int so that the edge array is
                   // word boundary aligned... but I'm not sure what
                   // really happens in these days of magical compilers
  };
  using vtkLayoutEdge = struct vtkLayoutEdge_t;
 
  // This class 'has a' vtkFastSplatter for the density grid
  vtkSmartPointer<vtkFastSplatter> DensityGrid;
  vtkSmartPointer<vtkImageData> SplatImage;
  vtkSmartPointer<vtkFloatArray> RepulsionArray;
  vtkSmartPointer<vtkFloatArray> AttractionArray;
  vtkSmartPointer<vtkIntArray> EdgeCountArray;
 
  vtkLayoutEdge* EdgeArray;
 
  int RandomSeed;
  int IterationsPerLayout;
  int TotalIterations;
  int LayoutComplete;
  float Temp;
  float RestDistance;
  float CuttingThreshold;
 
  // Private helper methods
  void GenerateCircularSplat(vtkImageData* splat, int x, int y);
  void GenerateGaussianSplat(vtkImageData* splat, int x, int y);
  void ResolveCoincidentVertices();
 
  vtkClustering2DLayoutStrategy(const vtkClustering2DLayoutStrategy&) = delete;
  void operator=(const vtkClustering2DLayoutStrategy&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif