VTK  9.2.6
vtkGraphMapper.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkGraphMapper.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 -------------------------------------------------------------------------*/
33 #ifndef vtkGraphMapper_h
34 #define vtkGraphMapper_h
35 
36 #include "vtkMapper.h"
37 #include "vtkRenderingCoreModule.h" // For export macro
38 
39 #include "vtkSmartPointer.h" // Required for smart pointer internal ivars.
40 
41 class vtkActor2D;
42 class vtkMapArrayValues;
43 class vtkCamera;
44 class vtkFollower;
45 class vtkGraph;
46 class vtkGlyph3D;
47 class vtkGraphToPolyData;
48 class vtkIconGlyphFilter;
49 class vtkCellCenters;
50 class vtkPolyData;
51 class vtkPolyDataMapper;
53 class vtkLookupTable;
55 class vtkTexture;
56 class vtkTexturedActor2D;
58 
59 class VTKRENDERINGCORE_EXPORT vtkGraphMapper : public vtkMapper
60 {
61 public:
62  static vtkGraphMapper* New();
63  vtkTypeMacro(vtkGraphMapper, vtkMapper);
64  void PrintSelf(ostream& os, vtkIndent indent) override;
65  void Render(vtkRenderer* ren, vtkActor* act) override;
66 
68 
71  void SetVertexColorArrayName(const char* name);
72  const char* GetVertexColorArrayName();
74 
76 
79  void SetColorVertices(bool vis);
80  bool GetColorVertices();
81  void ColorVerticesOn();
82  void ColorVerticesOff();
84 
86 
92  void SetScaledGlyphs(bool arg);
93  vtkGetMacro(ScaledGlyphs, bool);
94  vtkBooleanMacro(ScaledGlyphs, bool);
96 
98 
101  vtkSetStringMacro(ScalingArrayName);
102  vtkGetStringMacro(ScalingArrayName);
104 
106 
109  void SetEdgeVisibility(bool vis);
110  bool GetEdgeVisibility();
111  vtkBooleanMacro(EdgeVisibility, bool);
113 
115 
118  void SetEdgeColorArrayName(const char* name);
119  const char* GetEdgeColorArrayName();
121 
123 
126  void SetColorEdges(bool vis);
127  bool GetColorEdges();
128  void ColorEdgesOn();
129  void ColorEdgesOff();
131 
133 
136  vtkSetStringMacro(EnabledEdgesArrayName);
137  vtkGetStringMacro(EnabledEdgesArrayName);
139 
141 
144  vtkSetMacro(EnableEdgesByArray, vtkTypeBool);
145  vtkGetMacro(EnableEdgesByArray, vtkTypeBool);
146  vtkBooleanMacro(EnableEdgesByArray, vtkTypeBool);
148 
150 
153  vtkSetStringMacro(EnabledVerticesArrayName);
154  vtkGetStringMacro(EnabledVerticesArrayName);
156 
158 
161  vtkSetMacro(EnableVerticesByArray, vtkTypeBool);
162  vtkGetMacro(EnableVerticesByArray, vtkTypeBool);
163  vtkBooleanMacro(EnableVerticesByArray, vtkTypeBool);
165 
167 
170  void SetIconArrayName(const char* name);
171  const char* GetIconArrayName();
173 
179  void AddIconType(const char* type, int index);
180 
184  void ClearIconTypes();
185 
187 
190  void SetIconSize(int* size);
191  int* GetIconSize();
193 
198  void SetIconAlignment(int alignment);
199 
201 
204  vtkTexture* GetIconTexture();
205  void SetIconTexture(vtkTexture* texture);
207 
209 
212  void SetIconVisibility(bool vis);
213  bool GetIconVisibility();
214  vtkBooleanMacro(IconVisibility, bool);
216 
218 
221  vtkGetMacro(VertexPointSize, float);
222  void SetVertexPointSize(float size);
224 
226 
229  vtkGetMacro(EdgeLineWidth, float);
230  void SetEdgeLineWidth(float width);
232 
238  void ReleaseGraphicsResources(vtkWindow*) override;
239 
243  vtkMTimeType GetMTime() override;
244 
246 
249  void SetInputData(vtkGraph* input);
250  vtkGraph* GetInput();
252 
257  double* GetBounds() VTK_SIZEHINT(6) override;
258  void GetBounds(double* bounds) override { Superclass::GetBounds(bounds); }
259 
261 
264  vtkGetObjectMacro(EdgeLookupTable, vtkLookupTable);
265  vtkGetObjectMacro(VertexLookupTable, vtkLookupTable);
267 
268 protected:
269  vtkGraphMapper();
270  ~vtkGraphMapper() override;
271 
273 
276  vtkGetStringMacro(VertexColorArrayNameInternal);
277  vtkSetStringMacro(VertexColorArrayNameInternal);
278  vtkGetStringMacro(EdgeColorArrayNameInternal);
279  vtkSetStringMacro(EdgeColorArrayNameInternal);
283 
288 
289  vtkGetStringMacro(IconArrayNameInternal);
290  vtkSetStringMacro(IconArrayNameInternal);
291  char* IconArrayNameInternal;
292 
295 
301 
306 
311 
312  // Color maps
315 
316  void ReportReferences(vtkGarbageCollector*) override;
317 
318  // see algorithm for more info
319  int FillInputPortInformation(int port, vtkInformation* info) override;
320 
321 private:
322  vtkGraphMapper(const vtkGraphMapper&) = delete;
323  void operator=(const vtkGraphMapper&) = delete;
324 
325  // Helper function
326  vtkPolyData* CreateCircle(bool filled);
327 
328  float VertexPointSize;
329  float EdgeLineWidth;
330  bool ScaledGlyphs;
331  char* ScalingArrayName;
332 };
333 
334 #endif
char * EdgeColorArrayNameInternal
Used to store the vertex and edge color array names.
map vtkGraph and derived classes to graphics primitives
void GetBounds(T a, double bds[6])
char * EnabledVerticesArrayName
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:51
actor that draws 2D data with texture support
char * IconArrayNameInternal
Map values in an input array to different values in an output array of (possibly) different type...
Store vtkAlgorithm input/output information.
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287
Filter that generates a polydata consisting of quads with texture coordinates referring to a set of i...
vtkTypeBool EnableEdgesByArray
vtkSmartPointer< vtkPolyDataMapper > OutlineMapper
void ReportReferences(vtkGarbageCollector *) override
a actor that draws 2D data
Definition: vtkActor2D.h:45
map scalar values into colors via a lookup table
abstract specification for renderers
Definition: vtkRenderer.h:72
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:90
vtkSmartPointer< vtkGlyph3D > CircleOutlineGlyph
vtkSmartPointer< vtkIconGlyphFilter > IconGlyph
vtkSmartPointer< vtkActor > OutlineActor
generate points at center of cells
Detect and break reference loops.
vtkSmartPointer< vtkTransformCoordinateSystems > IconTransform
int vtkTypeBool
Definition: vtkABI.h:69
convert a vtkGraph to vtkPolyData
Base class for graph data types.
Definition: vtkGraph.h:295
window superclass for vtkRenderWindow
Definition: vtkWindow.h:38
Make a vtkPolyData with a vertex on each point.
a simple class to control print indentation
Definition: vtkIndent.h:39
a virtual camera for 3D rendering
Definition: vtkCamera.h:51
vtkLookupTable * VertexLookupTable
copy oriented and scaled glyph geometry to every input point
Definition: vtkGlyph3D.h:112
vtkSmartPointer< vtkPolyDataMapper > VertexMapper
vtkSmartPointer< vtkGlyph3D > CircleGlyph
handles properties associated with a texture map
Definition: vtkTexture.h:68
virtual double * GetBounds()=0
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkLookupTable * EdgeLookupTable
vtkMTimeType GetMTime() override
Overload standard modified time function.
vtkSmartPointer< vtkActor > EdgeActor
#define VTK_SIZEHINT(...)
transform points into different coordinate systems
virtual int FillInputPortInformation(int port, vtkInformation *info)
Fill the input port information objects for this algorithm.
abstract class specifies interface to map data to graphics primitives
Definition: vtkMapper.h:87
map vtkPolyData to graphics primitives
a subclass of actor that always faces the camera
Definition: vtkFollower.h:43
vtkSmartPointer< vtkTexturedActor2D > IconActor
vtkSmartPointer< vtkActor > VertexActor
char * EnabledEdgesArrayName
vtkSmartPointer< vtkGraphToPolyData > GraphToPoly
static vtkAlgorithm * New()
double * GetBounds() override
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).
vtkSmartPointer< vtkMapArrayValues > IconTypeToIndex
vtkDataSet * GetInput()
Get the input as a vtkDataSet.
vtkSmartPointer< vtkVertexGlyphFilter > VertexGlyph
vtkSmartPointer< vtkPolyDataMapper2D > IconMapper
vtkSmartPointer< vtkPolyDataMapper > EdgeMapper
virtual void Render(vtkRenderer *ren, vtkActor *a)=0
Method initiates the mapping process.
char * VertexColorArrayNameInternal
Used to store the vertex and edge color array names.
draw vtkPolyData onto the image plane
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this mapper.
Definition: vtkMapper.h:115
vtkTypeBool EnableVerticesByArray