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 -------------------------------------------------------------------------*/
30 #ifndef vtkGraphMapper_h
31 #define vtkGraphMapper_h
32 
33 #include "vtkMapper.h"
34 #include "vtkRenderingCoreModule.h" // For export macro
35 
36 #include "vtkSmartPointer.h" // Required for smart pointer internal ivars.
37 
38 class vtkActor2D;
39 class vtkMapArrayValues;
40 class vtkCamera;
41 class vtkFollower;
42 class vtkGraph;
43 class vtkGlyph3D;
44 class vtkGraphToPolyData;
45 class vtkIconGlyphFilter;
46 class vtkCellCenters;
47 class vtkPolyData;
48 class vtkPolyDataMapper;
50 class vtkLookupTable;
52 class vtkTexture;
53 class vtkTexturedActor2D;
55 
56 class VTKRENDERINGCORE_EXPORT vtkGraphMapper : public vtkMapper
57 {
58 public:
59  static vtkGraphMapper* New();
60  vtkTypeMacro(vtkGraphMapper, vtkMapper);
61  void PrintSelf(ostream& os, vtkIndent indent) override;
62  void Render(vtkRenderer* ren, vtkActor* act) override;
63 
65 
68  void SetVertexColorArrayName(const char* name);
69  const char* GetVertexColorArrayName();
71 
73 
76  void SetColorVertices(bool vis);
77  bool GetColorVertices();
78  void ColorVerticesOn();
79  void ColorVerticesOff();
81 
83 
89  void SetScaledGlyphs(bool arg);
90  vtkGetMacro(ScaledGlyphs, bool);
91  vtkBooleanMacro(ScaledGlyphs, bool);
93 
95 
98  vtkSetStringMacro(ScalingArrayName);
99  vtkGetStringMacro(ScalingArrayName);
101 
103 
106  void SetEdgeVisibility(bool vis);
107  bool GetEdgeVisibility();
108  vtkBooleanMacro(EdgeVisibility, bool);
110 
112 
115  void SetEdgeColorArrayName(const char* name);
116  const char* GetEdgeColorArrayName();
118 
120 
123  void SetColorEdges(bool vis);
124  bool GetColorEdges();
125  void ColorEdgesOn();
126  void ColorEdgesOff();
128 
130 
133  vtkSetStringMacro(EnabledEdgesArrayName);
134  vtkGetStringMacro(EnabledEdgesArrayName);
136 
138 
141  vtkSetMacro(EnableEdgesByArray, vtkTypeBool);
142  vtkGetMacro(EnableEdgesByArray, vtkTypeBool);
143  vtkBooleanMacro(EnableEdgesByArray, vtkTypeBool);
145 
147 
150  vtkSetStringMacro(EnabledVerticesArrayName);
151  vtkGetStringMacro(EnabledVerticesArrayName);
153 
155 
158  vtkSetMacro(EnableVerticesByArray, vtkTypeBool);
159  vtkGetMacro(EnableVerticesByArray, vtkTypeBool);
160  vtkBooleanMacro(EnableVerticesByArray, vtkTypeBool);
162 
164 
167  void SetIconArrayName(const char* name);
168  const char* GetIconArrayName();
170 
176  void AddIconType(const char* type, int index);
177 
181  void ClearIconTypes();
182 
184 
187  void SetIconSize(int* size);
188  int* GetIconSize();
190 
195  void SetIconAlignment(int alignment);
196 
198 
201  vtkTexture* GetIconTexture();
202  void SetIconTexture(vtkTexture* texture);
204 
206 
209  void SetIconVisibility(bool vis);
210  bool GetIconVisibility();
211  vtkBooleanMacro(IconVisibility, bool);
213 
215 
218  vtkGetMacro(VertexPointSize, float);
219  void SetVertexPointSize(float size);
221 
223 
226  vtkGetMacro(EdgeLineWidth, float);
227  void SetEdgeLineWidth(float width);
229 
235  void ReleaseGraphicsResources(vtkWindow*) override;
236 
240  vtkMTimeType GetMTime() override;
241 
243 
246  void SetInputData(vtkGraph* input);
247  vtkGraph* GetInput();
249 
254  double* GetBounds() VTK_SIZEHINT(6) override;
255  void GetBounds(double* bounds) override { Superclass::GetBounds(bounds); }
256 
258 
261  vtkGetObjectMacro(EdgeLookupTable, vtkLookupTable);
262  vtkGetObjectMacro(VertexLookupTable, vtkLookupTable);
264 
265 protected:
266  vtkGraphMapper();
267  ~vtkGraphMapper() override;
268 
270 
273  vtkGetStringMacro(VertexColorArrayNameInternal);
274  vtkSetStringMacro(VertexColorArrayNameInternal);
275  vtkGetStringMacro(EdgeColorArrayNameInternal);
276  vtkSetStringMacro(EdgeColorArrayNameInternal);
280 
285 
286  vtkGetStringMacro(IconArrayNameInternal);
287  vtkSetStringMacro(IconArrayNameInternal);
288  char* IconArrayNameInternal;
289 
292 
298 
303 
308 
309  // Color maps
312 
313  void ReportReferences(vtkGarbageCollector*) override;
314 
315  // see algorithm for more info
316  int FillInputPortInformation(int port, vtkInformation* info) override;
317 
318 private:
319  vtkGraphMapper(const vtkGraphMapper&) = delete;
320  void operator=(const vtkGraphMapper&) = delete;
321 
322  // Helper function
323  vtkPolyData* CreateCircle(bool filled);
324 
325  float VertexPointSize;
326  float EdgeLineWidth;
327  bool ScaledGlyphs;
328  char* ScalingArrayName;
329 };
330 
331 #endif
vtkPolyDataMapper
map vtkPolyData to graphics primitives
Definition: vtkPolyDataMapper.h:36
vtkGraphToPolyData
convert a vtkGraph to vtkPolyData
Definition: vtkGraphToPolyData.h:41
vtkGraphMapper::EnableEdgesByArray
vtkTypeBool EnableEdgesByArray
Definition: vtkGraphMapper.h:283
vtkMapper::GetMTime
vtkMTimeType GetMTime() override
Overload standard modified time function.
vtkFollower
a subclass of actor that always faces the camera
Definition: vtkFollower.h:40
vtkGraphMapper::OutlineActor
vtkSmartPointer< vtkActor > OutlineActor
Definition: vtkGraphMapper.h:306
vtkMapper::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkPolyDataMapper2D
draw vtkPolyData onto the image plane
Definition: vtkPolyDataMapper2D.h:44
vtkGraphMapper::VertexGlyph
vtkSmartPointer< vtkVertexGlyphFilter > VertexGlyph
Definition: vtkGraphMapper.h:294
vtkAbstractMapper3D::GetBounds
virtual double * GetBounds()=0
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
vtkGraphMapper::EdgeLookupTable
vtkLookupTable * EdgeLookupTable
Definition: vtkGraphMapper.h:310
vtkTexturedActor2D
actor that draws 2D data with texture support
Definition: vtkTexturedActor2D.h:38
vtkX3D::type
Definition: vtkX3D.h:522
vtkGraphMapper::IconActor
vtkSmartPointer< vtkTexturedActor2D > IconActor
Definition: vtkGraphMapper.h:307
vtkAlgorithm::FillInputPortInformation
virtual int FillInputPortInformation(int port, vtkInformation *info)
Fill the input port information objects for this algorithm.
vtkGraphMapper::IconTransform
vtkSmartPointer< vtkTransformCoordinateSystems > IconTransform
Definition: vtkGraphMapper.h:297
vtkSmartPointer< vtkGlyph3D >
vtkGraphMapper::EnableVerticesByArray
vtkTypeBool EnableVerticesByArray
Definition: vtkGraphMapper.h:284
vtkGraphMapper::IconArrayNameInternal
char * IconArrayNameInternal
Definition: vtkGraphMapper.h:287
vtkGraphMapper::EdgeColorArrayNameInternal
char * EdgeColorArrayNameInternal
Definition: vtkGraphMapper.h:278
vtkIconGlyphFilter
Filter that generates a polydata consisting of quads with texture coordinates referring to a set of i...
Definition: vtkIconGlyphFilter.h:58
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:34
vtkGraphMapper::EdgeMapper
vtkSmartPointer< vtkPolyDataMapper > EdgeMapper
Definition: vtkGraphMapper.h:299
vtkMapper.h
vtkGraphMapper::CircleGlyph
vtkSmartPointer< vtkGlyph3D > CircleGlyph
Definition: vtkGraphMapper.h:290
vtkX3D::port
Definition: vtkX3D.h:453
vtkMapper::Render
virtual void Render(vtkRenderer *ren, vtkActor *a)=0
Method initiates the mapping process.
vtkMapArrayValues
Map values in an input array to different values in an output array of (possibly) different type.
Definition: vtkMapArrayValues.h:48
vtkTexture
handles properties associated with a texture map
Definition: vtkTexture.h:65
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:45
vtkGraphMapper::CircleOutlineGlyph
vtkSmartPointer< vtkGlyph3D > CircleOutlineGlyph
Definition: vtkGraphMapper.h:291
vtkGraphMapper
map vtkGraph and derived classes to graphics primitives
Definition: vtkGraphMapper.h:56
vtkMapper
abstract class specifies interface to map data to graphics primitives
Definition: vtkMapper.h:80
vtkTransformCoordinateSystems
transform points into different coordinate systems
Definition: vtkTransformCoordinateSystems.h:35
vtkGraphMapper::IconGlyph
vtkSmartPointer< vtkIconGlyphFilter > IconGlyph
Definition: vtkGraphMapper.h:295
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:45
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkGraphMapper::GraphToPoly
vtkSmartPointer< vtkGraphToPolyData > GraphToPoly
Definition: vtkGraphMapper.h:293
vtkGraphMapper::VertexActor
vtkSmartPointer< vtkActor > VertexActor
Definition: vtkGraphMapper.h:305
vtkCamera
a virtual camera for 3D rendering
Definition: vtkCamera.h:45
vtkSmartPointer.h
vtkX3D::size
Definition: vtkX3D.h:259
vtkGraphMapper::IconMapper
vtkSmartPointer< vtkPolyDataMapper2D > IconMapper
Definition: vtkGraphMapper.h:302
vtkMapper::GetInput
vtkDataSet * GetInput()
Get the input as a vtkDataSet.
vtkX3D::name
Definition: vtkX3D.h:225
vtkMapper::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this mapper.
Definition: vtkMapper.h:108
vtkGarbageCollector
Detect and break reference loops.
Definition: vtkGarbageCollector.h:94
vtkGraphMapper::OutlineMapper
vtkSmartPointer< vtkPolyDataMapper > OutlineMapper
Definition: vtkGraphMapper.h:301
vtkGlyph3D
copy oriented and scaled glyph geometry to every input point
Definition: vtkGlyph3D.h:105
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:64
vtkMapper::GetBounds
double * GetBounds() override
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
vtkLookupTable
map scalar values into colors via a lookup table
Definition: vtkLookupTable.h:68
vtkX3D::info
Definition: vtkX3D.h:382
vtkAlgorithm::New
static vtkAlgorithm * New()
vtkGraphMapper::EnabledVerticesArrayName
char * EnabledVerticesArrayName
Definition: vtkGraphMapper.h:282
vtkAlgorithm::ReportReferences
void ReportReferences(vtkGarbageCollector *) override
vtkActor2D
a actor that draws 2D data
Definition: vtkActor2D.h:39
vtkRenderer
abstract specification for renderers
Definition: vtkRenderer.h:58
vtkGraphMapper::IconTypeToIndex
vtkSmartPointer< vtkMapArrayValues > IconTypeToIndex
Definition: vtkGraphMapper.h:296
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:84
vtkGraphMapper::VertexLookupTable
vtkLookupTable * VertexLookupTable
Definition: vtkGraphMapper.h:311
vtkGraphMapper::VertexColorArrayNameInternal
char * VertexColorArrayNameInternal
Definition: vtkGraphMapper.h:276
vtkGraph
Base class for graph data types.
Definition: vtkGraph.h:289
vtkCellCenters
generate points at center of cells
Definition: vtkCellCenters.h:47
vtkX3D::filled
Definition: vtkX3D.h:355
vtkGraphMapper::VertexMapper
vtkSmartPointer< vtkPolyDataMapper > VertexMapper
Definition: vtkGraphMapper.h:300
vtkX3D::index
Definition: vtkX3D.h:252
vtkVertexGlyphFilter
Make a vtkPolyData with a vertex on each point.
Definition: vtkVertexGlyphFilter.h:40
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkGraphMapper::EdgeActor
vtkSmartPointer< vtkActor > EdgeActor
Definition: vtkGraphMapper.h:304
vtkGraphMapper::EnabledEdgesArrayName
char * EnabledEdgesArrayName
Definition: vtkGraphMapper.h:281
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:298