VisualizationTool.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#include <QtGui/QIcon>

#include <visualization/Visualization.h>


#ifndef _MIRA_VISUALIZATIONTOOL_H_
#define _MIRA_VISUALIZATIONTOOL_H_

namespace mira {


class MIRA_GUI_VISUALIZATION_EXPORT VisualizationTool
    : public Object, public IAuthorityProvider, public Authority
{
    MIRA_ABSTRACT_OBJECT(VisualizationTool)
public:

    VisualizationTool();
    virtual ~VisualizationTool() {};

public:

    template <typename Reflector>
    void reflect(Reflector& r)
    {
        r.itemName(this->getClass().getMetaInfo("Name"));
    }

public:

    virtual void init(IVisualizationSite* site);

    virtual IVisualizationSite* getSite() = 0;

public:

    virtual QIcon getIcon() = 0;


    virtual int getDisplaceShortCut() const { return 0; }



public:

    virtual void activate() {}

    virtual void deactivate() {}

public:

    virtual void processUpdate(Duration dt) { update(dt); }

protected:
    virtual void update(Duration dt) {
        onUpdate(dt);       // Only for backward compatibility
    }

    virtual void onUpdate(Duration dt) {}

public:

    virtual void onMousePressed(QMouseEvent* e) {}
    virtual void onMousePressed(QMouseEvent* e, float devicePixelRatio) { onMousePressed(e); }
    virtual void onMouseReleased(QMouseEvent* e) {}
    virtual void onMouseReleased(QMouseEvent* e, float devicePixelRatio) { onMouseReleased(e); }
    virtual void onMouseDoubleClick(QMouseEvent* e) {}
    virtual void onMouseDoubleClick(QMouseEvent* e, float devicePixelRatio) { onMouseDoubleClick(e); }
    virtual void onMouseMoved(QMouseEvent* e) {}
    virtual void onMouseMoved(QMouseEvent* e, float devicePixelRatio) { onMouseMoved(e); }
    virtual void onMouseWheel(QWheelEvent * e) {}
    virtual void onMouseWheel(QWheelEvent * e, float devicePixelRatio) { onMouseWheel(e); }

protected:

    void updateToolTip(QMouseEvent* e, const QString& text);

public: // implementation of IAuthorityProvider

    virtual Authority& getAuthority();

protected:

    QString mLastToolTip;
};


}

#endif