VTK  9.2.6
vtkRenderedGraphRepresentation.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkRenderedGraphRepresentation.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-------------------------------------------------------------------------*/
29#ifndef vtkRenderedGraphRepresentation_h
30#define vtkRenderedGraphRepresentation_h
31
33#include "vtkSmartPointer.h" // for SP ivars
34#include "vtkViewsInfovisModule.h" // For export macro
35
36class vtkActor;
37class vtkApplyColors;
38class vtkApplyIcons;
39class vtkEdgeCenters;
40class vtkEdgeLayout;
42class vtkGraphLayout;
48class vtkInformation;
50class vtkLookupTable;
53class vtkPolyData;
57class vtkRenderView;
60class vtkTextProperty;
63class vtkVertexDegree;
64class vtkView;
65class vtkViewTheme;
66
67class VTKVIEWSINFOVIS_EXPORT vtkRenderedGraphRepresentation : public vtkRenderedRepresentation
68{
69public:
72 void PrintSelf(ostream& os, vtkIndent indent) override;
73
74 // ------------------------------------------------------------------------
75 // Vertex labels
76
77 virtual void SetVertexLabelArrayName(const char* name);
78 virtual const char* GetVertexLabelArrayName();
79 virtual void SetVertexLabelPriorityArrayName(const char* name);
80 virtual const char* GetVertexLabelPriorityArrayName();
81 virtual void SetVertexLabelVisibility(bool b);
83 vtkBooleanMacro(VertexLabelVisibility, bool);
86 vtkSetStringMacro(VertexHoverArrayName);
87 vtkGetStringMacro(VertexHoverArrayName);
89
92 vtkSetMacro(HideVertexLabelsOnInteraction, bool);
93 vtkGetMacro(HideVertexLabelsOnInteraction, bool);
94 vtkBooleanMacro(HideVertexLabelsOnInteraction, bool);
96
97 // ------------------------------------------------------------------------
98 // Edge labels
99
100 virtual void SetEdgeLabelArrayName(const char* name);
101 virtual const char* GetEdgeLabelArrayName();
102 virtual void SetEdgeLabelPriorityArrayName(const char* name);
103 virtual const char* GetEdgeLabelPriorityArrayName();
104 virtual void SetEdgeLabelVisibility(bool b);
106 vtkBooleanMacro(EdgeLabelVisibility, bool);
109 vtkSetStringMacro(EdgeHoverArrayName);
110 vtkGetStringMacro(EdgeHoverArrayName);
112
115 vtkSetMacro(HideEdgeLabelsOnInteraction, bool);
116 vtkGetMacro(HideEdgeLabelsOnInteraction, bool);
117 vtkBooleanMacro(HideEdgeLabelsOnInteraction, bool);
119
120 // ------------------------------------------------------------------------
121 // Vertex icons
122
123 virtual void SetVertexIconArrayName(const char* name);
124 virtual const char* GetVertexIconArrayName();
125 virtual void SetVertexIconPriorityArrayName(const char* name);
126 virtual const char* GetVertexIconPriorityArrayName();
127 virtual void SetVertexIconVisibility(bool b);
129 vtkBooleanMacro(VertexIconVisibility, bool);
130 virtual void AddVertexIconType(const char* name, int type);
131 virtual void ClearVertexIconTypes();
132 virtual void SetUseVertexIconTypeMap(bool b);
134 vtkBooleanMacro(UseVertexIconTypeMap, bool);
135 virtual void SetVertexIconAlignment(int align);
137 virtual void SetVertexSelectedIcon(int icon);
139 virtual void SetVertexDefaultIcon(int icon);
140 virtual int GetVertexDefaultIcon();
141
143
153 virtual void SetVertexIconSelectionMode(int mode);
155 virtual void SetVertexIconSelectionModeToSelectedIcon() { this->SetVertexIconSelectionMode(0); }
156 virtual void SetVertexIconSelectionModeToSelectedOffset() { this->SetVertexIconSelectionMode(1); }
157 virtual void SetVertexIconSelectionModeToAnnotationIcon() { this->SetVertexIconSelectionMode(2); }
159 {
160 this->SetVertexIconSelectionMode(3);
161 }
163
164 // ------------------------------------------------------------------------
165 // Edge icons
166
167 virtual void SetEdgeIconArrayName(const char* name);
168 virtual const char* GetEdgeIconArrayName();
169 virtual void SetEdgeIconPriorityArrayName(const char* name);
170 virtual const char* GetEdgeIconPriorityArrayName();
171 virtual void SetEdgeIconVisibility(bool b);
172 virtual bool GetEdgeIconVisibility();
173 vtkBooleanMacro(EdgeIconVisibility, bool);
174 virtual void AddEdgeIconType(const char* name, int type);
175 virtual void ClearEdgeIconTypes();
176 virtual void SetUseEdgeIconTypeMap(bool b);
177 virtual bool GetUseEdgeIconTypeMap();
178 vtkBooleanMacro(UseEdgeIconTypeMap, bool);
179 virtual void SetEdgeIconAlignment(int align);
180 virtual int GetEdgeIconAlignment();
181
182 // ------------------------------------------------------------------------
183 // Vertex colors
184
185 virtual void SetColorVerticesByArray(bool b);
187 vtkBooleanMacro(ColorVerticesByArray, bool);
188 virtual void SetVertexColorArrayName(const char* name);
189 virtual const char* GetVertexColorArrayName();
190
191 // ------------------------------------------------------------------------
192 // Edge colors
193
194 virtual void SetColorEdgesByArray(bool b);
195 virtual bool GetColorEdgesByArray();
196 vtkBooleanMacro(ColorEdgesByArray, bool);
197 virtual void SetEdgeColorArrayName(const char* name);
198 virtual const char* GetEdgeColorArrayName();
199
200 // ------------------------------------------------------------------------
201 // Enabled vertices
202
203 virtual void SetEnableVerticesByArray(bool b);
205 vtkBooleanMacro(EnableVerticesByArray, bool);
206 virtual void SetEnabledVerticesArrayName(const char* name);
207 virtual const char* GetEnabledVerticesArrayName();
208
209 // ------------------------------------------------------------------------
210 // Enabled edges
211
212 virtual void SetEnableEdgesByArray(bool b);
213 virtual bool GetEnableEdgesByArray();
214 vtkBooleanMacro(EnableEdgesByArray, bool);
215 virtual void SetEnabledEdgesArrayName(const char* name);
216 virtual const char* GetEnabledEdgesArrayName();
217
218 virtual void SetEdgeVisibility(bool b);
219 virtual bool GetEdgeVisibility();
220 vtkBooleanMacro(EdgeVisibility, bool);
221
222 void SetEdgeSelection(bool b);
224
225 // ------------------------------------------------------------------------
226 // Vertex layout strategy
227
229
235
237
240 virtual void SetLayoutStrategy(const char* name);
241 vtkGetStringMacro(LayoutStrategyName);
243
247 void SetLayoutStrategyToRandom() { this->SetLayoutStrategy("Random"); }
248 void SetLayoutStrategyToForceDirected() { this->SetLayoutStrategy("Force Directed"); }
249 void SetLayoutStrategyToSimple2D() { this->SetLayoutStrategy("Simple 2D"); }
250 void SetLayoutStrategyToClustering2D() { this->SetLayoutStrategy("Clustering 2D"); }
251 void SetLayoutStrategyToCommunity2D() { this->SetLayoutStrategy("Community 2D"); }
252 void SetLayoutStrategyToFast2D() { this->SetLayoutStrategy("Fast 2D"); }
253 void SetLayoutStrategyToPassThrough() { this->SetLayoutStrategy("Pass Through"); }
254 void SetLayoutStrategyToCircular() { this->SetLayoutStrategy("Circular"); }
255 void SetLayoutStrategyToTree() { this->SetLayoutStrategy("Tree"); }
256 void SetLayoutStrategyToCosmicTree() { this->SetLayoutStrategy("Cosmic Tree"); }
257 void SetLayoutStrategyToCone() { this->SetLayoutStrategy("Cone"); }
258 void SetLayoutStrategyToSpanTree() { this->SetLayoutStrategy("Span Tree"); }
259
265 const char* xarr, const char* yarr = nullptr, const char* zarr = nullptr);
266
278 bool radial, double angle = 90, double leafSpacing = 0.9, double logSpacing = 1.0);
279
290 virtual void SetLayoutStrategyToCosmicTree(const char* nodeSizeArrayName,
291 bool sizeLeafNodesOnly = true, int layoutDepth = 0, vtkIdType layoutRoot = -1);
292
293 // ------------------------------------------------------------------------
294 // Edge layout strategy
295
297
302 void SetEdgeLayoutStrategyToArcParallel() { this->SetEdgeLayoutStrategy("Arc Parallel"); }
303 void SetEdgeLayoutStrategyToPassThrough() { this->SetEdgeLayoutStrategy("Pass Through"); }
305
310 virtual void SetEdgeLayoutStrategyToGeo(double explodeFactor = 0.2);
311
313
316 virtual void SetEdgeLayoutStrategy(const char* name);
317 vtkGetStringMacro(EdgeLayoutStrategyName);
319
320 // ------------------------------------------------------------------------
321 // Miscellaneous
322
326 void ApplyViewTheme(vtkViewTheme* theme) override;
327
329
332 virtual void SetGlyphType(int type);
333 virtual int GetGlyphType();
335
337
340 virtual void SetScaling(bool b);
341 virtual bool GetScaling();
342 vtkBooleanMacro(Scaling, bool);
344
346
349 virtual void SetScalingArrayName(const char* name);
350 virtual const char* GetScalingArrayName();
352
354
357 virtual void SetVertexScalarBarVisibility(bool b);
359 virtual void SetEdgeScalarBarVisibility(bool b);
362
364
370
374 virtual bool IsLayoutComplete();
375
379 virtual void UpdateLayout();
380
384 void ComputeSelectedGraphBounds(double bounds[6]);
385
386protected:
389
391
394 bool AddToView(vtkView* view) override;
395 bool RemoveFromView(vtkView* view) override;
397
398 void PrepareForRendering(vtkRenderView* view) override;
399
401
402 std::string GetHoverStringInternal(vtkSelection* sel) override;
403
408 vtkInformationVector* outputVector) override;
409
411
443
446
447 vtkSetStringMacro(VertexColorArrayNameInternal);
448 vtkGetStringMacro(VertexColorArrayNameInternal);
450
451 vtkSetStringMacro(EdgeColorArrayNameInternal);
452 vtkGetStringMacro(EdgeColorArrayNameInternal);
454
455 vtkSetStringMacro(ScalingArrayNameInternal);
456 vtkGetStringMacro(ScalingArrayNameInternal);
458
459 vtkSetStringMacro(LayoutStrategyName);
461 vtkSetStringMacro(EdgeLayoutStrategyName);
465
467
468private:
470 void operator=(const vtkRenderedGraphRepresentation&) = delete;
471};
472
473#endif
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:52
apply colors to a data set.
apply icons to a data set.
Definition: vtkApplyIcons.h:71
generate points at center of edges
abstract superclass for all edge layout strategies
layout graph edges
Definition: vtkEdgeLayout.h:42
abstract superclass for all graph layout strategies
layout a graph in 2 or 3 dimensions
create glyphs for graph vertices
convert a vtkGraph a set of points.
convert a vtkGraph to vtkPolyData
Filter that generates a polydata consisting of quads with texture coordinates referring to a set of i...
a simple class to control print indentation
Definition: vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
map scalar values into colors via a lookup table
Perturbs vertices that are coincident.
build a label hierarchy for a graph or point set.
draw vtkPolyData onto the image plane
map vtkPolyData to graphics primitives
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:91
Removes the rows/edges/vertices of input data flagged by ann.
A view containing a renderer.
Definition: vtkRenderView.h:65
bool AddToView(vtkView *view) override
Called by the view to add/remove this representation.
virtual void SetEdgeIconVisibility(bool b)
virtual void SetEnabledEdgesArrayName(const char *name)
virtual const char * GetEdgeLabelArrayName()
virtual void SetEdgeLayoutStrategy(vtkEdgeLayoutStrategy *strategy)
Set/get the graph layout strategy.
virtual void SetLayoutStrategyToTree(bool radial, double angle=90, double leafSpacing=0.9, double logSpacing=1.0)
Set the layout strategy to a tree layout.
virtual bool GetScaling()
Set whether to scale vertex glyphs.
virtual void ClearVertexIconTypes()
vtkSmartPointer< vtkActor > OutlineActor
Internal filter classes.
void PrepareForRendering(vtkRenderView *view) override
The view will call this method before every render.
vtkSmartPointer< vtkApplyColors > ApplyColors
Internal filter classes.
virtual const char * GetVertexColorArrayName()
virtual void SetScaling(bool b)
Set whether to scale vertex glyphs.
static vtkRenderedGraphRepresentation * New()
virtual void SetColorEdgesByArray(bool b)
virtual bool GetColorEdgesByArray()
virtual void SetLayoutStrategyToCosmicTree(const char *nodeSizeArrayName, bool sizeLeafNodesOnly=true, int layoutDepth=0, vtkIdType layoutRoot=-1)
Set the layout strategy to a cosmic tree layout.
virtual void SetLayoutStrategy(const char *name)
Get/set the layout strategy by name.
virtual void SetEdgeLayoutStrategy(const char *name)
Set the edge layout strategy by name.
vtkSmartPointer< vtkActor > VertexActor
Internal filter classes.
virtual void SetVertexLabelTextProperty(vtkTextProperty *p)
void ApplyViewTheme(vtkViewTheme *theme) override
Apply a theme to this representation.
virtual const char * GetVertexIconPriorityArrayName()
vtkSmartPointer< vtkTexturedActor2D > VertexIconActor
Internal filter classes.
virtual int GetVertexIconSelectionMode()
Set the mode to one of.
vtkSmartPointer< vtkTransformCoordinateSystems > VertexIconTransform
Internal filter classes.
virtual bool GetColorVerticesByArray()
virtual void SetEnableEdgesByArray(bool b)
virtual void SetVertexLabelArrayName(const char *name)
virtual vtkScalarBarWidget * GetEdgeScalarBar()
Obtain the scalar bar widget used to draw a legend for the vertices/edges.
virtual void SetEdgeVisibility(bool b)
std::string GetHoverStringInternal(vtkSelection *sel) override
Subclasses may override this method to generate the hover text.
vtkSmartPointer< vtkGraphLayout > Layout
Internal filter classes.
virtual bool GetEdgeLabelVisibility()
vtkSmartPointer< vtkScalarBarWidget > EdgeScalarBar
Internal filter classes.
virtual int GetGlyphType()
Set the graph vertex glyph type.
virtual vtkEdgeLayoutStrategy * GetEdgeLayoutStrategy()
Set/get the graph layout strategy.
vtkSmartPointer< vtkGraphToPoints > VertexIconPoints
Internal filter classes.
virtual bool GetEnableEdgesByArray()
vtkSmartPointer< vtkPointSetToLabelHierarchy > EdgeLabelHierarchy
Internal filter classes.
virtual bool GetEdgeIconVisibility()
virtual const char * GetEdgeLabelPriorityArrayName()
virtual void SetVertexIconSelectionMode(int mode)
Set the mode to one of.
virtual bool GetEnableVerticesByArray()
virtual int GetVertexIconAlignment()
vtkSmartPointer< vtkApplyIcons > ApplyVertexIcons
Internal filter classes.
virtual void SetEnabledVerticesArrayName(const char *name)
virtual vtkScalarBarWidget * GetVertexScalarBar()
Obtain the scalar bar widget used to draw a legend for the vertices/edges.
virtual void AddEdgeIconType(const char *name, int type)
virtual void SetVertexDefaultIcon(int icon)
virtual void AddVertexIconType(const char *name, int type)
vtkSmartPointer< vtkPolyData > EmptyPolyData
Internal filter classes.
vtkSmartPointer< vtkPolyDataMapper2D > VertexIconMapper
Internal filter classes.
virtual const char * GetVertexLabelPriorityArrayName()
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkSmartPointer< vtkEdgeCenters > EdgeCenters
Internal filter classes.
vtkSelection * ConvertSelection(vtkView *view, vtkSelection *sel) override
Convert the selection to a type appropriate for sharing with other representations through vtkAnnotat...
virtual void UpdateLayout()
Performs another iteration on the graph layout.
vtkSmartPointer< vtkPointSetToLabelHierarchy > VertexLabelHierarchy
Internal filter classes.
virtual void SetVertexIconSelectionModeToAnnotationIcon()
Set the mode to one of.
virtual void SetEdgeLabelTextProperty(vtkTextProperty *p)
virtual void SetScalingArrayName(const char *name)
Set the glyph scaling array name.
void SetEdgeLayoutStrategyToPassThrough()
Set/get the graph layout strategy.
virtual void SetVertexScalarBarVisibility(bool b)
Vertex/edge scalar bar visibility.
void SetLayoutStrategyToRandom()
Set predefined layout strategies.
virtual void SetLayoutStrategy(vtkGraphLayoutStrategy *strategy)
Set/get the graph layout strategy.
virtual void SetVertexIconSelectionModeToIgnoreSelection()
Set the mode to one of.
virtual bool IsLayoutComplete()
Whether the current graph layout is complete.
virtual vtkTextProperty * GetVertexLabelTextProperty()
virtual void SetEdgeIconAlignment(int align)
virtual void SetVertexIconVisibility(bool b)
virtual void SetVertexSelectedIcon(int icon)
vtkSmartPointer< vtkEdgeLayout > EdgeLayout
Internal filter classes.
bool RemoveFromView(vtkView *view) override
Called by the view to add/remove this representation.
virtual void SetEdgeIconArrayName(const char *name)
virtual const char * GetEdgeIconPriorityArrayName()
virtual const char * GetEdgeIconArrayName()
virtual const char * GetEnabledVerticesArrayName()
virtual void SetVertexIconSelectionModeToSelectedOffset()
Set the mode to one of.
virtual void SetEdgeColorArrayName(const char *name)
virtual void SetColorVerticesByArray(bool b)
virtual vtkGraphLayoutStrategy * GetLayoutStrategy()
Set/get the graph layout strategy.
virtual const char * GetVertexIconArrayName()
vtkSmartPointer< vtkRemoveHiddenData > RemoveHiddenGraph
Internal filter classes.
virtual void SetUseVertexIconTypeMap(bool b)
virtual void SetVertexIconAlignment(int align)
virtual bool GetVertexLabelVisibility()
vtkSmartPointer< vtkPolyDataMapper > VertexMapper
Internal filter classes.
virtual vtkTextProperty * GetEdgeLabelTextProperty()
vtkSmartPointer< vtkGraphToGlyphs > VertexGlyph
Internal filter classes.
virtual bool GetUseVertexIconTypeMap()
vtkSmartPointer< vtkPolyDataMapper > EdgeMapper
Internal filter classes.
virtual void SetEdgeLayoutStrategyToGeo(double explodeFactor=0.2)
Set the edge layout strategy to a geospatial arced strategy appropriate for vtkGeoView.
vtkSmartPointer< vtkPerturbCoincidentVertices > Coincident
Internal filter classes.
virtual void SetVertexColorArrayName(const char *name)
virtual void SetEdgeLabelPriorityArrayName(const char *name)
virtual bool GetUseEdgeIconTypeMap()
virtual void SetEdgeIconPriorityArrayName(const char *name)
virtual void SetVertexIconSelectionModeToSelectedIcon()
Set the mode to one of.
virtual void SetVertexLabelVisibility(bool b)
virtual void SetEnableVerticesByArray(bool b)
int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
Connect inputs to internal pipeline.
virtual const char * GetEdgeColorArrayName()
vtkSmartPointer< vtkGraphToPoints > GraphToPoints
Internal filter classes.
virtual void SetUseEdgeIconTypeMap(bool b)
virtual void SetVertexIconPriorityArrayName(const char *name)
virtual void SetGlyphType(int type)
Set the graph vertex glyph type.
virtual void SetVertexLabelPriorityArrayName(const char *name)
virtual void SetEdgeLabelArrayName(const char *name)
vtkSmartPointer< vtkActor > EdgeActor
Internal filter classes.
vtkSmartPointer< vtkScalarBarWidget > VertexScalarBar
Internal filter classes.
void SetEdgeLayoutStrategyToArcParallel()
Set/get the graph layout strategy.
~vtkRenderedGraphRepresentation() override
virtual const char * GetEnabledEdgesArrayName()
vtkSmartPointer< vtkGraphToGlyphs > OutlineGlyph
Internal filter classes.
virtual void SetLayoutStrategyToAssignCoordinates(const char *xarr, const char *yarr=nullptr, const char *zarr=nullptr)
Set the layout strategy to use coordinates from arrays.
vtkSmartPointer< vtkPolyDataMapper > OutlineMapper
Internal filter classes.
virtual void SetVertexIconArrayName(const char *name)
vtkSmartPointer< vtkVertexDegree > VertexDegree
Internal filter classes.
vtkSmartPointer< vtkGraphToPolyData > GraphToPoly
Internal filter classes.
virtual void SetEdgeScalarBarVisibility(bool b)
Vertex/edge scalar bar visibility.
virtual bool GetEdgeScalarBarVisibility()
Vertex/edge scalar bar visibility.
vtkSmartPointer< vtkIconGlyphFilter > VertexIconGlyph
Internal filter classes.
virtual const char * GetScalingArrayName()
Set the glyph scaling array name.
virtual const char * GetVertexLabelArrayName()
void ComputeSelectedGraphBounds(double bounds[6])
Compute the bounding box of the selected subgraph.
virtual bool GetVertexScalarBarVisibility()
Vertex/edge scalar bar visibility.
virtual void SetEdgeLabelVisibility(bool b)
virtual bool GetVertexIconVisibility()
2D widget for manipulating a scalar bar
Superclass for mapping scalar values to colors.
data object that represents a "selection" in VTK.
Definition: vtkSelection.h:60
Hold a reference to a vtkObjectBase instance.
represent text properties.
actor that draws 2D data with texture support
transform points into different coordinate systems
Adds an attribute array with the degree of each vertex.
Sets theme colors for a graphical view.
Definition: vtkViewTheme.h:49
The superclass for all views.
Definition: vtkView.h:64
int vtkIdType
Definition: vtkType.h:332