forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkAreaLayoutStrategy.h
100 lines (81 loc) · 3.4 KB
/
vtkAreaLayoutStrategy.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/*=========================================================================
Program: Visualization Toolkit
Module: vtkAreaLayoutStrategy.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/*-------------------------------------------------------------------------
Copyright 2008 Sandia Corporation.
Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
/**
* @class vtkAreaLayoutStrategy
* @brief abstract superclass for all area layout strategies
*
*
* All subclasses of this class perform a area layout on a tree.
* This involves assigning a region to each vertex in the tree,
* and placing that information in a data array with four components per
* tuple representing (innerRadius, outerRadius, startAngle, endAngle).
*
* Instances of subclasses of this class may be assigned as the layout
* strategy to vtkAreaLayout
*
* @par Thanks:
* Thanks to Jason Shepherd from Sandia National Laboratories
* for help developing this class.
*/
#ifndef vtkAreaLayoutStrategy_h
#define vtkAreaLayoutStrategy_h
#include "vtkInfovisLayoutModule.h" // For export macro
#include "vtkObject.h"
class vtkTree;
class vtkDataArray;
class VTKINFOVISLAYOUT_EXPORT vtkAreaLayoutStrategy : public vtkObject
{
public:
vtkTypeMacro(vtkAreaLayoutStrategy,vtkObject);
void PrintSelf(ostream& os, vtkIndent indent);
/**
* Perform the layout of the input tree, and store the sector
* bounds of each vertex as a tuple in a data array.
* For radial layout, this is
* (innerRadius, outerRadius, startAngle, endAngle).
* For rectangular layout, this is
* (xmin, xmax, ymin, ymax).
* The sizeArray may be NULL, or may contain the desired
* size of each vertex in the tree.
*/
virtual void Layout(vtkTree *inputTree, vtkDataArray *areaArray,
vtkDataArray* sizeArray) = 0;
// Modify edgeLayoutTree 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 edgeLayoutTree vertex locations are the same as the input tree.
virtual void LayoutEdgePoints(vtkTree *inputTree, vtkDataArray *areaArray,
vtkDataArray* sizeArray, vtkTree *edgeLayoutTree);
/**
* Returns the vertex id that contains pnt (or -1 if no one contains it)
*/
virtual vtkIdType FindVertex(vtkTree* tree, vtkDataArray* array, float pnt[2]) = 0;
// Descripiton:
// 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();
double ShrinkPercentage;
private:
vtkAreaLayoutStrategy(const vtkAreaLayoutStrategy&) VTK_DELETE_FUNCTION;
void operator=(const vtkAreaLayoutStrategy&) VTK_DELETE_FUNCTION;
};
#endif