IEventReceiver.h

Go to the documentation of this file.

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h

#ifndef __I_EVENT_RECEIVER_H_INCLUDED__
#define __I_EVENT_RECEIVER_H_INCLUDED__

#include "ILogger.h"
#include "Keycodes.h"
#include "irrString.h"

namespace irr
{
        enum EEVENT_TYPE
        {

                EET_GUI_EVENT = 0,


                EET_MOUSE_INPUT_EVENT,


                EET_KEY_INPUT_EVENT,

                EET_TOUCH_INPUT_EVENT,

        EET_ACCELEROMETER_EVENT,

        EET_GYROSCOPE_EVENT,

        EET_DEVICE_MOTION_EVENT,


                EET_JOYSTICK_INPUT_EVENT,


                EET_LOG_TEXT_EVENT,


                EET_USER_EVENT,

                EET_SYSTEM_EVENT,

                EET_APPLICATION_EVENT,

                EGUIET_FORCE_32_BIT = 0x7fffffff

        };

        enum EMOUSE_INPUT_EVENT
        {
                EMIE_LMOUSE_PRESSED_DOWN = 0,

                EMIE_RMOUSE_PRESSED_DOWN,

                EMIE_MMOUSE_PRESSED_DOWN,

                EMIE_LMOUSE_LEFT_UP,

                EMIE_RMOUSE_LEFT_UP,

                EMIE_MMOUSE_LEFT_UP,

                EMIE_MOUSE_MOVED,

                EMIE_MOUSE_WHEEL,

                EMIE_LMOUSE_DOUBLE_CLICK,

                EMIE_RMOUSE_DOUBLE_CLICK,

                EMIE_MMOUSE_DOUBLE_CLICK,

                EMIE_LMOUSE_TRIPLE_CLICK,

                EMIE_RMOUSE_TRIPLE_CLICK,

                EMIE_MMOUSE_TRIPLE_CLICK,

                EMIE_MOUSE_ENTER_CANVAS,

                EMIE_MOUSE_LEAVE_CANVAS,

                EMIE_COUNT
        };

        enum E_MOUSE_BUTTON_STATE_MASK
        {
                EMBSM_LEFT    = 0x01,
                EMBSM_RIGHT   = 0x02,
                EMBSM_MIDDLE  = 0x04,

                EMBSM_EXTRA1  = 0x08,

                EMBSM_EXTRA2  = 0x10,

                EMBSM_FORCE_32_BIT = 0x7fffffff
        };

        enum ETOUCH_INPUT_EVENT
        {
                ETIE_PRESSED_DOWN = 0,

                ETIE_LEFT_UP,

                ETIE_MOVED,

                ETIE_COUNT
        };

        enum ESYSTEM_EVENT_TYPE
        {
                ESET_ANDROID_CMD = 0,

                // TODO: for example ESET_WINDOWS_MESSAGE for win32 message loop events

                ESET_COUNT
        };

        enum EAPPLICATION_EVENT_TYPE
        {
                EAET_WILL_RESUME = 0,

                EAET_DID_RESUME,

                EAET_WILL_PAUSE,

                EAET_DID_PAUSE,

                EAET_WILL_TERMINATE,

                EAET_MEMORY_WARNING,

                EAET_COUNT
        };

        namespace gui
        {

                class IGUIElement;

                enum EGUI_EVENT_TYPE
                {

                        EGET_ELEMENT_FOCUS_LOST = 0,


                        EGET_ELEMENT_FOCUSED,


                        EGET_ELEMENT_HOVERED,


                        EGET_ELEMENT_LEFT,


                        EGET_ELEMENT_CLOSED,

                        EGET_BUTTON_CLICKED,

                        EGET_SCROLL_BAR_CHANGED,

                        EGET_CHECKBOX_CHANGED,


                        EGET_LISTBOX_CHANGED,


                        EGET_LISTBOX_SELECTED_AGAIN,

                        EGET_FILE_SELECTED,

                        EGET_DIRECTORY_SELECTED,

                        EGET_FILE_CHOOSE_DIALOG_CANCELLED,

                        EGET_MESSAGEBOX_YES,

                        EGET_MESSAGEBOX_NO,

                        EGET_MESSAGEBOX_OK,

                        EGET_MESSAGEBOX_CANCEL,

                        EGET_EDITBOX_ENTER,

                        EGET_EDITBOX_CHANGED,

                        EGET_EDITBOX_MARKING_CHANGED,

                        EGET_TAB_CHANGED,

                        EGET_MENU_ITEM_SELECTED,

                        EGET_COMBO_BOX_CHANGED,

                        EGET_SPINBOX_CHANGED,

                        EGET_TABLE_CHANGED,
                        EGET_TABLE_HEADER_CHANGED,
                        EGET_TABLE_SELECTED_AGAIN,

                        EGET_TREEVIEW_NODE_DESELECT,

