1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
|
/**
* @file: graph_view.h
* Graph View class definition.
* @defgroup GUIGraph Graph Visualization System
* @ingroup GUI
*/
/* GUI for ShowGraph tool.
* Copyright (c) 2009, Boris Shurygin
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @page iface Graph editor interface
* Graph editor.
*
* Here's list of conventional editing tasks and how they are performed with Showgraph
* -# Create new node - double click on free space
* -# Create edge - draw edge holding down right mouse button
* -# Delete node/edge - use delete option from context menu
* -# Enter text in node - double click on node to enable its text editor
* -# Move node - press left mouse button on it and drag
* -# Create edge control point - double click on edge
* -# Zoom view - press '-' and '+' or use mouse wheel
* -# Invoke auto layout - select 'Run Layout' from View menu or simply press F5
*/
#ifndef GRAPH_VIEW_H
#define GRAPH_VIEW_H
#include "gview_impl.h"
/**
* Navigation event types
* @ingroup GUIGraph
*/
enum NavEventType
{
/** Focus on node event */
NAV_EVENT_NODE_FOCUS,
/** Number of event types */
NAV_EVENT_TYPES_NUM
};
/**
* Navigation event
* @ingroup GUIGraph
*/
class NavEvent
{
/** data associated with event */
union NavEventData
{
/** Node */
GNode *node;
};
NavEventType type;
NavEventData data;
public:
/** Constructor from type only */
inline NavEvent( NavEventType t): type( t)
{
data.node = NULL;
}
/** Constructor from type and node */
inline NavEvent( NavEventType t, GNode *n): type( t)
{
data.node = n;
}
/** Get associated node */
inline GNode *node() const
{
return data.node;
}
/** Set node */
inline void setNode( GNode *n)
{
data.node = n;
}
/** Check if event is a focus on node */
bool isFocus() const
{
return type == NAV_EVENT_NODE_FOCUS;
}
};
/**
* History of graph view navigation
* @ingroup GUIGraph
*/
class GraphViewHistory
{
QList< NavEvent *> events; // List of events
QList< NavEvent *>::Iterator it; // Iterator to hold current position in list
public:
/** Constructor */
GraphViewHistory(): events()
{
it = events.end();
};
/** Destructor */
~GraphViewHistory()
{
foreach ( NavEvent *ev, events)
{
delete ev;
}
}
/** Get last event */
NavEvent *last();
/** Get prev event */
NavEvent *prev();
/** Get next event */
NavEvent *next();
/** New event */
void viewEvent( NavEventType t, GNode *n = NULL);
/** New focus event */
inline void focusEvent( GNode *n)
{
assertd( isNotNullP( n));
viewEvent( NAV_EVENT_NODE_FOCUS, n);
}
/** Erase node from history */
void eraseNode( GNode *n);
};
/**
* Graph for graphics. Graph model layer of GraphView.
* @ingroup GUIGraph
*/
class GGraph: public AuxGraph
{
GraphView *view_p;
protected:
Marker nodeTextIsShown;
QList< GNode* > sel_nodes;
QList< GEdge* > sel_edges;
QHash< QString, GStyle *> styles;
NodeNav node_in_focus;// Node in focus + navigation sector
/** Node creation reimplementaiton */
virtual Node * createNode( int _id)
{
GNode* node_p = new ( node_pool) GNode( this, _id);
return node_p;
}
/** Edge creation reimplementation */
virtual Edge * createEdge( int _id, Node *_pred, Node* _succ)
{
return new ( edge_pool) GEdge( this, _id,
static_cast<GNode *>( _pred),
static_cast<GNode *>( _succ));
}
public:
/** Constructor */
inline GGraph( GraphView *v, bool create_pools):
AuxGraph( false),
view_p( v),
node_in_focus( NULL, UNDEF_SECTOR)
{
nodeTextIsShown = newMarker();
/** Pools' creation routine */
if ( create_pools)
{
node_pool = new FixedPool< GNode>();
edge_pool = new FixedPool< GEdge>();
}
}
/** Destructor */
virtual ~GGraph();
/** New graphical node */
virtual GNode* newNode();
/** New graphical node */
virtual GNode* newNode( QDomElement e);
/** New graphical edge */
virtual GEdge* newEdge( GNode* pred, GNode* succ);
/** New graphical edge */
virtual GEdge* newEdge( GNode* pred, GNode* succ, QDomElement e);
/** Reimplementation of newEdge virtual function of base class */
AuxEdge* newEdge( AuxNode * pred, AuxNode *succ)
{
return ( AuxEdge*)newEdge( static_cast< GNode *>( pred),
static_cast< GNode *> (succ));
}
/** Reimplementation of newEdge virtual function of base class */
AuxEdge* newEdge( AuxNode * pred, AuxNode *succ, QDomElement e)
{
return ( AuxEdge*)newEdge( static_cast< GNode *>( pred),
static_cast< GNode *> (succ), e);
}
/** Get graph's first edge */
inline GEdge* firstEdge()
{
return static_cast< GEdge *>( AuxGraph::firstEdge());
}
/** Get graph's first node */
inline GNode* firstNode()
{
return static_cast< GNode *>( AuxGraph::firstNode());
}
/**
* Run layout procedure
*/
void doLayout();
/**
* Run layout procedure in single thread mode
*/
void doLayoutSingle();
/**
* Assign placement coordinates to node items
*/
void UpdatePlacement();
/**
* Reimplementation of layout's post processing step
*/
void layoutPostProcess();
/** Get corresponding graph view widget */
inline GraphView *view() const
{
return view_p;
}
void showNodesText();
/**
* Add node to selection
*/
inline void selectNode( GNode *n)
{
sel_nodes << n;
}
/** Get node in focus */
inline GNode* nodeInFocus() const
{
return node_in_focus.node();
}
/** Get current navigation sector */
inline NavSector nodeNavigationSector() const
{
return node_in_focus.sector();
}
/** Set node in focus */
inline void setNodeInFocus( GNode *n, NavSector sector = UNDEF_SECTOR)
{
node_in_focus = NodeNav( n, sector);
}
void selectOneNode(GNode *n);
/**
* Clear list of selected nodes
*/
inline void emptySelection()
{
foreach (GNode *n, sel_nodes)
{
n->item()->toRegular();
n->item()->update();
}
sel_nodes.clear();
sel_edges.clear();
}
/**
* Add node to selection
*/
inline void selectEdge( GEdge *e)
{
sel_edges << e;
}
/**
* Delete scheduled nodes
*/
void deleteNodes();
/** Delete edge with all of the edge controls on it */
void deleteEdgeWithControls( GEdge *e);
/**
* Delete scheduled edges
*/
void deleteEdges();
/**
* Create self edge on selected node
*/
void createSelfEdge();
/**
* Create label on selected edge
*/
void createEdgeLabel( QPointF pos);
/**
* Create label on selected edge
*/
void findContext();
/**
* Make all nodes of graph visible and eligible for placement
*/
void showWholeGraph();
/**
* Zero nodes' priorities
*/
void clearNodesPriority();
/**
* Show predecessor of selected edge
*/
void showEdgePred();
/**
* Show successor of selected edge
*/
void showEdgeSucc();
/**
* Save graph as an XML file
*/
virtual void writeToXML( QString filename);
/**
* Build graph from XML description
*/
virtual void readFromXML( QString filename);
/**
* Show style editor for selected nodes
*/
void showEditNodeStyle();
/**
* Change node's style
*/
void setNodeStyle( GStyle *style);
/**
* Show style editor for selected edges
*/
void showEditEdgeStyle();
/**
* Change edge's style
*/
void setEdgeStyle( GStyle *style);
/**
* Add a style
*/
void addStyle( QString &name, GStyle *style)
{
styles[ name] = style;
}
};
/**
* View mode types
*/
enum GraphViewMode
{
/** Whole graph view mode */
WHOLE_GRAPH_VIEW,
/** Context view mode */
CONTEXT_VIEW,
/** Number of view modes for graph */
GRAPH_VIEW_MODES_NUM
};
/**
* Graph visualization class
*/
class GraphView: public QGraphicsView
{
Q_OBJECT; /** For MOC */
private:
/** Pointer to model graph */
GGraph * graph_p;
/** History of view events */
GraphViewHistory *view_history;
/** View mode */
GraphViewMode view_mode;
/** Item for showing future edge during the edge creation process */
EdgeHelper *helper;
/** Edition enabled/disabled */
bool editable;
/** Deleted items lists */
QList< NodeItem* > del_node_items;
QList< EdgeItem* > del_edge_items;
/** Actions */
QAction *editableSwitchAct;
QAction *insertNodeAct;
QAction *runLayoutAct;
QAction *deleteItemAct;
QAction *createSelfEdgeAct;
QAction *createEdgeLabelAct;
QAction *showPredAct;
QAction *showSuccAct;
QAction *findContextAct;
QAction *showEditNodeStyleAct;
QAction *showEditEdgeStyleAct;
QAction *showTextAct;
/** Context menus */
QMenu *nodeItemMenu;
QMenu *edgeItemMenu;
/** Temporary data */
int timer_id;
int node_animation_timer;
QPointF curr_pos;
bool createEdge;
bool show_menus;
bool smooth_focus;
bool smooth_layout_adjustment;
bool zoom_out_done;
GNode *tmpSrc;
GNode *search_node;
qreal zoom_scale;
qreal preferred_zoom;
protected:
void createActions();
void createMenus();
signals:
/** Signal that node is clicked */
void nodeClicked( GNode *n);
public:
/**
* @brief Stores temporary info used for saving old style and node/edge being edited.
* When showing style edit dialog we need to remember old state and the object
* that is being edited. The StyleEditInfo structure is used for these purposes.
*/
struct StyleEditInfo
{
GEdge* edge;
GNode* node;
GStyle *old_style;
GStyle *new_style;
StyleEdit* dialog;
StyleEditInfo( GEdge* e, GStyle *olds, GStyle *news, StyleEdit* d):
edge( e), node(NULL), old_style(olds), new_style( news), dialog( d)
{}
StyleEditInfo( GNode* n, GStyle *olds, GStyle *news, StyleEdit* d):
edge( NULL), node(n), old_style(olds), new_style( news), dialog( d)
{}
};
protected:
/** Temporary info for style edition */
StyleEditInfo *style_edit_info;
public slots:
/** Navigate backward */
void navPrev();
/** Navigate forward */
void navNext();
/** Clear search node */
void clearSearch();
/** Delete one item */
void deleteSelected();
/** create self edge on selected node */
void createSESelected();
/** Create edge label */
void createEdgeLabel();
/** Show edge predecessor */
void showEdgePred();
/** Show edge successor */
void showEdgeSucc();
/** Find node's context */
void findContext();
/** Toggle smooth focusing mode ( moving viewport to show user how to get from one node to anoter) */
void toggleSmoothFocus( bool smooth);
/** Toggle view mode */
void toggleViewMode( bool context);
/** Show text of the clicked node */
void showSelectedNodesText();
/** Enable/disable edition */
void toggleEdition( bool e);
/** Insert node in center of view */
void insertNodeOnCenter();
/** Show style editor for node */
void showEditNodeStyle();
/** Show style editor for edge */
void showEditEdgeStyle();
/** Run layout */
void runLayout();
/** Change node's style */
void setNodeStyle( GStyle *style);
/** Change edge's style */
void setEdgeStyle( GStyle *style);
/** Style edit finished */
void styleEditFinished( int result);
public:
QProgressDialog *dialog;
/** Constants */
#ifdef _DEBUG
static const int MAX_DELETED_ITEMS_COUNT = 100;
#else
static const int MAX_DELETED_ITEMS_COUNT = 10000;
#endif
/** Constructor */
GraphView();
/** Destructor */
virtual ~GraphView();
/** Get action for toggling edit mode */
inline QAction* toggleEditableAction() const
{
return editableSwitchAct;
}
/** Return true if graph enabled for edition */
inline bool isEditable() const
{
return editable;
}
/** Return true if graph enabled for edition */
inline void setEditable( bool val = true)
{
editable = val;
}
/** Return true if smooth focus is enabled */
inline bool hasSmoothFocus() const
{
return smooth_focus;
}
/** Return true if view operates in context mode */
inline bool isContext() const
{
return view_mode == CONTEXT_VIEW;
}
/** Return saved position */
inline QPointF currPos() const
{
return curr_pos;
}
/** Set current event position */
inline void setCurrPos( QPointF p)
{
curr_pos = p;
}
/** Get view history */
inline GraphViewHistory * viewHistory() const
{
return view_history;
}
/** Get current search point */
inline GNode * searchNode() const
{
return search_node;
}
/** Show text of the clicked node */
inline void showNodeText( GNode * n)
{
emit nodeClicked( n);
}
/** Set model graph */
inline void setGraph( GGraph *g)
{
graph_p = g;
}
/** Get pointer to model graph */
inline GGraph *graph() const
{
return graph_p;
}
/** Get context menu for nodes */
inline QMenu *nodeMenu() const
{
return nodeItemMenu;
}
/** Get context menu for edges */
inline QMenu *edgeMenu() const
{
return edgeItemMenu;
}
/** Create menu for particular node */
virtual QMenu* createMenuForNode( GNode *n);
/** Create menu for particular edge */
virtual QMenu* createMenuForEdge( GEdge *e);
void dragEnterEvent( QDragEnterEvent *event);
void dropEvent( QDropEvent *event);
void dragMoveEvent( QDragMoveEvent *event);
/** draw background reimplementation */
void drawBackground( QPainter *painter, const QRectF &rect);
/** Mouse double click event handler reimplementation */
void mouseDoubleClickEvent( QMouseEvent *event);
/** Mouse press event handler reimplementation */
void mousePressEvent( QMouseEvent *event);
/** Mouse move event handler reimplementation */
void mouseMoveEvent( QMouseEvent *event);
/** Mouse release event handler reimplementation */
void mouseReleaseEvent( QMouseEvent *event);
/** Context menu event handler */
void contextMenuEvent( QContextMenuEvent * e );
/** Keypress event handler reimplementation */
void keyPressEvent( QKeyEvent *event);
/** Mouse wheel event handler reimplementation */
void wheelEvent( QWheelEvent *event);
/** Zoom the view in */
void zoomIn();
/** Zoom the view out */
void zoomOut();
/** Restore original zoom */
void zoomOrig();
/** Do the transofrmation( scale) */
void updateMatrix();
/** Focus on node */
void focusOnNode( GNode *n, bool gen_event);
/** Start animation for nodes */
void startAnimationNodes();
/** Advance view in animated focusing procedure */
void advanceView();
/** Advance nodes in animation sequence */
void advanceNodes();
/** Replay navigation event */
void replayNavigationEvent( NavEvent *event);
/** Check if we are in the process of the edge creation */
inline bool isCreateEdge() const
{
return createEdge;
}
/** Check if we are in the process of the edge creation */
inline bool isShowContextMenus() const
{
return show_menus;
}
/** Set the state of ege creation */
inline void SetCreateEdge( bool val)
{
createEdge = val;
}
/** Save the pointer to source node for new edge */
inline void SetTmpSrc( GNode* node)
{
tmpSrc = node;
helper->setSrc( node->item());
helper->setDst( NULL);
helper->adjust();
}
/** Show edge helper item */
inline void showHelper()
{
helper->adjust();
helper->show();
}
/** Get the pointer to source node of new edge */
inline GNode* GetTmpSrc()
{
return tmpSrc;
}
/**
* Schedule node item for deletion
*/
void deleteLaterNodeItem( NodeItem *item)
{
del_node_items << item;
checkDelItems();
}
/**
* Schedule edge item for deletion
*/
void deleteLaterEdgeItem( EdgeItem *item)
{
del_edge_items << item;
checkDelItems();
}
/** Timer event handler */
void timerEvent(QTimerEvent *event);
/**
* Delete items that have been disconnected from scene
*/
void deleteItems();
/**
* Find node by its ID from dump
*/
GNode* findNodeById( int id);
/**
* Find node by its label
*/
GNode* findNodeByLabel( QString label);
/**
* Find next node with matching text
*/
GNode *findNextNodeWithText( QString &findStr, QTextDocument::FindFlags flags);
/**
* Find prev node with matching text
*/
GNode *findPrevNodeWithText( QString &findStr, QTextDocument::FindFlags flags);
/**
* Check that we haven't exceeded the max amount of deleted items
*/
inline void checkDelItems()
{
int item_count = del_node_items.count() + del_edge_items.count();
if ( item_count >= MAX_DELETED_ITEMS_COUNT)
{
/** deleteItems(); !!! FIXME: MEMORY LEACKAGE( yes, not potential... known leakage) */
}
}
/** Set the pointer to style edition temporary info */
inline void setStyleEditInfo( StyleEditInfo* info)
{
style_edit_info = info;
}
};
#endif
|