treecanvas.hh

Go to the documentation of this file.

/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
 *  Main authors:
 *     Guido Tack <tack@gecode.org>
 *
 *  Copyright:
 *     Guido Tack, 2006
 *
 *  This file is part of Gecode, the generic constraint
 *  development environment:
 *     http://www.gecode.org
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */

#ifndef GECODE_GIST_TREECANVAS_HH
#define GECODE_GIST_TREECANVAS_HH

#include <QtGui>
#if QT_VERSION >= 0x050000
#include <QtWidgets>
#endif

#include <gecode/kernel.hh>
#include <gecode/gist.hh>

#include <gecode/gist/visualnode.hh>

namespace Gecode {  namespace Gist {

  namespace LayoutConfig {
    const int minScale = 10;
    const int maxScale = 400;
    const int defScale = 100;
    const int maxAutoZoomScale = defScale;
  }

  class TreeCanvas;

  class SearcherThread : public QThread {
    Q_OBJECT
  private:
    VisualNode* node;
    int depth;
    bool a;
    TreeCanvas* t;
    void updateCanvas(void);
  public:
    void search(VisualNode* n, bool all, TreeCanvas* ti);

  Q_SIGNALS:
    void update(int w, int h, int scale0);
    void statusChanged(bool);
    void scaleChanged(int);
    void solution(const Space*);
    void searchFinished(void);
    void moveToNode(VisualNode* n,bool);
  protected:
    void run(void);
  };

  class GECODE_GIST_EXPORT TreeCanvas : public QWidget {
    Q_OBJECT

    friend class SearcherThread;
    friend class Gist;

  public:
    TreeCanvas(Space* rootSpace, bool bab, QWidget* parent,
               const Options& opt);
    ~TreeCanvas(void);

    void addDoubleClickInspector(Inspector* i);
    void activateDoubleClickInspector(int i, bool active);
    void addSolutionInspector(Inspector* i);
    void activateSolutionInspector(int i, bool active);
    void addMoveInspector(Inspector* i);
    void activateMoveInspector(int i, bool active);
    void addComparator(Comparator* c);
    void activateComparator(int i, bool active);

  public Q_SLOTS:
    void scaleTree(int scale0, int zoomx=-1, int zoomy=-1);

    void searchAll(void);
    void searchOne(void);
    void toggleHidden(void);
    void hideFailed(void);
    void unhideAll(void);
    void toggleStop(void);
    void unstopAll(void);
    void exportPDF(void);
    void exportWholeTreePDF(void);
    void print(void);
    void zoomToFit(void);
    void centerCurrentNode(void);
    void inspectCurrentNode(bool fix=true, int inspectorNo=-1);
    void inspectBeforeFP(void);
    void labelBranches(void);
    void labelPath(void);

    void stopSearch(void);

    void reset(void);

    void navUp(void);
    void navDown(void);
    void navLeft(void);
    void navRight(void);
    void navRoot(void);
    void navNextSol(bool back = false);
    void navPrevSol(void);

    void bookmarkNode(void);
    void setPath(void);
    void inspectPath(void);
    void startCompareNodes(void);
    void startCompareNodesBeforeFP(void);

    void emitStatusChanged(void);

    void setRecompDistances(int c_d, int a_d);
    void setAutoHideFailed(bool b);
    void setAutoZoom(bool b);
    bool getAutoHideFailed(void);
    bool getAutoZoom(void);
    void setShowCopies(bool b);
    bool getShowCopies(void);
    void setRefresh(int i);
    void setRefreshPause(int i);
    bool getSmoothScrollAndZoom(void);
    void setSmoothScrollAndZoom(bool b);
    bool getMoveDuringSearch(void);
    void setMoveDuringSearch(bool b);
    void resizeToOuter(void);

    bool finish(void);

  Q_SIGNALS:
    void scaleChanged(int);
    void autoZoomChanged(bool);
    void contextMenu(QContextMenuEvent*);
    void statusChanged(VisualNode*,const Statistics&, bool);
    void solution(const Space*);
    void searchFinished(void);
    void addedBookmark(const QString& id);
    void removedBookmark(int idx);
  protected:
    QMutex mutex;
    QMutex layoutMutex;
    SearcherThread searcher;
    bool stopSearchFlag;
    bool finishedFlag;
    Node::NodeAllocator* na;
    VisualNode* root;
    BestNode* curBest;
    VisualNode* currentNode;
    VisualNode* pathHead;
    QVector<QPair<Inspector*,bool> > doubleClickInspectors;
    QVector<QPair<Inspector*,bool> > solutionInspectors;
    QVector<QPair<Inspector*,bool> > moveInspectors;
    QVector<QPair<Comparator*,bool> > comparators;

    QVector<VisualNode*> bookmarks;

    bool compareNodes;
    bool compareNodesBeforeFP;

    QSlider* scaleBar;

    Statistics stats;

    double scale;
    int xtrans;

    bool autoHideFailed;
    bool autoZoom;
    bool showCopies;
    int refresh;
    int refreshPause;
    bool smoothScrollAndZoom;
    bool moveDuringSearch;

    int c_d;
    int a_d;

    VisualNode* eventNode(QEvent *event);
    bool event(QEvent *event);
    void paintEvent(QPaintEvent* event);
    void mousePressEvent(QMouseEvent* event);
    void mouseDoubleClickEvent(QMouseEvent* event);
    void contextMenuEvent(QContextMenuEvent* event);
    void resizeEvent(QResizeEvent* event);
    void wheelEvent(QWheelEvent* event);

    QTimeLine zoomTimeLine;
    QTimeLine scrollTimeLine;
    int targetX;
    int sourceX;
    int targetY;
    int sourceY;

    int targetW;
    int targetH;
    int targetScale;
    int layoutDoneTimerId;

    virtual void timerEvent(QTimerEvent* e);

  public Q_SLOTS:
    void update(void);
    void scroll(void);
    void layoutDone(int w, int h, int scale0);
    void setCurrentNode(VisualNode* n, bool finished=true, bool update=true);
  private Q_SLOTS:
    void statusChanged(bool);
    void exportNodePDF(VisualNode* n);
    void inspectSolution(const Space* s);
    void scroll(int i);
  };

}}

#endif

// STATISTICS: gist-any