VTK
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 "vtkRenderingCoreModule.h" // For export macro
37 #include "vtkMapper.h"
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);
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);
111  vtkBooleanMacro(EdgeVisibility, bool);
113 
115 
118  void SetEdgeColorArrayName(const char* name);
119  const char* GetEdgeColorArrayName();
121 
123 
126  void SetColorEdges(bool vis);
128  void ColorEdgesOn();
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 
185 
187 
190  void SetIconSize(int *size);
191  int *GetIconSize();
193 
198  void SetIconAlignment(int alignment);
199 
201 
205  void SetIconTexture(vtkTexture *texture);
207 
209 
212  void SetIconVisibility(bool vis);
214  vtkBooleanMacro(IconVisibility, bool);
216 
218 
221  vtkGetMacro(VertexPointSize,float);
224 
226 
229  vtkGetMacro(EdgeLineWidth,float);
230  void SetEdgeLineWidth(float width);
232 
239 
243  vtkMTimeType GetMTime() override;
244 
246 
249  void SetInputData(vtkGraph *input);
252 
257  double *GetBounds() VTK_SIZEHINT(6) override;
258  void GetBounds(double* bounds) override
259  { Superclass::GetBounds(bounds); }
260 
262 
265  vtkGetObjectMacro(EdgeLookupTable, vtkLookupTable);
266  vtkGetObjectMacro(VertexLookupTable, vtkLookupTable);
268 
269 protected:
271  ~vtkGraphMapper() override;
272 
274 
277  vtkGetStringMacro(VertexColorArrayNameInternal);
278  vtkSetStringMacro(VertexColorArrayNameInternal);
279  vtkGetStringMacro(EdgeColorArrayNameInternal);
280  vtkSetStringMacro(EdgeColorArrayNameInternal);
284 
289 
290  vtkGetStringMacro(IconArrayNameInternal);
291  vtkSetStringMacro(IconArrayNameInternal);
293 
296 
302 
307 
312 
313  // Color maps
316 
318 
319  // see algorithm for more info
321 
322 private:
323  vtkGraphMapper(const vtkGraphMapper&) = delete;
324  void operator=(const vtkGraphMapper&) = delete;
325 
326  // Helper function
327  vtkPolyData* CreateCircle(bool filled);
328 
329  float VertexPointSize;
330  float EdgeLineWidth;
331  bool ScaledGlyphs;
332  char* ScalingArrayName;
333 };
334 
335 #endif
vtkPolyDataMapper
map vtkPolyData to graphics primitives
Definition: vtkPolyDataMapper.h:43
vtkGraphToPolyData
convert a vtkGraph to vtkPolyData
Definition: vtkGraphToPolyData.h:48
vtkGraphMapper::EnableEdgesByArray
vtkTypeBool EnableEdgesByArray
Definition: vtkGraphMapper.h:287
vtkGraphMapper::vtkGraphMapper
vtkGraphMapper()
vtkFollower
a subclass of actor that always faces the camera
Definition: vtkFollower.h:47
vtkGraphMapper::ReportReferences
void ReportReferences(vtkGarbageCollector *) override
vtkGraphMapper::OutlineActor
vtkSmartPointer< vtkActor > OutlineActor
Definition: vtkGraphMapper.h:310
vtkPolyDataMapper2D
draw vtkPolyData onto the image plane
Definition: vtkPolyDataMapper2D.h:52
vtkGraphMapper::VertexGlyph
vtkSmartPointer< vtkVertexGlyphFilter > VertexGlyph
Definition: vtkGraphMapper.h:298
vtkGraphMapper::SetIconAlignment
void SetIconAlignment(int alignment)
Specify where the icons should be placed in relation to the vertex.
vtkAbstractMapper3D::GetBounds
virtual double * GetBounds()=0
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
vtkGraphMapper::New
static vtkGraphMapper * New()
vtkGraphMapper::EdgeLookupTable
vtkLookupTable * EdgeLookupTable
Definition: vtkGraphMapper.h:314
vtkTexturedActor2D
actor that draws 2D data with texture support
Definition: vtkTexturedActor2D.h:42
vtkGraphMapper::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this mapper.
vtkGraphMapper::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkGraphMapper::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkX3D::type
@ type
Definition: vtkX3D.h:516
vtkGraphMapper::SetEdgeVisibility
void SetEdgeVisibility(bool vis)
Whether to show edges or not.
vtkGraphMapper::GetBounds
double * GetBounds() override
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
vtkGraphMapper::ClearIconTypes
void ClearIconTypes()
Clear all icon mappings.
vtkGraphMapper::Render
void Render(vtkRenderer *ren, vtkActor *act) override
Method initiates the mapping process.
vtkGraphMapper::IconActor
vtkSmartPointer< vtkTexturedActor2D > IconActor
Definition: vtkGraphMapper.h:311
vtkGraphMapper::IconTransform
vtkSmartPointer< vtkTransformCoordinateSystems > IconTransform
Definition: vtkGraphMapper.h:301
vtkGraphMapper::~vtkGraphMapper
~vtkGraphMapper() override
vtkGraphMapper::SetScaledGlyphs
void SetScaledGlyphs(bool arg)
Whether scaled glyphs are on or not.
vtkSmartPointer< vtkGlyph3D >
vtkGraphMapper::EnableVerticesByArray
vtkTypeBool EnableVerticesByArray
Definition: vtkGraphMapper.h:288
vtkGraphMapper::SetEdgeLineWidth
void SetEdgeLineWidth(float width)
vtkGraphMapper::GetColorEdges
bool GetColorEdges()
vtkGraphMapper::IconArrayNameInternal
char * IconArrayNameInternal
Definition: vtkGraphMapper.h:291
vtkGraphMapper::EdgeColorArrayNameInternal
char * EdgeColorArrayNameInternal
Definition: vtkGraphMapper.h:282
vtkIconGlyphFilter
Filter that generates a polydata consisting of quads with texture coordinates referring to a set of i...
Definition: vtkIconGlyphFilter.h:63
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:38
vtkGraphMapper::SetInputData
void SetInputData(vtkGraph *input)
Set the Input of this mapper.
vtkGraphMapper::EdgeMapper
vtkSmartPointer< vtkPolyDataMapper > EdgeMapper
Definition: vtkGraphMapper.h:303
vtkMapper.h
vtkGraphMapper::CircleGlyph
vtkSmartPointer< vtkGlyph3D > CircleGlyph
Definition: vtkGraphMapper.h:294
vtkGraphMapper::SetColorVertices
void SetColorVertices(bool vis)
Whether to color vertices.
vtkGraphMapper::GetEdgeColorArrayName
const char * GetEdgeColorArrayName()
vtkX3D::port
@ port
Definition: vtkX3D.h:447
vtkMapArrayValues
Map values in an input array to different values in an output array of (possibly) different type.
Definition: vtkMapArrayValues.h:49
vtkTexture
handles properties associated with a texture map
Definition: vtkTexture.h:72
vtkGraphMapper::GetInput
vtkGraph * GetInput()
vtkGraphMapper::GetIconArrayName
const char * GetIconArrayName()
vtkGraphMapper::ColorVerticesOn
void ColorVerticesOn()
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:42
vtkGraphMapper::GetVertexColorArrayName
const char * GetVertexColorArrayName()
vtkGraphMapper::SetIconArrayName
void SetIconArrayName(const char *name)
The array to use for assigning icons.
vtkGraphMapper::CircleOutlineGlyph
vtkSmartPointer< vtkGlyph3D > CircleOutlineGlyph
Definition: vtkGraphMapper.h:295
vtkGraphMapper::SetIconVisibility
void SetIconVisibility(bool vis)
Whether to show icons.
vtkGraphMapper
map vtkGraph and derived classes to graphics primitives
Definition: vtkGraphMapper.h:60
vtkGraphMapper::SetEdgeColorArrayName
void SetEdgeColorArrayName(const char *name)
The array to use for coloring edges.
vtkMapper
abstract class specifies interface to map data to graphics primitives
Definition: vtkMapper.h:87
vtkGraphMapper::SetVertexColorArrayName
void SetVertexColorArrayName(const char *name)
The array to use for coloring vertices.
vtkTransformCoordinateSystems
transform points into different coordinate systems
Definition: vtkTransformCoordinateSystems.h:39
vtkGraphMapper::IconGlyph
vtkSmartPointer< vtkIconGlyphFilter > IconGlyph
Definition: vtkGraphMapper.h:299
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:52
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkGraphMapper::ColorEdgesOn
void ColorEdgesOn()
vtkGraphMapper::ColorEdgesOff
void ColorEdgesOff()
vtkGraphMapper::SetIconTexture
void SetIconTexture(vtkTexture *texture)
vtkGraphMapper::GraphToPoly
vtkSmartPointer< vtkGraphToPolyData > GraphToPoly
Definition: vtkGraphMapper.h:297
vtkGraphMapper::VertexActor
vtkSmartPointer< vtkActor > VertexActor
Definition: vtkGraphMapper.h:309
vtkCamera
a virtual camera for 3D rendering
Definition: vtkCamera.h:51
vtkGraphMapper::GetIconSize
int * GetIconSize()
vtkSmartPointer.h
vtkGraphMapper::GetEdgeVisibility
bool GetEdgeVisibility()
vtkX3D::size
@ size
Definition: vtkX3D.h:253
vtkGraphMapper::SetVertexPointSize
void SetVertexPointSize(float size)
vtkGraphMapper::IconMapper
vtkSmartPointer< vtkPolyDataMapper2D > IconMapper
Definition: vtkGraphMapper.h:306
vtkGraphMapper::GetMTime
vtkMTimeType GetMTime() override
Get the mtime also considering the lookup table.
vtkX3D::name
@ name
Definition: vtkX3D.h:219
vtkGarbageCollector
Detect and break reference loops.
Definition: vtkGarbageCollector.h:100
vtkGraphMapper::OutlineMapper
vtkSmartPointer< vtkPolyDataMapper > OutlineMapper
Definition: vtkGraphMapper.h:305
vtkGlyph3D
copy oriented and scaled glyph geometry to every input point
Definition: vtkGlyph3D.h:112
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkLookupTable
map scalar values into colors via a lookup table
Definition: vtkLookupTable.h:75
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkGraphMapper::EnabledVerticesArrayName
char * EnabledVerticesArrayName
Definition: vtkGraphMapper.h:286
vtkGraphMapper::SetIconSize
void SetIconSize(int *size)
Specify the Width and Height, in pixels, of an icon in the icon sheet.
vtkActor2D
a actor that draws 2D data
Definition: vtkActor2D.h:46
vtkGraphMapper::GetIconVisibility
bool GetIconVisibility()
vtkGraphMapper::ColorVerticesOff
void ColorVerticesOff()
vtkGraphMapper::GetIconTexture
vtkTexture * GetIconTexture()
The texture containing the icon sheet.
vtkRenderer
abstract specification for renderers
Definition: vtkRenderer.h:64
vtkGraphMapper::SetColorEdges
void SetColorEdges(bool vis)
Whether to color edges.
vtkGraphMapper::IconTypeToIndex
vtkSmartPointer< vtkMapArrayValues > IconTypeToIndex
Definition: vtkGraphMapper.h:300
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:86
vtkGraphMapper::AddIconType
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...
vtkGraphMapper::VertexLookupTable
vtkLookupTable * VertexLookupTable
Definition: vtkGraphMapper.h:315
vtkGraphMapper::GetColorVertices
bool GetColorVertices()
vtkGraphMapper::VertexColorArrayNameInternal
char * VertexColorArrayNameInternal
Definition: vtkGraphMapper.h:280
vtkGraph
Base class for graph data types.
Definition: vtkGraph.h:288
vtkCellCenters
generate points at center of cells
Definition: vtkCellCenters.h:48
vtkX3D::filled
@ filled
Definition: vtkX3D.h:349
vtkGraphMapper::VertexMapper
vtkSmartPointer< vtkPolyDataMapper > VertexMapper
Definition: vtkGraphMapper.h:304
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkVertexGlyphFilter
Make a vtkPolyData with a vertex on each point.
Definition: vtkVertexGlyphFilter.h:44
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkGraphMapper::EdgeActor
vtkSmartPointer< vtkActor > EdgeActor
Definition: vtkGraphMapper.h:308
vtkGraphMapper::EnabledEdgesArrayName
char * EnabledEdgesArrayName
Definition: vtkGraphMapper.h:285
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:302