axmol/core/base/CCEventMouse.h

/****************************************************************************
 Copyright (c) 2013-2016 Chukong Technologies Inc.
 Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.

 https://axis-project.github.io/

 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 __cocos2d_libs__CCMouseEvent__
#define __cocos2d_libs__CCMouseEvent__

#include "base/CCEvent.h"
#include "math/CCMath.h"

/**
 * @addtogroup base
 * @{
 */

NS_AX_BEGIN

/** @class EventMouse
 * @brief The mouse event.
 */
class AX_DLL EventMouse : public Event
{
public:
    /**
     * MouseEventType Different types of MouseEvent.
     * @js NA
     */
    enum class MouseEventType
    {
        MOUSE_NONE,
        MOUSE_DOWN,
        MOUSE_UP,
        MOUSE_MOVE,
        MOUSE_SCROLL,
    };

    enum class MouseButton
    {
        BUTTON_UNSET  = -1,
        BUTTON_LEFT   = 0,
        BUTTON_RIGHT  = 1,
        BUTTON_MIDDLE = 2,
        BUTTON_4      = 3,
        BUTTON_5      = 4,
        BUTTON_6      = 5,
        BUTTON_7      = 6,
        BUTTON_8      = 7
    };

    /** Constructor.
     *
     * @param mouseEventCode A given mouse event type.
     * @js ctor
     */
    EventMouse(MouseEventType mouseEventCode);

    /** Set mouse scroll data.
     *
     * @param scrollX The scroll data of x axis.
     * @param scrollY The scroll data of y axis.
     */
    void setScrollData(float scrollX, float scrollY)
    {
        _scrollX = scrollX;
        _scrollY = scrollY;
    }
    /** Get mouse scroll data of x axis.
     *
     * @return The scroll data of x axis.
     */
    float getScrollX() const { return _scrollX; }
    /** Get mouse scroll data of y axis.
     *
     * @return The scroll data of y axis.
     */
    float getScrollY() const { return _scrollY; }

    /** Set the cursor position.
     *
     * @param x The x coordinate of cursor position.
     * @param y The y coordinate of cursor position.
     * @js setLocation
     */
    void setCursorPosition(float x, float y)
    {
        _x         = x;
        _y         = y;
        _prevPoint = _point;
        _point.x   = x;
        _point.y   = y;
        if (!_startPointCaptured)
        {
            _startPoint         = _point;
            _startPointCaptured = true;
        }
    }

    /** Set mouse button.
     *
     * @param button a given mouse button.
     * @js setButton
     */
    void setMouseButton(MouseButton button) { _mouseButton = button; }
    /** Get mouse button.
     *
     * @return The mouse button.
     * @js getButton
     */
    MouseButton getMouseButton() const { return _mouseButton; }
    /** Get the cursor position of x axis.
     *
     * @return The x coordinate of cursor position.
     * @js getLocationX
     */
    float getCursorX() const { return _x; }
    /** Get the cursor position of y axis.
     *
     * @return The y coordinate of cursor position.
     * @js getLocationY
     */
    float getCursorY() const { return _y; }

    /** Returns the current touch location in OpenGL coordinates.
     *
     * @return The current touch location in OpenGL coordinates.
     */
    Vec2 getLocation() const;
    /** Returns the previous touch location in OpenGL coordinates.
     *
     * @return The previous touch location in OpenGL coordinates.
     * @js NA
     */
    Vec2 getPreviousLocation() const;
    /** Returns the start touch location in OpenGL coordinates.
     *
     * @return The start touch location in OpenGL coordinates.
     * @js NA
     */
    Vec2 getStartLocation() const;
    /** Returns the delta of 2 current touches locations in screen coordinates.
     *
     * @return The delta of 2 current touches locations in screen coordinates.
     */
    Vec2 getDelta() const;
    /** Returns the current touch location in screen coordinates.
     *
     * @return The current touch location in screen coordinates.
     */
    Vec2 getLocationInView() const;
    /** Returns the previous touch location in screen coordinates.
     *
     * @return The previous touch location in screen coordinates.
     * @js NA
     */
    Vec2 getPreviousLocationInView() const;
    /** Returns the start touch location in screen coordinates.
     *
     * @return The start touch location in screen coordinates.
     * @js NA
     */
    Vec2 getStartLocationInView() const;

private:
    MouseEventType _mouseEventType;
    MouseButton _mouseButton;
    float _x;
    float _y;
    float _scrollX;
    float _scrollY;

    bool _startPointCaptured;
    Vec2 _startPoint;
    Vec2 _point;
    Vec2 _prevPoint;

    friend class EventListenerMouse;
};

NS_AX_END

// end of base group
/// @}

#endif /* defined(__cocos2d_libs__CCMouseEvent__) */