VTK
vtkGraphItem.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: TestDiagram.cxx
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 "vtkViewsInfovisModule.h" // For export macro
38 #include "vtkContextItem.h"
39 
40 #include "vtkVector.h" // For vector types in API
41 #include "vtkColor.h" // For color types in API
42 #include "vtkNew.h" // For vtkNew ivars
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(vtkObject *caller, unsigned long event,
195  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
vtkGraphItem::New
static vtkGraphItem * New()
vtkGraphItem::VertexPosition
virtual vtkVector2f VertexPosition(vtkIdType vertex)
Returns the position of each vertex.
vtkContextMouseEvent
data structure to represent mouse events.
Definition: vtkContextMouseEvent.h:41
vtkGraphItem::StopLayoutAnimation
virtual void StopLayoutAnimation()
vtkGraphItem::MouseButtonPressEvent
bool MouseButtonPressEvent(const vtkContextMouseEvent &event) override
Mouse button down event Return true if the item holds the event, false if the event can be propagated...
vtkGraphItem::VertexColor
virtual vtkColor4ub VertexColor(vtkIdType vertex)
Returns the color of each vertex.
vtkIncrementalForceLayout
incremental force-directed layout.
Definition: vtkIncrementalForceLayout.h:43
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkGraphItem::MouseMoveEvent
bool MouseMoveEvent(const vtkContextMouseEvent &event) override
Handle mouse events.
vtkGraphItem::vtkGraphItem
vtkGraphItem()
vtkGraphItem::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkGraphItem::MouseButtonReleaseEvent
bool MouseButtonReleaseEvent(const vtkContextMouseEvent &event) override
Mouse button release event.
vtkGraphItem::EdgeWidth
virtual float EdgeWidth(vtkIdType edge, vtkIdType point)
Returns the edge width.
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkVector.h
vtkTooltipItem
takes care of drawing 2D axes
Definition: vtkTooltipItem.h:40
vtkGraphItem::EdgeColor
virtual vtkColor4ub EdgeColor(vtkIdType edge, vtkIdType point)
Returns the edge color.
vtkContext2D
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:59
vtkGraphItem::GetLayout
virtual vtkIncrementalForceLayout * GetLayout()
Exposes the incremental graph layout for updating parameters.
vtkContextItem.h
vtkGraphItem::EdgePosition
virtual vtkVector2f EdgePosition(vtkIdType edge, vtkIdType point)
Returns the edge control point positions.
vtkGraphItem::NumberOfEdgePoints
virtual vtkIdType NumberOfEdgePoints(vtkIdType edge)
Returns the number of edge control points for a particular edge.
vtkGraphItem::PaintBuffers
virtual void PaintBuffers(vtkContext2D *painter)
Efficiently draws the contents of the buffers built in RebuildBuffers.
vtkGraphItem::VertexTooltip
virtual vtkStdString VertexTooltip(vtkIdType vertex)
Returns the tooltip for each vertex.
vtkGraphItem::NumberOfVertices
virtual vtkIdType NumberOfVertices()
Returns the number of vertices in the graph.
vtkX3D::point
@ point
Definition: vtkX3D.h:236
vtkGraphItem::StartLayoutAnimation
virtual void StartLayoutAnimation(vtkRenderWindowInteractor *interactor)
Begins or ends the layout animation.
vtkGraphItem::PlaceTooltip
virtual void PlaceTooltip(vtkIdType v)
Change the position of the tooltip based on the vertex hovered.
vtkGraphItem::ProcessEvents
static void ProcessEvents(vtkObject *caller, unsigned long event, void *clientData, void *callerData)
Process events and dispatch to the appropriate member functions.
vtkGraphItem::Paint
bool Paint(vtkContext2D *painter) override
Paints the graph.
vtkColor.h
vtkGraphItem::HitVertex
virtual vtkIdType HitVertex(const vtkVector2f &pos)
Return index of hit vertex, or -1 if no hit.
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:46
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkGraphItem::SetGraph
virtual void SetGraph(vtkGraph *graph)
The graph that this item draws.
vtkNew< vtkImageData >
vtkGraphItem::NumberOfEdges
virtual vtkIdType NumberOfEdges()
Returns the number of edges in the graph.
vtkRenderWindowInteractor
platform-independent render window interaction including picking and frame rate control.
Definition: vtkRenderWindowInteractor.h:79
vtkGraphItem::RebuildBuffers
virtual void RebuildBuffers()
Builds a cache of data from the graph by calling the virtual functions such as VertexColor(),...
vtkGraphItem::~vtkGraphItem
~vtkGraphItem() override
vtkContextItem
base class for items that are part of a vtkContextScene.
Definition: vtkContextItem.h:35
vtkGraphItem::UpdateLayout
virtual void UpdateLayout()
Incrementally updates the graph layout.
vtkGraphItem::MouseWheelEvent
bool MouseWheelEvent(const vtkContextMouseEvent &event, int delta) override
Mouse wheel event, positive delta indicates forward movement of the wheel.
vtkNew.h
vtkGraphItem::MouseEnterEvent
bool MouseEnterEvent(const vtkContextMouseEvent &event) override
Mouse enter event.
vtkGraphItem::VertexSize
virtual float VertexSize(vtkIdType vertex)
Returns the vertex size in pixels, which is remains the same at any zoom level.
vtkGraphItem::VertexMarker
virtual int VertexMarker(vtkIdType vertex)
Returns the marker type for each vertex, as defined in vtkMarkerUtilities.
vtkColor4ub
Definition: vtkColor.h:241
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:41
vtkGraph
Base class for graph data types.
Definition: vtkGraph.h:288
vtkGraphItem::Hit
bool Hit(const vtkContextMouseEvent &event) override
Whether this graph item is hit.
vtkVector2f
Definition: vtkVector.h:419
vtkGraphItem
A 2D graphics item for rendering a graph.
Definition: vtkGraphItem.h:51
vtkGraphItem::MouseLeaveEvent
bool MouseLeaveEvent(const vtkContextMouseEvent &event) override
Mouse leave event.
vtkGraphItem::IsDirty
virtual bool IsDirty()
Returns true if the underlying vtkGraph has been modified since the last RebuildBuffers,...
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:302