MouseEvent.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLQt/src/ICLQt/MouseEvent.h                           **
** Module : ICLQt                                                  **
** Authors: Christof Elbrechter                                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLUtils/Point.h>
#include <ICLUtils/Point32f.h>
#include <ICLCore/Img.h>
#include <QtCore/Qt>
#include <vector>

namespace icl{
  namespace qt{

    class ICLWidget;
    enum MouseEventType {
      MouseMoveEvent    = 0,                           
      MouseDragEvent    = 1,                           
      MousePressEvent   = 2,                           
      MouseReleaseEvent = 3,                           
      MouseEnterEvent   = 4,                           
      MouseLeaveEvent   = 5,                           
      MouseWheelEvent   = 6,                           
      MAX_MOUSE_EVENT   = MouseWheelEvent              
    };


    enum MouseButton{
      LeftMouseButton   = 0,                           
      MiddleMouseButton = 1,                           
      RightMouseButton  = 2,                           
      MAX_MOUSE_BUTTON  = RightMouseButton             
    };

    enum KeyboardModifier{
        NoModifier = Qt::NoModifier,                   
        ShiftModifier = Qt::ShiftModifier,             
        ControlModifier = Qt::ControlModifier,         
        AltModifier = Qt::AltModifier,                 
        MetaModifier = Qt::MetaModifier,               
        KeypadModifier = Qt::KeypadModifier,           
        GroupSwitchModifier = Qt::GroupSwitchModifier  
    };


    class ICLQt_API MouseEvent{
      utils::Point m_widgetPos;

      utils::Point m_imagePos;

      utils::Point32f m_imagePos32f;

      utils::Point32f m_relImagePos;

      utils::Point m_wheelDelta;

      bool m_downMask[3];

      std::vector<double> m_color;

      ICLWidget *m_widget;

      MouseEventType m_type;

      int m_keyboardModifiers;

      public:

      MouseEvent(const utils::Point &widgetPos,
                 const utils::Point &imagePos,
                 const utils::Point32f &imagePos32f,
                 const utils::Point32f &relImagePos,
                 const bool downMask[3],
                 const std::vector<double> &color,
                 const utils::Point &wheelDelta,
                 MouseEventType type,
               ICLWidget *widget);


      MouseEvent();

      inline int getWidgetX() const { return m_widgetPos.x; }

      inline int getWidgetY() const { return m_widgetPos.y; }

      inline const utils::Point &getWidgetPos() const { return m_widgetPos; }

      inline int getX() const { return m_imagePos.x; }

      inline int getY() const { return m_imagePos.y; }

      inline const utils::Point &getPos() const { return m_imagePos; }

      inline float getX32f() const { return m_imagePos32f.x; }

      inline float getY32f() const { return m_imagePos32f.y; }

      inline const utils::Point32f &getPos32f() const { return m_imagePos32f; }


      inline const utils::Point &getWheelDelta() const { return m_wheelDelta; }

      inline float getRelX() const { return m_relImagePos.x; }

      inline float getRelY() const { return m_relImagePos.y; }

      inline const utils::Point32f getRelPos() const { return m_relImagePos; }

      inline const std::vector<double> &getColor() const { return m_color; }

      inline bool hitImage() const { return m_color.size(); }

      inline std::vector<bool> getDownMask() const { return std::vector<bool>(m_downMask,m_downMask+3); }

      inline bool isLeft() const { return m_downMask[LeftMouseButton]; }

      inline bool isMiddle() const { return m_downMask[MiddleMouseButton]; }

      inline bool isRight() const { return m_downMask[RightMouseButton]; }

      inline bool isLeftOnly() const { return (isLeft() && !isMiddle() & !isRight()); }

      inline bool isMiddleOnly() const { return (!isLeft() && isMiddle() && !isRight()); }

      inline bool isRightOnly() const { return (!isLeft() && !isMiddle() && isRight()); }

      inline const MouseEventType getType() const { return m_type; }

      inline bool isMoveEvent() const { return m_type == MouseMoveEvent; }

      inline bool isDragEvent() const { return m_type == MouseDragEvent; }

      inline bool isPressEvent() const { return m_type == MousePressEvent; }

      inline bool isReleaseEvent() const { return m_type == MouseReleaseEvent; }

      inline bool isEnterEvent() const { return m_type == MouseEnterEvent; }

      inline bool isLeaveEvent() const { return m_type == MouseLeaveEvent; }

      inline bool isWheelEvent() const { return m_type == MouseWheelEvent; }

      inline ICLWidget *getWidget() const { return m_widget; }


      inline int getKeyboardModifiers() const { return m_keyboardModifiers; }

      inline bool isModifierActive(KeyboardModifier m) const { return m & m_keyboardModifiers; }


      inline MouseEvent remapEvent(const utils::Point32f &imagePos) const {
        qt::MouseEvent cpy = *this;
        cpy.m_imagePos32f = imagePos;
        cpy.m_imagePos = imagePos;
        return cpy;
      }
    };
  } // namespace qt
}