MouseEvent.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2012 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef _GAZEBO_MOUSEEVENT_HH_
#define _GAZEBO_MOUSEEVENT_HH_

#include <ignition/math/Vector2.hh>
#include "gazebo/util/system.hh"

namespace gazebo
{
  namespace common
  {
    class MouseEventPrivate;


    class GZ_COMMON_VISIBLE MouseEvent
    {
      public: enum MouseButton
              {
                NO_BUTTON = 0x0,

                LEFT = 0x1,

                MIDDLE = 0x2,

                RIGHT = 0x4
              };

      public: enum EventType
              {
                NO_EVENT,

                MOVE,

                PRESS,

                RELEASE,

                SCROLL
              };

      public: MouseEvent();

      public: MouseEvent(const MouseEvent &_other);

      public: virtual ~MouseEvent();

      public: ignition::math::Vector2i Pos() const;

      public: void SetPos(const ignition::math::Vector2i &_pos);

      public: void SetPos(const int _x, const int _y);

      public: ignition::math::Vector2i PrevPos() const;

      public: void SetPrevPos(const ignition::math::Vector2i &_pos);

      public: void SetPrevPos(const int _x, const int _y);

      public: ignition::math::Vector2i PressPos() const;

      public: void SetPressPos(const ignition::math::Vector2i &_pos);

      public: void SetPressPos(const int _x, const int _y);

      public: ignition::math::Vector2i Scroll() const;

      public: void SetScroll(const ignition::math::Vector2i &_scroll);

      public: void SetScroll(const int _x, const int _y);

      public: float MoveScale() const;

      public: void SetMoveScale(const float _scale);

      public: bool Dragging() const;

      public: void SetDragging(const bool _dragging);

      public: EventType Type() const;

      public: void SetType(const EventType _type) const;

      public: MouseEvent::MouseButton Button() const;

      public: void SetButton(const MouseEvent::MouseButton _button) const;

      public: unsigned int Buttons() const;

      public: void SetButtons(const unsigned int &_buttons);

      public: bool Shift() const;

      public: void SetShift(const bool _shift) const;

      public: bool Alt() const;

      public: void SetAlt(const bool _alt);

      public: bool Control() const;

      public: void SetControl(const bool _control) const;

      public: MouseEvent &operator=(const MouseEvent &_other);

      private: MouseEventPrivate *dataPtr;
    };
  }
}
#endif