                        EGET_TREEVIEW_NODE_SELECT,

                        EGET_TREEVIEW_NODE_EXPAND,

                        EGET_TREEVIEW_NODE_COLLAPSE,

                        EGET_TREEVIEW_NODE_COLLAPS = EGET_TREEVIEW_NODE_COLLAPSE,

                        EGET_COUNT
                };
        } // end namespace gui


struct SEvent
{
        struct SGUIEvent
        {
                gui::IGUIElement* Caller;

                gui::IGUIElement* Element;

                gui::EGUI_EVENT_TYPE EventType;

        };

        struct SMouseInput
        {
                s32 X;

                s32 Y;


                f32 Wheel;

                bool Shift:1;

                bool Control:1;

                u32 ButtonStates;

                bool isLeftPressed() const { return 0 != ( ButtonStates & EMBSM_LEFT ); }

                bool isRightPressed() const { return 0 != ( ButtonStates & EMBSM_RIGHT ); }

                bool isMiddlePressed() const { return 0 != ( ButtonStates & EMBSM_MIDDLE ); }

                EMOUSE_INPUT_EVENT Event;
        };

        struct SKeyInput
        {
                wchar_t Char;

                EKEY_CODE Key;

                u32 SystemKeyCode;

                bool PressedDown:1;

                bool Shift:1;

                bool Control:1;
        };

        struct STouchInput
        {
        // Touch ID.
        size_t ID;

        // X position of simple touch.
                s32 X;

        // Y position of simple touch.
                s32 Y;

                ETOUCH_INPUT_EVENT Event;
        };

        struct SAccelerometerEvent
        {

        // X acceleration.
                f64 X;

        // Y acceleration.
                f64 Y;

        // Z acceleration.
                f64 Z;
        };

        struct SGyroscopeEvent
        {

        // X rotation.
                f64 X;

        // Y rotation.
                f64 Y;

        // Z rotation.
                f64 Z;
        };

        struct SDeviceMotionEvent
        {

        // X angle - roll.
                f64 X;

        // Y angle - pitch.
                f64 Y;

        // Z angle - yaw.
                f64 Z;
        };


        struct SJoystickEvent
        {
                enum
                {
                        NUMBER_OF_BUTTONS = 32,

                        AXIS_X = 0,     // e.g. analog stick 1 left to right
                        AXIS_Y,         // e.g. analog stick 1 top to bottom
                        AXIS_Z,         // e.g. throttle, or analog 2 stick 2 left to right
                        AXIS_R,         // e.g. rudder, or analog 2 stick 2 top to bottom
                        AXIS_U,
                        AXIS_V,
                        NUMBER_OF_AXES=18       // (please tell Irrlicht maintainers if you absolutely need more axes)
                };

                u32 ButtonStates;

                s16 Axis[NUMBER_OF_AXES];

                u16 POV;


                u8 Joystick;

                bool IsButtonPressed(u32 button) const
                {
                        if(button >= (u32)NUMBER_OF_BUTTONS)
                                return false;

                        return (ButtonStates & (1 << button)) ? true : false;
                }
        };

        struct SLogEvent
        {
                const c8* Text;

                ELOG_LEVEL Level;
        };

        struct SUserEvent
        {
                size_t UserData1;

                size_t UserData2;
        };

        // Raw events from the OS
        struct SSystemEvent
        {
                struct SAndroidCmd
                {
                        s32 Cmd;
                };

                // TOOD: more structs for iphone, Windows, X11, etc.

                ESYSTEM_EVENT_TYPE EventType;
                union
                {
                        struct SAndroidCmd AndroidCmd;
                };
        };

        // Application state event
        struct SApplicationEvent
        {
                EAPPLICATION_EVENT_TYPE EventType;
        };

        EEVENT_TYPE EventType;
        //union
        //{
                struct SGUIEvent GUIEvent;
                struct SMouseInput MouseInput;
                struct SKeyInput KeyInput;
        struct STouchInput TouchInput;
        struct SAccelerometerEvent AccelerometerEvent;
        struct SGyroscopeEvent GyroscopeEvent;
        struct SDeviceMotionEvent DeviceMotionEvent;
                struct SJoystickEvent JoystickEvent;
                struct SLogEvent LogEvent;
                struct SUserEvent UserEvent;
                struct SSystemEvent SystemEvent;
                struct SApplicationEvent ApplicationEvent;
        //};

};


class IEventReceiver
{
public:

        virtual ~IEventReceiver() {}


        virtual bool OnEvent(const SEvent& event) = 0;
};


struct SJoystickInfo
{

        u8 Joystick;

        core::stringc Name;

        u32 Buttons;


        u32 Axes;


        enum
        {
                POV_HAT_PRESENT,

                POV_HAT_ABSENT,

                POV_HAT_UNKNOWN
        } PovHat;
}; // struct SJoystickInfo


} // end namespace irr

#endif