VTK  9.1.0
vtkGraphItem.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkGraphItem.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=========================================================================*/
28#ifndef vtkGraphItem_h
29#define vtkGraphItem_h
30
31#include "vtkContextItem.h"
32#include "vtkViewsInfovisModule.h" // For export macro
33
34#include "vtkColor.h" // For color types in API
35#include "vtkNew.h" // For vtkNew ivars
36#include "vtkVector.h" // For vector types in API
37
38class vtkGraph;
39class vtkImageData;
42class vtkTooltipItem;
43
44class VTKVIEWSINFOVIS_EXPORT vtkGraphItem : public vtkContextItem
45{
46public:
47 static vtkGraphItem* New();
49 void PrintSelf(ostream& os, vtkIndent indent) override;
50
52
55 virtual void SetGraph(vtkGraph* graph);
56 vtkGetObjectMacro(Graph, vtkGraph);
58
63
65
69 virtual void StopLayoutAnimation();
71
75 virtual void UpdateLayout();
76
77protected:
79 ~vtkGraphItem() override;
80
85 bool Paint(vtkContext2D* painter) override;
86
92 virtual void RebuildBuffers();
93
98 virtual void PaintBuffers(vtkContext2D* painter);
99
108 virtual bool IsDirty();
109
115
121
129
134 virtual float EdgeWidth(vtkIdType edge, vtkIdType point);
135
142
150
156 virtual float VertexSize(vtkIdType vertex);
157
163
170 virtual int VertexMarker(vtkIdType vertex);
171
178
184
188 static void ProcessEvents(
189 vtkObject* caller, unsigned long event, void* clientData, void* callerData);
190
194 virtual vtkIdType HitVertex(const vtkVector2f& pos);
195
197
200 bool MouseMoveEvent(const vtkContextMouseEvent& event) override;
201 bool MouseLeaveEvent(const vtkContextMouseEvent& event) override;
202 bool MouseEnterEvent(const vtkContextMouseEvent& event) override;
203 bool MouseButtonPressEvent(const vtkContextMouseEvent& event) override;
205 bool MouseWheelEvent(const vtkContextMouseEvent& event, int delta) override;
207
211 bool Hit(const vtkContextMouseEvent& event) override;
212
216 virtual void PlaceTooltip(vtkIdType v);
217
218private:
219 vtkGraphItem(const vtkGraphItem&) = delete;
220 void operator=(const vtkGraphItem&) = delete;
221
222 struct Internals;
223 Internals* Internal;
224
225 vtkGraph* Graph;
226 vtkMTimeType GraphBuildTime;
230};
231
232#endif
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:73
base class for items that are part of a vtkContextScene.
data structure to represent mouse events.
A 2D graphics item for rendering a graph.
Definition: vtkGraphItem.h:45
virtual void RebuildBuffers()
Builds a cache of data from the graph by calling the virtual functions such as VertexColor(),...
virtual void PlaceTooltip(vtkIdType v)
Change the position of the tooltip based on the vertex hovered.
virtual void UpdateLayout()
Incrementally updates the graph layout.
static vtkGraphItem * New()
virtual vtkIdType HitVertex(const vtkVector2f &pos)
Return index of hit vertex, or -1 if no hit.
bool MouseLeaveEvent(const vtkContextMouseEvent &event) override
Handle mouse events.
virtual vtkIdType NumberOfEdges()
Returns the number of edges in the graph.
virtual float EdgeWidth(vtkIdType edge, vtkIdType point)
Returns the edge width.
virtual void SetGraph(vtkGraph *graph)
The graph that this item draws.
virtual void StopLayoutAnimation()
Begins or ends the layout animation.
bool MouseButtonPressEvent(const vtkContextMouseEvent &event) override
Handle mouse events.
bool Hit(const vtkContextMouseEvent &event) override
Whether this graph item is hit.
virtual vtkColor4ub EdgeColor(vtkIdType edge, vtkIdType point)
Returns the edge color.
virtual float VertexSize(vtkIdType vertex)
Returns the vertex size in pixels, which is remains the same at any zoom level.
static void ProcessEvents(vtkObject *caller, unsigned long event, void *clientData, void *callerData)
Process events and dispatch to the appropriate member functions.
virtual void StartLayoutAnimation(vtkRenderWindowInteractor *interactor)
Begins or ends the layout animation.
~vtkGraphItem() override
virtual vtkIncrementalForceLayout * GetLayout()
Exposes the incremental graph layout for updating parameters.
bool MouseWheelEvent(const vtkContextMouseEvent &event, int delta) override
Handle mouse events.
virtual vtkIdType NumberOfVertices()
Returns the number of vertices in the graph.
virtual void PaintBuffers(vtkContext2D *painter)
Efficiently draws the contents of the buffers built in RebuildBuffers.
virtual bool IsDirty()
Returns true if the underlying vtkGraph has been modified since the last RebuildBuffers,...
virtual vtkIdType NumberOfEdgePoints(vtkIdType edge)
Returns the number of edge control points for a particular edge.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual int VertexMarker(vtkIdType vertex)
Returns the marker type for each vertex, as defined in vtkMarkerUtilities.
bool MouseMoveEvent(const vtkContextMouseEvent &event) override
Handle mouse events.
virtual vtkVector2f EdgePosition(vtkIdType edge, vtkIdType point)
Returns the edge control point positions.
virtual vtkStdString VertexTooltip(vtkIdType vertex)
Returns the tooltip for each vertex.
bool MouseButtonReleaseEvent(const vtkContextMouseEvent &event) override
Handle mouse events.
virtual vtkVector2f VertexPosition(vtkIdType vertex)
Returns the position of each vertex.
bool Paint(vtkContext2D *painter) override
Paints the graph.
bool MouseEnterEvent(const vtkContextMouseEvent &event) override
Handle mouse events.
virtual vtkColor4ub VertexColor(vtkIdType vertex)
Returns the color of each vertex.
Base class for graph data types.
Definition: vtkGraph.h:339
topologically and geometrically regular array of data
Definition: vtkImageData.h:157
incremental force-directed layout.
a simple class to control print indentation
Definition: vtkIndent.h:113
Allocate and hold a VTK object.
Definition: vtkNew.h:165
abstract base class for most VTK objects
Definition: vtkObject.h:82
platform-independent render window interaction including picking and frame rate control.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:105
takes care of drawing 2D axes
int vtkIdType
Definition: vtkType.h:332
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287