2019-11-23 20:27:39 +08:00
|
|
|
/****************************************************************************
|
|
|
|
Copyright (c) 2013-2016 Chukong Technologies Inc.
|
|
|
|
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2022-07-09 22:23:34 +08:00
|
|
|
https://axis-project.github.io/
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
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:
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
all copies or substantial portions of the Software.
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
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 __CCEVENT_H__
|
|
|
|
#define __CCEVENT_H__
|
|
|
|
|
|
|
|
#include "base/CCRef.h"
|
|
|
|
#include "platform/CCPlatformMacros.h"
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @addtogroup base
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_BEGIN
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
class Node;
|
|
|
|
|
|
|
|
/** @class Event
|
|
|
|
* @brief Base class of all kinds of events.
|
|
|
|
*/
|
2022-07-16 10:43:05 +08:00
|
|
|
class AX_DLL Event : public Ref
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
/** Type Event type.*/
|
|
|
|
enum class Type
|
|
|
|
{
|
|
|
|
TOUCH,
|
|
|
|
KEYBOARD,
|
|
|
|
ACCELERATION,
|
|
|
|
MOUSE,
|
|
|
|
FOCUS,
|
|
|
|
GAME_CONTROLLER,
|
|
|
|
CUSTOM
|
|
|
|
};
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2022-03-18 21:46:07 +08:00
|
|
|
/** Constructor */
|
|
|
|
Event(Type type);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
public:
|
|
|
|
/** Destructor.
|
|
|
|
*/
|
|
|
|
virtual ~Event();
|
|
|
|
|
|
|
|
/** Gets the event type.
|
|
|
|
*
|
|
|
|
* @return The event type.
|
|
|
|
*/
|
|
|
|
Type getType() const { return _type; }
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Stops propagation for current event.
|
|
|
|
*/
|
|
|
|
void stopPropagation() { _isStopped = true; }
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Checks whether the event has been stopped.
|
|
|
|
*
|
|
|
|
* @return True if the event has been stopped.
|
|
|
|
*/
|
|
|
|
bool isStopped() const { return _isStopped; }
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/** Gets current target of the event.
|
|
|
|
* @return The target with which the event associates.
|
|
|
|
* @note It's only available when the event listener is associated with node.
|
|
|
|
* It returns 0 when the listener is associated with fixed priority.
|
|
|
|
*/
|
|
|
|
Node* getCurrentTarget() { return _currentTarget; }
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
protected:
|
|
|
|
/** Sets current target */
|
|
|
|
void setCurrentTarget(Node* target) { _currentTarget = target; }
|
2021-12-25 10:04:45 +08:00
|
|
|
|
|
|
|
Type _type; ///< Event type
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
bool _isStopped; ///< whether the event has been stopped.
|
|
|
|
Node* _currentTarget; ///< Current target
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
friend class EventDispatcher;
|
|
|
|
};
|
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_END
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
// end of base group
|
|
|
|
/// @}
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
#endif // __CCEVENT_H__
|