Redesign parameters can now be saved and loaded.
3 * This file is a part of LEMON, a generic C++ optimization library
5 * Copyright (C) 2003-2006
6 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 * (Egervary Research Group on Combinatorial Optimization, EGRES).
9 * Permission to use, modify and distribute this software is granted
10 * provided that this copyright notice appears in all copies. For
11 * precise terms see the accompanying LICENSE file.
13 * This software is provided "AS IS" with no warranty of any kind,
14 * express or implied, and with no claim as to its suitability for any
19 #ifndef GRAPH_DISPLAYER_CANVAS_H
20 #define GRAPH_DISPLAYER_CANVAS_H
22 class GraphDisplayerCanvas;
24 #include "all_include.h"
26 #include <libgnomecanvasmm.h>
27 #include <libgnomecanvasmm/polygon.h>
28 #include <lemon/dim2.h>
30 ///This class is the canvas, on which the graph can be drawn.
31 class GraphDisplayerCanvas : public Gnome::Canvas::CanvasAA
33 friend class BrokenEdge;
34 friend class LoopEdge;
36 class EdgeBase : public Gnome::Canvas::Group
39 ///Reference to the canvas, on which the graph is drawn.
41 ///It is needed, because some datas needed from
42 ///graph can be accessed by this or should be sent
43 ///as parameter, but it would be complicated
44 GraphDisplayerCanvas& canvas;
46 ///The edge that the class displays.
48 ///It is needed, because some datas needed from
49 ///graph can be accessed by this or should be sent
50 ///as parameter, but it would be complicated
53 Gnome::Canvas::Polygon arrow;
57 EdgeBase(Gnome::Canvas::Group&, Edge, GraphDisplayerCanvas&);
59 virtual void draw() = 0;
60 virtual void setLineWidth(int) = 0;
61 virtual void setFillColor(Gdk::Color) = 0;
62 virtual Gnome::Canvas::Item * getLine() = 0;
65 ///Edge displayer class
67 ///This class is responsible for displaying edges in graph.
68 ///The displayed edge is broken in the middle. The
69 ///aim of this is to be able to indicate direction of edges
70 ///and to be able to display more then one edges between the
71 ///same source and target
72 class BrokenEdge : public EdgeBase
75 Gnome::Canvas::Line line;
77 ///Indicates whether the button of mouse is pressed or not at the moment.
80 ///At this location was the mousebutton pressed. Horizontal component.
82 ///It helps to calculate the
83 ///distance of dragging.
86 ///At this location was the mousebutton pressed. Vertical component.
88 ///It helps to calculate the
89 ///distance of dragging.
92 ///event handler for forming broken edges
96 bool edgeFormerEventHandler(GdkEvent* event);
99 ///Constructor of broken edge class.
101 ///\param g the group to which the edge belongs
102 ///\param _edge the represented edge
103 ///\param gc the canvas
104 BrokenEdge(Gnome::Canvas::Group&, Edge, GraphDisplayerCanvas&);
106 ///Destructor of broken edge class
112 ///The function that draws the edge based on collected data
115 void setLineWidth(int);
116 void setFillColor(Gdk::Color);
118 Gnome::Canvas::Item * getLine() { return (Gnome::Canvas::Item *)(&line); };
121 class LoopEdge : public EdgeBase
124 Gnome::Canvas::Ellipse line;
125 bool edgeFormerEventHandler(GdkEvent* e);
128 LoopEdge(Gnome::Canvas::Group&, Edge, GraphDisplayerCanvas&);
131 void setLineWidth(int);
132 void setFillColor(Gdk::Color);
133 Gnome::Canvas::Item * getLine() { return (Gnome::Canvas::Item *)(&line); };
136 ///Type of canvas, on which the graph is drawn
137 typedef Gnome::Canvas::CanvasAA Parent;
142 ///\param nbt the tab of the window, in which the graph is displayed
143 GraphDisplayerCanvas(NoteBookTab & nbt);
145 ///destructor of the class
146 virtual ~GraphDisplayerCanvas();
148 ///Changes the width of edge(s) according to the given map.
150 ///\param mapname is the name of the map which contains the values to be set
151 ///\param edge if it is given, only the width of the given edge will be set, instead of all of them.
152 int changeEdgeWidth (std::string mapname, Edge edge=INVALID);
154 ///Resets width of edge(s) to the default value
156 ///\param edge if it is given, only the width of the
157 ///given edge will be reset, instead of all of them.
158 int resetEdgeWidth (Edge edge=INVALID);
160 ///Changes the color of edge(s) according to the given map.
162 ///\param mapname is the name of the map which contains the new values
163 ///\param edge if it is given, only the color of the given edge will be set, instead of all of them.
164 int changeEdgeColor (std::string mapname, Edge edge=INVALID);
166 ///Resets color of edge(s) to the default value
168 ///\param edge if it is given, only the color of the
169 ///given edge will be reset, instead of all of them.
170 int resetEdgeColor (Edge edge=INVALID);
172 ///Changes the label of edge(s) according to the given map.
174 ///\param mapname is the name of the map which contains the new values
175 ///\param edge if it is given, only the label of the given edge will be set, instead of all of them.
176 int changeEdgeText (std::string mapname, Edge edge=INVALID);
178 ///Resets label of edge(s) to the default value
180 ///\param edge if it is given, only the color of the
181 ///given edge will be reset, instead of all of them.
182 int resetEdgeText (Edge edge=INVALID);
184 ///Changes the radius of node(s) according to the given map.
186 ///\param mapname is the name of the map which contains the new values
187 ///\param node if it is given, only the radius of the given node will be set, instead of all of them.
188 int changeNodeRadius (std::string mapname, Node node=INVALID);
190 ///Resets radius of node(s) to the default value
192 ///\param node if it is given, only the radius of the
193 ///given node will be reset, instead of all of them.
194 int resetNodeRadius (Node node=INVALID);
196 ///Changes the color of node(s) according to the given map.
198 ///\param mapname is the name of the map which contains the new values
199 ///\param node if it is given, only the color of the given node will be set, instead of all of them.
200 int changeNodeColor (std::string mapname, Node node=INVALID);
202 ///Resets color of node(s) to the default value
204 ///\param node if it is given, only the color of the
205 ///given node will be reset, instead of all of them.
206 int resetNodeColor (Node node=INVALID);
208 ///Changes the label of node(s) according to the given map.
210 ///\param mapname is the name of the map which contains the new values
211 ///\param node if it is given, only the label of the given node will be set, instead of all of them.
212 int changeNodeText (std::string mapname, Node node=INVALID);
214 ///Resets label of node(s) to the default value
216 ///\param node if it is given, only the label of the
217 ///given node will be reset, instead of all of them.
218 int resetNodeText (Node node=INVALID);
220 ///This function is called, when any of the displayed attributes have to be updated, or changed
222 ///\param itisedge if true, edge property has to be changed, else node property
223 ///\param prop the id of property that has to changed or updated
224 void propertyChange(bool itisedge, int prop);
226 ///updates the given property
228 ///\param edge if it is not INVALID, only the property of the given edge will be updated, instead of all of them
229 ///\param prop the property to update
230 void propertyUpdate(Edge edge, int prop);
232 ///updates the given property
234 ///\param node if it is not INVALID, only the property of the given node will be updated, instead of all of them
235 ///\param prop the property to update
236 void propertyUpdate(Node node, int prop);
238 ///updates all the property for the given edge
239 void propertyUpdate(Edge);
241 ///updates all the property for the given node
242 void propertyUpdate(Node);
244 ///Callback for 'ViewZoomIn' action.
245 virtual void zoomIn();
246 ///Callback for 'ViewZoomOut' action.
247 virtual void zoomOut();
248 ///Callback for 'ViewZoomFit' action.
249 virtual void zoomFit();
250 ///Callback for 'ViewZoom100' action.
251 virtual void zoom100();
252 ///Sets the scroll region of the convas to the bounding box of the graph.
253 void updateScrollRegion();
255 ///This function changes the tool in the graph-editor's hand
256 void changeEditorialTool(int);
260 //maximizing, minimizing, restoring window, etc.
261 virtual bool on_expose_event(GdkEventExpose *);
265 ///This function is responsible for the correct
266 ///reaction of any action happened in the territory
269 bool eventHandler(GdkEvent* e, Node n);
271 ///actual event handler
273 ///Actual event handler should be stored, to be able to disconnect it and later reconnect it.
274 sigc::connection actual_handler;
276 ///event handler for the case when move-tool is active
277 bool moveEventHandler(GdkEvent*);
278 ///event handler for the case when create_node-tool is active
279 bool createNodeEventHandler(GdkEvent*);
280 ///event handler for the case when create_edge-tool is active
281 bool createEdgeEventHandler(GdkEvent*);
282 ///event handler for the case when eraser-tool is active
283 bool eraserEventHandler(GdkEvent*);
284 ///event handler for the case when map editor tool is active
285 bool mapEditEventHandler(GdkEvent*);
288 ///moves node according to the given parameters
289 void moveNode(double, double, Gnome::Canvas::Item * item=NULL, Node node=INVALID);
292 ///Moves the text to new place
293 void textReposition(XY);
295 ///Activates an edge belonging to an EdgeBase
297 ///After we have activated an edge this way,
298 ///the GDC object will know, which edge is under forming
299 ///therefore it can redraw the necessary elements on the canvas,
300 ///for example the text belonging to the \ref EdgeBase can be
301 ///redrawn (\ref textReposition).
302 void toggleEdgeActivity(EdgeBase*, bool);
306 ///Returns the actual tool in hand
309 ///Sets node representation settings
310 void setView(bool, bool, double, double);
312 ///Gets node representation settings
313 void getView(bool &, bool &, double&, double&);
317 ///Called when opening a file.
322 ///It achieves this by deleting all data
323 ///structure used to help handle the displayed graph.
326 ///creates a new Nodemap
328 ///\param init initial value of the map
329 ///\param mapname name of new map
330 int addNewNodeMap(double init,std::string mapname);
331 ///creates a new Edgemap
333 ///\param init initial value of the map
334 ///\param mapname name of new map
335 int addNewEdgeMap(double init,std::string mapname);
337 void reDesignGraph();
339 ///Show whether the graph is already drawn.
343 ///Deletes the given element.
344 void deleteItem(Node);
345 ///Deletes the given element.
346 void deleteItem(Edge);
350 ///Map of nodes of graph
351 Graph::NodeMap<Gnome::Canvas::Ellipse *> nodesmap;
353 ///Map of edges of graph
354 Graph::EdgeMap<EdgeBase*> edgesmap;
356 ///Map of texts to write on edges
357 Graph::EdgeMap<Gnome::Canvas::Text *> edgetextmap;
359 ///Map of texts to write on nodes
360 Graph::NodeMap<Gnome::Canvas::Text *> nodetextmap;
362 ///Group of graphical elements of displayed_graph
363 Gnome::Canvas::Group displayed_graph;
366 ///Indicates whether the button of mouse is pressed or not
369 ///Stores the actual tool in hand
372 ///At this location was the mousebutton pressed.
373 ///It helps to calculate the distance of dragging.
374 double clicked_x, clicked_y;
376 ///Remembers which Gnome::Canvas::Item was pressed.
378 ///this variable is needed, to work on it after selection
379 Gnome::Canvas::Item * active_item;
381 ///Remembers which Gnome::Canvas::Item was pressed.
383 ///this variable is used at edge creation, it will
384 ///be the secondly selected node. No local variable
385 ///can be used for this purpose inside the function,
386 ///because the node selected by button press, and
387 ///the edge is created by button release. Both of
388 ///them is different function call.
389 Gnome::Canvas::Item * target_item;
391 ///selected node (for any editing)
394 ///selected edge (for any editing)
397 ///the edge that is selected by clicking on the red arrow in the middle of it
399 ///This edge is stored only for the purpose of reshape it.
400 ///That is why it is selected in a different manner.
403 ///Map displayed by label can be edited.
404 std::string nodemap_to_edit;
406 ///Map displayed by label can be edited.
407 std::string edgemap_to_edit;
409 static const int zoom_step = 5;
411 ///Is node radius autoscaled
414 ///Should we track zoomfactor changes
417 ///to store the zoom factor when it was "fixed"
418 double fixed_zoom_factor;
426 ///Was redesign run on this graph already?
428 ///If not, the layout will be modified randomly
429 ///to avoid frozen layout because of wrong
435 ///reference to the container, in which the canvas is
438 XY calcArrowPos(XY, XY, XY, XY, int);
441 #endif //GRAPH_DISPLAYER_CANVAS_H