VTK  9.0.20210616
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
vtkTreeAreaView::GetEdgeLabelFontSize
virtual int GetEdgeLabelFontSize()
The size of the font used for edge labeling.
vtkTreeAreaView::GetShrinkPercentage
double GetShrinkPercentage()
Set the region shrink percentage between 0.0 and 1.0.
vtkTreeAreaView::GetAreaHoverArrayName
const char * GetAreaHoverArrayName()
The name of the array whose value appears when the mouse hovers over a rectangle in the treemap.
vtkTreeAreaView::SetColorAreas
void SetColorAreas(bool vis)
Whether to color vertices.
vtkRenderView
A view containing a renderer.
Definition: vtkRenderView.h:65
vtkTreeAreaView::New
static vtkTreeAreaView * New()
vtkTreeAreaView::SetAreaToPolyData
virtual void SetAreaToPolyData(vtkPolyDataAlgorithm *areaToPoly)
The filter for converting areas to polydata.
vtkTreeAreaView::GetAreaToPolyData
virtual vtkPolyDataAlgorithm * GetAreaToPolyData()
The filter for converting areas to polydata.
vtkTreeAreaView::SetTreeFromInput
vtkDataRepresentation * SetTreeFromInput(vtkTree *input)
Set the tree and graph representations to the appropriate input ports.
vtkTreeAreaView::SetLayoutStrategy
virtual void SetLayoutStrategy(vtkAreaLayoutStrategy *strategy)
The layout strategy for producing spatial regions for the tree.
vtkX3D::value
@ value
Definition: vtkX3D.h:226
vtkRenderedTreeAreaRepresentation
Definition: vtkRenderedTreeAreaRepresentation.h:52
vtkTreeAreaView::SetAreaLabelVisibility
void SetAreaLabelVisibility(bool vis)
Whether to show area labels.
vtkTreeAreaView::SetEdgeLabelFontSize
virtual void SetEdgeLabelFontSize(const int size)
The size of the font used for edge labeling.
vtkTreeAreaView::GetAreaColorArrayName
const char * GetAreaColorArrayName()
The array to use for coloring vertices.
vtkTreeAreaView::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkTreeAreaView::SetEdgeLabelVisibility
void SetEdgeLabelVisibility(bool vis)
Whether to show edge labels.
vtkTreeAreaView::GetEdgeScalarBarVisibility
virtual bool GetEdgeScalarBarVisibility()
Visibility of scalar bar actor for edges.
vtkTreeAreaView::GetAreaLabelFontSize
virtual int GetAreaLabelFontSize()
The size of the font used for area labeling.
vtkRenderView.h
vtkTreeAreaView::GetEdgeLabelArrayName
const char * GetEdgeLabelArrayName()
The array to use for edge labeling.
vtkTreeAreaView::CreateDefaultRepresentation
vtkDataRepresentation * CreateDefaultRepresentation(vtkAlgorithmOutput *conn) override
Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.
vtkTreeAreaView::SetEdgeColorToSplineFraction
void SetEdgeColorToSplineFraction()
Set the color to be the spline fraction.
vtkTreeAreaView::SetAreaHoverArrayName
void SetAreaHoverArrayName(const char *name)
The name of the array whose value appears when the mouse hovers over a rectangle in the treemap.
vtkTreeAreaView::GetAreaLabelArrayName
const char * GetAreaLabelArrayName()
The array to use for area labeling.
vtkTree
A rooted tree data structure.
Definition: vtkTree.h:55
vtkTreeAreaView::SetBundlingStrength
void SetBundlingStrength(double strength)
Set the bundling strength.
vtkTreeAreaView::GetEdgeLabelVisibility
bool GetEdgeLabelVisibility()
Whether to show edge labels.
vtkTreeAreaView::GetLabelPriorityArrayName
const char * GetLabelPriorityArrayName()
The array to use for area labeling priority.
vtkTreeAreaView::SetAreaLabelMapper
virtual void SetAreaLabelMapper(vtkLabeledDataMapper *mapper)
The mapper for rendering labels on areas.
vtkDataRepresentation
The superclass for all representations.
Definition: vtkDataRepresentation.h:73
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:34
vtkTreeAreaView::SetAreaSizeArrayName
void SetAreaSizeArrayName(const char *name)
The array to use for area sizes.
vtkX3D::size
@ size
Definition: vtkX3D.h:259
vtkTreeAreaView::GetColorEdges
bool GetColorEdges()
Whether to color edges.
vtkTreeAreaView::SetTreeFromInputConnection
vtkDataRepresentation * SetTreeFromInputConnection(vtkAlgorithmOutput *conn)
Set the tree and graph representations to the appropriate input ports.
vtkTreeAreaView::SetAreaLabelFontSize
virtual void SetAreaLabelFontSize(const int size)
The size of the font used for area labeling.
vtkTreeAreaView::GetLayoutStrategy
virtual vtkAreaLayoutStrategy * GetLayoutStrategy()
The layout strategy for producing spatial regions for the tree.
vtkTreeAreaView::SetAreaColorArrayName
void SetAreaColorArrayName(const char *name)
The array to use for coloring vertices.
vtkX3D::name
@ name
Definition: vtkX3D.h:225
vtkTreeAreaView::SetUseRectangularCoordinates
virtual void SetUseRectangularCoordinates(bool rect)
Whether the area represents radial or rectangular coordinates.
vtkTreeAreaView::GetAreaLabelVisibility
bool GetAreaLabelVisibility()
Whether to show area labels.
vtkTreeAreaView::SetGraphFromInput
vtkDataRepresentation * SetGraphFromInput(vtkGraph *input)
Set the tree and graph representations to the appropriate input ports.
vtkTreeAreaView::SetColorEdges
void SetColorEdges(bool vis)
Whether to color edges.
vtkTreeAreaView::SetLabelPriorityArrayName
void SetLabelPriorityArrayName(const char *name)
The array to use for area labeling priority.
vtkTreeAreaView::GetTreeAreaRepresentation
virtual vtkRenderedTreeAreaRepresentation * GetTreeAreaRepresentation()
Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.
vtkLabeledDataMapper
draw text labels at dataset points
Definition: vtkLabeledDataMapper.h:71
vtkTreeAreaView::GetEdgeColorArrayName
const char * GetEdgeColorArrayName()
The array to use for coloring edges.
vtkTreeAreaView::GetAreaLabelMapper
virtual vtkLabeledDataMapper * GetAreaLabelMapper()
The mapper for rendering labels on areas.
vtkTreeAreaView::SetEdgeColorArrayName
void SetEdgeColorArrayName(const char *name)
The array to use for coloring edges.
vtkAlgorithmOutput
Proxy object to connect input/output ports.
Definition: vtkAlgorithmOutput.h:37
vtkTreeAreaView::SetAreaLabelArrayName
void SetAreaLabelArrayName(const char *name)
The array to use for area labeling.
vtkTreeAreaView::SetGraphFromInputConnection
vtkDataRepresentation * SetGraphFromInputConnection(vtkAlgorithmOutput *conn)
Set the tree and graph representations to the appropriate input ports.
vtkTreeAreaView::GetAreaSizeArrayName
const char * GetAreaSizeArrayName()
The array to use for area sizes.
vtkTreeAreaView::GetBundlingStrength
double GetBundlingStrength()
Set the bundling strength.
vtkTreeAreaView::~vtkTreeAreaView
~vtkTreeAreaView() override
vtkTreeAreaView::vtkTreeAreaView
vtkTreeAreaView()
vtkGraph
Base class for graph data types.
Definition: vtkGraph.h:290
vtkAreaLayoutStrategy
abstract superclass for all area layout strategies
Definition: vtkAreaLayoutStrategy.h:48
vtkTreeAreaView::SetEdgeScalarBarVisibility
virtual void SetEdgeScalarBarVisibility(bool b)
Visibility of scalar bar actor for edges.
vtkTreeAreaView::GetColorAreas
bool GetColorAreas()
Whether to color vertices.
vtkTreeAreaView
Accepts a graph and a hierarchy - currently a tree - and provides a hierarchy-aware display.
Definition: vtkTreeAreaView.h:54
vtkTreeAreaView::SetShrinkPercentage
void SetShrinkPercentage(double value)
Set the region shrink percentage between 0.0 and 1.0.
vtkTreeAreaView::GetUseRectangularCoordinates
virtual bool GetUseRectangularCoordinates()
Whether the area represents radial or rectangular coordinates.
vtkTreeAreaView::SetEdgeLabelArrayName
void SetEdgeLabelArrayName(const char *name)
The array to use for edge labeling.
vtkPolyDataAlgorithm
Superclass for algorithms that produce only polydata as output.
Definition: vtkPolyDataAlgorithm.h:42