VTK  9.1.20220525
vtkTreeAreaView.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkTreeAreaView.h
5 
6  -------------------------------------------------------------------------
7  Copyright 2008 Sandia Corporation.
8  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9  the U.S. Government retains certain rights in this software.
10  -------------------------------------------------------------------------
11 
12  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
13  All rights reserved.
14  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
15 
16  This software is distributed WITHOUT ANY WARRANTY; without even
17  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
18  PURPOSE. See the above copyright notice for more information.
19 
20 =========================================================================*/
21 
40 #ifndef vtkTreeAreaView_h
41 #define vtkTreeAreaView_h
42 
43 #include "vtkRenderView.h"
44 #include "vtkViewsInfovisModule.h" // For export macro
45 
47 class vtkGraph;
51 class vtkTree;
52 
53 class VTKVIEWSINFOVIS_EXPORT vtkTreeAreaView : public vtkRenderView
54 {
55 public:
56  static vtkTreeAreaView* New();
58  void PrintSelf(ostream& os, vtkIndent indent) override;
59 
61 
69 
71 
74  void SetAreaLabelArrayName(const char* name);
75  const char* GetAreaLabelArrayName();
77 
79 
82  void SetAreaSizeArrayName(const char* name);
83  const char* GetAreaSizeArrayName();
85 
87 
91  void SetLabelPriorityArrayName(const char* name);
94 
96 
99  void SetEdgeLabelArrayName(const char* name);
100  const char* GetEdgeLabelArrayName();
102 
104 
109  void SetAreaHoverArrayName(const char* name);
110  const char* GetAreaHoverArrayName();
112 
114 
117  void SetAreaLabelVisibility(bool vis);
119  vtkBooleanMacro(AreaLabelVisibility, bool);
121 
123 
126  void SetEdgeLabelVisibility(bool vis);
128  vtkBooleanMacro(EdgeLabelVisibility, bool);
130 
132 
135  void SetAreaColorArrayName(const char* name);
136  const char* GetAreaColorArrayName();
138 
140 
143  void SetColorAreas(bool vis);
145  vtkBooleanMacro(ColorAreas, bool);
147 
149 
152  void SetEdgeColorArrayName(const char* name);
153  const char* GetEdgeColorArrayName();
155 
160 
162 
168 
170 
173  void SetColorEdges(bool vis);
175  vtkBooleanMacro(ColorEdges, bool);
177 
179 
182  void SetBundlingStrength(double strength);
185 
187 
190  virtual void SetAreaLabelFontSize(const int size);
191  virtual int GetAreaLabelFontSize();
193 
195 
198  virtual void SetEdgeLabelFontSize(const int size);
199  virtual int GetEdgeLabelFontSize();
201 
203 
206  virtual void SetLayoutStrategy(vtkAreaLayoutStrategy* strategy);
209 
211 
214  virtual void SetUseRectangularCoordinates(bool rect);
216  vtkBooleanMacro(UseRectangularCoordinates, bool);
218 
220 
223  virtual void SetEdgeScalarBarVisibility(bool b);
226 
227 protected:
229  ~vtkTreeAreaView() override;
230 
232 
237  virtual void SetAreaToPolyData(vtkPolyDataAlgorithm* areaToPoly);
240 
242 
249 
251 
258 
259 private:
260  vtkTreeAreaView(const vtkTreeAreaView&) = delete;
261  void operator=(const vtkTreeAreaView&) = delete;
262 };
263 
264 #endif
Proxy object to connect input/output ports.
abstract superclass for all area layout strategies
The superclass for all representations.
Base class for graph data types.
Definition: vtkGraph.h:345
a simple class to control print indentation
Definition: vtkIndent.h:119
draw text labels at dataset points
Superclass for algorithms that produce only polydata as output.
A view containing a renderer.
Definition: vtkRenderView.h:84
Accepts a graph and a hierarchy - currently a tree - and provides a hierarchy-aware display.
virtual vtkRenderedTreeAreaRepresentation * GetTreeAreaRepresentation()
Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.
bool GetEdgeLabelVisibility()
Whether to show edge labels.
const char * GetAreaColorArrayName()
The array to use for coloring vertices.
virtual void SetEdgeScalarBarVisibility(bool b)
Visibility of scalar bar actor for edges.
double GetBundlingStrength()
Set the bundling strength.
void SetColorEdges(bool vis)
Whether to color edges.
virtual vtkLabeledDataMapper * GetAreaLabelMapper()
The mapper for rendering labels on areas.
vtkDataRepresentation * CreateDefaultRepresentation(vtkAlgorithmOutput *conn) override
Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.
void SetAreaSizeArrayName(const char *name)
The array to use for area sizes.
virtual void SetLayoutStrategy(vtkAreaLayoutStrategy *strategy)
The layout strategy for producing spatial regions for the tree.
double GetShrinkPercentage()
Set the region shrink percentage between 0.0 and 1.0.
virtual vtkPolyDataAlgorithm * GetAreaToPolyData()
The filter for converting areas to polydata.
virtual void SetAreaToPolyData(vtkPolyDataAlgorithm *areaToPoly)
The filter for converting areas to polydata.
~vtkTreeAreaView() override
virtual bool GetUseRectangularCoordinates()
Whether the area represents radial or rectangular coordinates.
void SetEdgeLabelVisibility(bool vis)
Whether to show edge labels.
vtkDataRepresentation * SetTreeFromInputConnection(vtkAlgorithmOutput *conn)
Set the tree and graph representations to the appropriate input ports.
void SetShrinkPercentage(double value)
Set the region shrink percentage between 0.0 and 1.0.
virtual void SetAreaLabelFontSize(const int size)
The size of the font used for area labeling.
void SetBundlingStrength(double strength)
Set the bundling strength.
void SetColorAreas(bool vis)
Whether to color vertices.
const char * GetAreaHoverArrayName()
The name of the array whose value appears when the mouse hovers over a rectangle in the treemap.
const char * GetLabelPriorityArrayName()
The array to use for area labeling priority.
bool GetAreaLabelVisibility()
Whether to show area labels.
void SetAreaLabelArrayName(const char *name)
The array to use for area labeling.
bool GetColorEdges()
Whether to color edges.
void SetEdgeLabelArrayName(const char *name)
The array to use for edge labeling.
void SetEdgeColorToSplineFraction()
Set the color to be the spline fraction.
virtual int GetEdgeLabelFontSize()
The size of the font used for edge labeling.
void SetEdgeColorArrayName(const char *name)
The array to use for coloring edges.
virtual void SetEdgeLabelFontSize(const int size)
The size of the font used for edge labeling.
virtual void SetUseRectangularCoordinates(bool rect)
Whether the area represents radial or rectangular coordinates.
virtual int GetAreaLabelFontSize()
The size of the font used for area labeling.
vtkDataRepresentation * SetGraphFromInput(vtkGraph *input)
Set the tree and graph representations to the appropriate input ports.
void SetAreaColorArrayName(const char *name)
The array to use for coloring vertices.
virtual void SetAreaLabelMapper(vtkLabeledDataMapper *mapper)
The mapper for rendering labels on areas.
const char * GetEdgeLabelArrayName()
The array to use for edge labeling.
vtkDataRepresentation * SetGraphFromInputConnection(vtkAlgorithmOutput *conn)
Set the tree and graph representations to the appropriate input ports.
void SetAreaHoverArrayName(const char *name)
The name of the array whose value appears when the mouse hovers over a rectangle in the treemap.
void SetLabelPriorityArrayName(const char *name)
The array to use for area labeling priority.
static vtkTreeAreaView * New()
const char * GetEdgeColorArrayName()
The array to use for coloring edges.
bool GetColorAreas()
Whether to color vertices.
const char * GetAreaLabelArrayName()
The array to use for area labeling.
void SetAreaLabelVisibility(bool vis)
Whether to show area labels.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkDataRepresentation * SetTreeFromInput(vtkTree *input)
Set the tree and graph representations to the appropriate input ports.
virtual bool GetEdgeScalarBarVisibility()
Visibility of scalar bar actor for edges.
virtual vtkAreaLayoutStrategy * GetLayoutStrategy()
The layout strategy for producing spatial regions for the tree.
const char * GetAreaSizeArrayName()
The array to use for area sizes.
A rooted tree data structure.
Definition: vtkTree.h:170
@ value
Definition: vtkX3D.h:226
@ name
Definition: vtkX3D.h:225
@ size
Definition: vtkX3D.h:259