VTK  9.2.5
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 =========================================================================*/
34 #ifndef vtkGraphItem_h
35 #define vtkGraphItem_h
36 
37 #include "vtkContextItem.h"
38 #include "vtkViewsInfovisModule.h" // For export macro
39 
40 #include "vtkColor.h" // For color types in API
41 #include "vtkNew.h" // For vtkNew ivars
42 #include "vtkVector.h" // For vector types in API
43 
44 class vtkGraph;
45 class vtkImageData;
48 class vtkTooltipItem;
49 
50 class VTKVIEWSINFOVIS_EXPORT vtkGraphItem : public vtkContextItem
51 {
52 public:
53  static vtkGraphItem* New();
54  vtkTypeMacro(vtkGraphItem, vtkContextItem);
55  void PrintSelf(ostream& os, vtkIndent indent) override;
56 
58 
61  virtual void SetGraph(vtkGraph* graph);
62  vtkGetObjectMacro(Graph, vtkGraph);
64 
69 
71 
75  virtual void StopLayoutAnimation();
77 
81  virtual void UpdateLayout();
82 
83 protected:
85  ~vtkGraphItem() override;
86 
91  bool Paint(vtkContext2D* painter) override;
92 
98  virtual void RebuildBuffers();
99 
104  virtual void PaintBuffers(vtkContext2D* painter);
105 
114  virtual bool IsDirty();
115 
121 
127 
135 
140  virtual float EdgeWidth(vtkIdType edge, vtkIdType point);
141 
148 
156 
162  virtual float VertexSize(vtkIdType vertex);
163 
169 
176  virtual int VertexMarker(vtkIdType vertex);
177 
184 
190 
194  static void ProcessEvents(
195  vtkObject* caller, unsigned long event, void* clientData, void* callerData);
196 
200  virtual vtkIdType HitVertex(const vtkVector2f& pos);
201 
203 
206  bool MouseMoveEvent(const vtkContextMouseEvent& event) override;
207  bool MouseLeaveEvent(const vtkContextMouseEvent& event) override;
208  bool MouseEnterEvent(const vtkContextMouseEvent& event) override;
209  bool MouseButtonPressEvent(const vtkContextMouseEvent& event) override;
210  bool MouseButtonReleaseEvent(const vtkContextMouseEvent& event) override;
211  bool MouseWheelEvent(const vtkContextMouseEvent& event, int delta) override;
213 
217  bool Hit(const vtkContextMouseEvent& event) override;
218 
222  virtual void PlaceTooltip(vtkIdType v);
223 
224 private:
225  vtkGraphItem(const vtkGraphItem&) = delete;
226  void operator=(const vtkGraphItem&) = delete;
227 
228  struct Internals;
229  Internals* Internal;
230 
231  vtkGraph* Graph;
232  vtkMTimeType GraphBuildTime;
233  vtkNew<vtkImageData> Sprite;
235  vtkNew<vtkTooltipItem> Tooltip;
236 };
237 
238 #endif
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:77
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:51
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.
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.
virtual vtkIncrementalForceLayout * GetLayout()
Exposes the incremental graph layout for updating parameters.
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
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.
static vtkGraphItem * New()
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:345
topologically and geometrically regular array of data
Definition: vtkImageData.h:163
incremental force-directed layout.
a simple class to control print indentation
Definition: vtkIndent.h:119
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:108
takes care of drawing 2D axes
@ point
Definition: vtkX3D.h:242
int vtkIdType
Definition: vtkType.h:332
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287