VTK  9.0.2
vtkAreaLayoutStrategy.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAreaLayoutStrategy.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 /*-------------------------------------------------------------------------
16  Copyright 2008 Sandia Corporation.
17  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18  the U.S. Government retains certain rights in this software.
19 -------------------------------------------------------------------------*/
38 #ifndef vtkAreaLayoutStrategy_h
39 #define vtkAreaLayoutStrategy_h
40 
41 #include "vtkInfovisLayoutModule.h" // For export macro
42 #include "vtkObject.h"
43 
44 class vtkTree;
45 class vtkDataArray;
46 
47 class VTKINFOVISLAYOUT_EXPORT vtkAreaLayoutStrategy : public vtkObject
48 {
49 public:
51  void PrintSelf(ostream& os, vtkIndent indent) override;
52 
64  virtual void Layout(vtkTree* inputTree, vtkDataArray* areaArray, vtkDataArray* sizeArray) = 0;
65 
66  // Modify edgeLayoutTree to have point locations appropriate
67  // for routing edges on a graph overlaid on the tree.
68  // Layout() is called before this method, so inputTree will contain the
69  // layout locations.
70  // If you do not override this method,
71  // the edgeLayoutTree vertex locations are the same as the input tree.
72  virtual void LayoutEdgePoints(
73  vtkTree* inputTree, vtkDataArray* areaArray, vtkDataArray* sizeArray, vtkTree* edgeLayoutTree);
74 
78  virtual vtkIdType FindVertex(vtkTree* tree, vtkDataArray* array, float pnt[2]) = 0;
79 
80  // Descripiton:
81  // The amount that the regions are shrunk as a value from
82  // 0.0 (full size) to 1.0 (shrink to nothing).
83  vtkSetClampMacro(ShrinkPercentage, double, 0.0, 1.0);
84  vtkGetMacro(ShrinkPercentage, double);
85 
86 protected:
89 
91 
92 private:
94  void operator=(const vtkAreaLayoutStrategy&) = delete;
95 };
96 
97 #endif
abstract superclass for all area layout strategies
virtual void LayoutEdgePoints(vtkTree *inputTree, vtkDataArray *areaArray, vtkDataArray *sizeArray, vtkTree *edgeLayoutTree)
virtual vtkIdType FindVertex(vtkTree *tree, vtkDataArray *array, float pnt[2])=0
Returns the vertex id that contains pnt (or -1 if no one contains it)
virtual void Layout(vtkTree *inputTree, vtkDataArray *areaArray, vtkDataArray *sizeArray)=0
Perform the layout of the input tree, and store the sector bounds of each vertex as a tuple in a data...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
~vtkAreaLayoutStrategy() override
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract base class for most VTK objects
Definition: vtkObject.h:63
A rooted tree data structure.
Definition: vtkTree.h:55
int vtkIdType
Definition: vtkType.h:338