VTK  9.2.5
vtkGraphLayoutView.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkGraphLayoutView.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-------------------------------------------------------------------------*/
48#ifndef vtkGraphLayoutView_h
49#define vtkGraphLayoutView_h
50
51#include "vtkRenderView.h"
52#include "vtkViewsInfovisModule.h" // For export macro
53
57class vtkViewTheme;
58
59class VTKVIEWSINFOVIS_EXPORT vtkGraphLayoutView : public vtkRenderView
60{
61public:
64 void PrintSelf(ostream& os, vtkIndent indent) override;
65
67
70 void SetVertexLabelArrayName(const char* name);
73
75
78 void SetEdgeLabelArrayName(const char* name);
79 const char* GetEdgeLabelArrayName();
81
83
88 vtkBooleanMacro(VertexLabelVisibility, bool);
90
92
97 vtkBooleanMacro(HideVertexLabelsOnInteraction, bool);
99
101
104 void SetEdgeVisibility(bool vis);
106 vtkBooleanMacro(EdgeVisibility, bool);
108
110
115 vtkBooleanMacro(EdgeLabelVisibility, bool);
117
119
124 vtkBooleanMacro(HideEdgeLabelsOnInteraction, bool);
126
128
132 void SetVertexColorArrayName(const char* name);
135
137
140 void SetColorVertices(bool vis);
142 vtkBooleanMacro(ColorVertices, bool);
144
146
149 void SetEdgeColorArrayName(const char* name);
152
154
157 void SetColorEdges(bool vis);
159 vtkBooleanMacro(ColorEdges, bool);
161
163
166 void SetEdgeSelection(bool vis);
168 vtkBooleanMacro(EdgeSelection, bool);
170
172
175 void SetEnabledEdgesArrayName(const char* name);
178
180
183 void SetEnableEdgesByArray(bool vis);
186
188
191 void SetEnabledVerticesArrayName(const char* name);
194
196
202
204
207 void SetScalingArrayName(const char* name);
208 const char* GetScalingArrayName();
210
212
215 void SetScaledGlyphs(bool arg);
217 vtkBooleanMacro(ScaledGlyphs, bool);
219
221
239 void SetLayoutStrategy(const char* name);
240 void SetLayoutStrategyToRandom() { this->SetLayoutStrategy("Random"); }
241 void SetLayoutStrategyToForceDirected() { this->SetLayoutStrategy("Force Directed"); }
242 void SetLayoutStrategyToSimple2D() { this->SetLayoutStrategy("Simple 2D"); }
243 void SetLayoutStrategyToClustering2D() { this->SetLayoutStrategy("Clustering 2D"); }
244 void SetLayoutStrategyToCommunity2D() { this->SetLayoutStrategy("Community 2D"); }
245 void SetLayoutStrategyToFast2D() { this->SetLayoutStrategy("Fast 2D"); }
246 void SetLayoutStrategyToPassThrough() { this->SetLayoutStrategy("Pass Through"); }
247 void SetLayoutStrategyToCircular() { this->SetLayoutStrategy("Circular"); }
248 void SetLayoutStrategyToTree() { this->SetLayoutStrategy("Tree"); }
249 void SetLayoutStrategyToCosmicTree() { this->SetLayoutStrategy("Cosmic Tree"); }
250 void SetLayoutStrategyToCone() { this->SetLayoutStrategy("Cone"); }
251 void SetLayoutStrategyToSpanTree() { this->SetLayoutStrategy("Span Tree"); }
254
256
264
266
273 void SetEdgeLayoutStrategy(const char* name);
274 void SetEdgeLayoutStrategyToArcParallel() { this->SetEdgeLayoutStrategy("Arc Parallel"); }
275 void SetEdgeLayoutStrategyToPassThrough() { this->SetEdgeLayoutStrategy("Pass Through"); }
278
280
288
294 void AddIconType(const char* type, int index);
295
300
305 void SetIconAlignment(int alignment);
306
308
311 void SetIconVisibility(bool b);
313 vtkBooleanMacro(IconVisibility, bool);
315
317
320 void SetIconArrayName(const char* name);
321 const char* GetIconArrayName();
323
325
328 void SetGlyphType(int type);
331
333
336 virtual void SetVertexLabelFontSize(const int size);
339
341
344 virtual void SetEdgeLabelFontSize(const int size);
345 virtual int GetEdgeLabelFontSize();
347
349
355
357
363
368
375 virtual int IsLayoutComplete();
376
387 virtual void UpdateLayout();
388
389protected:
392
394
400 // Called to process events. Overrides behavior in vtkRenderView.
401 void ProcessEvents(vtkObject* caller, unsigned long eventId, void* callData) override;
403
404private:
405 vtkGraphLayoutView(const vtkGraphLayoutView&) = delete;
406 void operator=(const vtkGraphLayoutView&) = delete;
407 bool VertexLabelsRequested;
408 bool EdgeLabelsRequested;
409};
410
411#endif
Proxy object to connect input/output ports.
The superclass for all representations.
abstract superclass for all edge layout strategies
abstract superclass for all graph layout strategies
Lays out and displays a graph.
bool GetVertexLabelVisibility()
Whether to show vertex labels.
void SetLayoutStrategyToSpanTree()
The layout strategy to use when performing the graph layout.
vtkDataRepresentation * CreateDefaultRepresentation(vtkAlgorithmOutput *conn) override
Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.
void SetEdgeLayoutStrategy(vtkEdgeLayoutStrategy *s)
The layout strategy to use when performing the edge layout.
void SetScaledGlyphs(bool arg)
Whether to use scaled glyphs or not.
void SetScalingArrayName(const char *name)
The array used for scaling (if ScaledGlyphs is ON)
virtual void SetVertexLabelFontSize(const int size)
The size of the font used for vertex labeling.
void SetEdgeLayoutStrategyToPassThrough()
The layout strategy to use when performing the edge layout.
bool GetEdgeLabelVisibility()
Whether to show edge labels.
void SetLayoutStrategyToClustering2D()
The layout strategy to use when performing the graph layout.
void SetEdgeLayoutStrategy(const char *name)
The layout strategy to use when performing the edge layout.
const char * GetEnabledVerticesArrayName()
The array to use for coloring vertices.
bool GetColorEdges()
Whether to color edges.
void SetGlyphType(int type)
The type of glyph to use for the vertices.
void SetEnabledVerticesArrayName(const char *name)
The array to use for coloring vertices.
vtkGraphLayoutStrategy * GetLayoutStrategy()
The layout strategy to use when performing the graph layout.
const char * GetVertexLabelArrayName()
The array to use for vertex labeling.
void SetEdgeLayoutStrategyToArcParallel()
The layout strategy to use when performing the edge layout.
static vtkGraphLayoutView * New()
bool GetEdgeSelection()
Whether edges are selectable.
void SetVertexColorArrayName(const char *name)
The array to use for coloring vertices.
void AddIconType(const char *type, int index)
Associate the icon at index "index" in the vtkTexture to all vertices containing "type" as a value in...
bool GetIconVisibility()
Whether icons are visible (default off).
bool GetScaledGlyphs()
Whether to use scaled glyphs or not.
int GetEnableEdgesByArray()
Whether to color edges.
void ProcessEvents(vtkObject *caller, unsigned long eventId, void *callData) override
Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.
void SetColorEdges(bool vis)
Whether to color edges.
bool GetColorVertices()
Whether to color vertices.
const char * GetScalingArrayName()
The array used for scaling (if ScaledGlyphs is ON)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual int IsLayoutComplete()
Is the graph layout complete? This method is useful for when the strategy is iterative and the applic...
void SetLayoutStrategyToRandom()
The layout strategy to use when performing the graph layout.
int GetGlyphType()
The type of glyph to use for the vertices.
void SetLayoutStrategyToCone()
The layout strategy to use when performing the graph layout.
void SetEdgeColorArrayName(const char *name)
The array to use for coloring edges.
void SetLayoutStrategyToCosmicTree()
The layout strategy to use when performing the graph layout.
void SetLayoutStrategyToTree()
The layout strategy to use when performing the graph layout.
virtual vtkRenderedGraphRepresentation * GetGraphRepresentation()
Overrides behavior in vtkView to create a vtkRenderedGraphRepresentation by default.
void SetLayoutStrategy(const char *name)
The layout strategy to use when performing the graph layout.
const char * GetEnabledEdgesArrayName()
The array to use for coloring edges.
void SetLayoutStrategyToPassThrough()
The layout strategy to use when performing the graph layout.
int GetEnableVerticesByArray()
Whether to color vertices.
void SetVertexLabelArrayName(const char *name)
The array to use for vertex labeling.
bool GetHideVertexLabelsOnInteraction()
Whether to hide vertex labels during mouse interactions.
void SetIconArrayName(const char *name)
The array used for assigning icons.
~vtkGraphLayoutView() override
void SetEdgeLabelVisibility(bool vis)
Whether to show edge labels.
void SetHideEdgeLabelsOnInteraction(bool vis)
Whether to hide edge labels during mouse interactions.
bool GetEdgeVisibility()
Whether to show the edges at all.
const char * GetEdgeColorArrayName()
The array to use for coloring edges.
bool GetVertexScalarBarVisibility()
Whether the scalar bar for vertices is visible.
void SetLayoutStrategyToSimple2D()
The layout strategy to use when performing the graph layout.
bool GetHideEdgeLabelsOnInteraction()
Whether to hide edge labels during mouse interactions.
virtual int GetVertexLabelFontSize()
The size of the font used for vertex labeling.
void SetEdgeSelection(bool vis)
Whether edges are selectable.
void SetEnableEdgesByArray(bool vis)
Whether to color edges.
const char * GetVertexColorArrayName()
The array to use for coloring vertices.
void SetEdgeVisibility(bool vis)
Whether to show the edges at all.
void SetEnableVerticesByArray(bool vis)
Whether to color vertices.
void SetLayoutStrategyToCircular()
The layout strategy to use when performing the graph layout.
virtual int GetEdgeLabelFontSize()
The size of the font used for edge labeling.
const char * GetIconArrayName()
The array used for assigning icons.
void SetEdgeScalarBarVisibility(bool vis)
Whether the scalar bar for edges is visible.
void SetEdgeLabelArrayName(const char *name)
The array to use for edge labeling.
const char * GetLayoutStrategyName()
The layout strategy to use when performing the graph layout.
void SetLayoutStrategyToForceDirected()
The layout strategy to use when performing the graph layout.
void ZoomToSelection()
Reset the camera based on the bounds of the selected region.
virtual void UpdateLayout()
This method is useful for when the strategy is iterative and the application wants to show the iterat...
void SetIconVisibility(bool b)
Whether icons are visible (default off).
void SetVertexScalarBarVisibility(bool vis)
Whether the scalar bar for vertices is visible.
virtual void SetEdgeLabelFontSize(const int size)
The size of the font used for edge labeling.
void SetLayoutStrategyToCommunity2D()
The layout strategy to use when performing the graph layout.
const char * GetEdgeLayoutStrategyName()
The layout strategy to use when performing the edge layout.
void SetColorVertices(bool vis)
Whether to color vertices.
bool GetEdgeScalarBarVisibility()
Whether the scalar bar for edges is visible.
void SetLayoutStrategyToFast2D()
The layout strategy to use when performing the graph layout.
void SetIconAlignment(int alignment)
Specify where the icons should be placed in relation to the vertex.
void ClearIconTypes()
Clear all icon mappings.
vtkEdgeLayoutStrategy * GetEdgeLayoutStrategy()
The layout strategy to use when performing the edge layout.
const char * GetEdgeLabelArrayName()
The array to use for edge labeling.
void SetLayoutStrategy(vtkGraphLayoutStrategy *s)
The layout strategy to use when performing the graph layout.
void SetVertexLabelVisibility(bool vis)
Whether to show vertex labels.
void SetEnabledEdgesArrayName(const char *name)
The array to use for coloring edges.
void SetHideVertexLabelsOnInteraction(bool vis)
Whether to hide vertex labels during mouse interactions.
a simple class to control print indentation
Definition: vtkIndent.h:40
abstract base class for most VTK objects
Definition: vtkObject.h:63
A view containing a renderer.
Definition: vtkRenderView.h:65
Sets theme colors for a graphical view.
Definition: vtkViewTheme.h:49