VTK
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 -------------------------------------------------------------------------*/
37 #ifndef __vtkAreaLayoutStrategy_h
38 #define __vtkAreaLayoutStrategy_h
39 
40 
41 #include "vtkObject.h"
42 
43 class vtkTree;
44 class vtkDataArray;
45 
47 {
48 public:
50  void PrintSelf(ostream& os, vtkIndent indent);
51 
53 
58  virtual void Layout(vtkTree *inputTree, vtkDataArray *areaArray,
59  vtkDataArray* sizeArray) = 0;
61 
62  // Modify edgeLayoutTree to have point locations appropriate
63  // for routing edges on a graph overlaid on the tree.
64  // Layout() is called before this method, so inputTree will contain the
65  // layout locations.
66  // If you do not override this method,
67  // the edgeLayoutTree vertex locations are the same as the input tree.
68  virtual void LayoutEdgePoints(vtkTree *inputTree, vtkDataArray *areaArray,
69  vtkDataArray* sizeArray, vtkTree *edgeLayoutTree);
70 
72  virtual vtkIdType FindVertex(vtkTree* tree, vtkDataArray* array, float pnt[2]) = 0;
73 
74  // Descripiton:
75  // The amount that the regions are shrunk as a value from
76  // 0.0 (full size) to 1.0 (shrink to nothing).
77  vtkSetClampMacro(ShrinkPercentage, double, 0.0, 1.0);
78  vtkGetMacro(ShrinkPercentage, double);
79 
80 protected:
83 
85 
86 private:
87  vtkAreaLayoutStrategy(const vtkAreaLayoutStrategy&); // Not implemented.
88  void operator=(const vtkAreaLayoutStrategy&); // Not implemented.
89 };
90 
91 #endif
92 
abstract base class for most VTK objects
Definition: vtkObject.h:60
abstract superclass for all area layout strategies
int vtkIdType
Definition: vtkType.h:255
virtual void PrintSelf(ostream &os, vtkIndent indent)
a simple class to control print indentation
Definition: vtkIndent.h:37
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:53
#define VTK_INFOVIS_EXPORT
A rooted tree data structure.
Definition: vtkTree.h:58