vtkAreaLayoutStrategy.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 vtkAreaLayoutStrategy_h
#define vtkAreaLayoutStrategy_h
 
#include "vtkInfovisLayoutModule.h" // For export macro
#include "vtkObject.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkTree;
class vtkDataArray;
 
class VTKINFOVISLAYOUT_EXPORT vtkAreaLayoutStrategy : public vtkObject
{
public:
  vtkTypeMacro(vtkAreaLayoutStrategy, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  virtual void Layout(vtkTree* inputTree, vtkDataArray* areaArray, vtkDataArray* sizeArray) = 0;
 
  // Modify edgeRoutingTree to have point locations appropriate
  // for routing edges on a graph overlaid on the tree.
  // Layout() is called before this method, so inputTree will contain the
  // layout locations.
  // If you do not override this method,
  // the edgeRoutingTree vertex locations are the same as the input tree.
  virtual void LayoutEdgePoints(
    vtkTree* inputTree, vtkDataArray* areaArray, vtkDataArray* sizeArray, vtkTree* edgeRoutingTree);
 
  virtual vtkIdType FindVertex(vtkTree* tree, vtkDataArray* array, float pnt[2]) = 0;
 
  // Description:
  // The amount that the regions are shrunk as a value from
  // 0.0 (full size) to 1.0 (shrink to nothing).
  vtkSetClampMacro(ShrinkPercentage, double, 0.0, 1.0);
  vtkGetMacro(ShrinkPercentage, double);
 
protected:
  vtkAreaLayoutStrategy();
  ~vtkAreaLayoutStrategy() override;
 
  double ShrinkPercentage;
 
private:
  vtkAreaLayoutStrategy(const vtkAreaLayoutStrategy&) = delete;
  void operator=(const vtkAreaLayoutStrategy&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif