UI_DeviceEvent.h

Go to the documentation of this file.

#ifndef __UI_DeviceEvent__
#define __UI_DeviceEvent__

#include "UI_API.h"

#include <RE/RE_IDType.h>
#include <SYS/SYS_Types.h>
#include <UT/UT_Array.h>
#include <UT/UT_StringHolder.h>

#include "UI_EventType.h"

/*
 *      The UI_DeviceEvent is a generic event structure which
 *      various input device drivers will generate as sub-classes
 *      of UI_EventGenerator.
 */

/*
 *  Note: these are flag bits since more than one button can be down:
 */
#define UI_NO_BUTTON            0x0
#define UI_LEFT_BUTTON          0x01
#define UI_MIDDLE_BUTTON        0x02
#define UI_RIGHT_BUTTON         0x04

#define UI_ALT_KEY              0x0001  //
#define UI_SHIFT_KEY            0x0002  //
#define UI_CTRL_KEY             0x0004  //
#define UI_COMMAND_KEY          0x0008  // Windows key on Win/Linux
#define UI_META_KEYS            (UI_ALT_KEY| \
                                 UI_SHIFT_KEY| \
                                 UI_CTRL_KEY| \
                                 UI_COMMAND_KEY)
#define UI_ALPHASHIFT_KEY       0x0010  // Caps-lock
#define UI_AUTOREPEAT           0x0020  // Auto-repeat is on for the key
#define UI_IME_PREEDIT          0x0040  // Key is IME pre-edit string
#define UI_IME_COMMIT           0x0080  // Key is IME commit string
#define UI_KEYPAD_KEY           0x0100  // The key came from the keypad
#define UI_TABLET_MOTION        0x0200  // Motion event triggered from tablet.
#define UI_KEYSTATE_CHANGE      0x0400  // Key state was changed by this event
#define UI_KEYSEQ_TRIGGER       0x0800  // Key is key sequence hotkey trigger
#define UI_DBLCLK               0x1000  // UI_EVENT_BUTTON is the second press of a double-click

#if defined(MBSD)
    #define UI_TOGGLE_SEL_MODIFIER  UI_COMMAND_KEY
#else
    #define UI_TOGGLE_SEL_MODIFIER  UI_CTRL_KEY
#endif

static inline bool
UIhasToggleSelModifier(short alt_flags)
{
    return (alt_flags & UI_TOGGLE_SEL_MODIFIER);
}

// Flags for UI_DeviceEvent::deviceFlags.
#define UI_TABLET_DEVICE        0x0001  // Event came from a tablet pen.

// Default for the pen button dead zone preference below, in pixels.
#define UI_PEN_BUTTON_DEAD_ZONE 8

// How far the pointer may drift while a pen button is held, before it counts
// as a drag. A pen tip resting on the tablet is as steady as a mouse, but the
// pen buttons are used while it hovers, so they need more room.
UI_API void     UIsetPenButtonDeadZone(int pixels);
UI_API int      UIgetPenButtonDeadZone();

// The dead zone to use for the device and button that sent an event, given
// the one that applies to a mouse.
static inline int
UIgetDragDeadZone(int dead_zone, short device_flags, int button)
{
    // The tip being down steadies the hand, whatever else is held.
    if (!(device_flags & UI_TABLET_DEVICE) || (button & UI_LEFT_BUTTON))
        return dead_zone;

    int  pen_dead_zone = UIgetPenButtonDeadZone();

    return dead_zone > pen_dead_zone ? dead_zone : pen_dead_zone;
}

// Conversion from our Z value to 0..1
#define UI_PRESSURE_SCALE       16384.0F
// Conversion of T/U/V values to degrees.
#define UI_ANGLE_SCALE          100.0F

enum UI_Dimension
{
    DEVICE_DIM_T    = 0,
    DEVICE_DIM_U    = 1,
    DEVICE_DIM_V    = 2,
    DEVICE_DIM_W    = 3,
    DEVICE_DIM_X    = 4,
    DEVICE_DIM_Y    = 5,
    DEVICE_DIM_Z    = 6
};
#define UI_DEVICE_DIMENSIONS    7


class UI_API UI_DeviceEvent 
{
public:
    UI_DeviceEvent(int event_id = 0);

    /// Returns an array of Unicode code points corresponding to typed in
    /// characters from a keyboard event.
    bool getTypedCharacters(UT_Array<utf32> &cps) const;

    /// Scroll phase of a touchpad wheel event. Values match Qt::ScrollPhase.
    enum ScrollPhase
    {
        SCROLL_NO_PHASE = 0,
        SCROLL_BEGIN    = 1,
        SCROLL_UPDATE   = 2,
        SCROLL_END      = 3,
        SCROLL_MOMENTUM = 4
    };

    /// Queries for a mouse wheel event that came from a touchpad. The bits
    /// are packed into DEVICE_DIM_T by UI_QtGeneratorThread. Always false when
    /// touchpad gestures are turned off, so every consumer falls back to plain
    /// mouse wheel behaviour.
    bool        isTouchPad() const;
    ScrollPhase scrollPhase() const;

    /// Master switch for touchpad gestures, set from the preference.
    static void setTouchPadGestures(bool flag)
                    { theTouchPadGestures = flag; }
    static bool getTouchPadGestures()
                    { return theTouchPadGestures; }

    /// Flip the direction of a touchpad scroll that pans or tumbles, and of
    /// one that zooms. Set from the preferences.
    static void setTouchPadInvert(bool flag)
                    { theTouchPadInvert = flag; }
    static bool getTouchPadInvert()
                    { return theTouchPadInvert; }
    static void setTouchPadZoomInvert(bool flag)
                    { theTouchPadZoomInvert = flag; }
    static bool getTouchPadZoomInvert()
                    { return theTouchPadZoomInvert; }

    UI_EventType type;
    // NB: 4 bytes of alignment padding here
    RE_IDType    context;               // Device specific context
    double       time;                  // Time in seconds.
    int64        serialId;              // Event specific serialization id
    
    exint        data;                  // Event data (at least pointer sized)
    int          values[UI_DEVICE_DIMENSIONS];  // Usually valuator values
    short        altFlags;              // Event flags
    short        deviceFlags;           // Which device sent the event
    int          id;                    // Event identifier
    
    int          qt_key;
    UT_StringHolder key;                // Key input for UI_EVENT_KEYBOARD

private:
    static bool  theTouchPadGestures;
    static bool  theTouchPadInvert;
    static bool  theTouchPadZoomInvert;
};

inline
UI_DeviceEvent::UI_DeviceEvent(int event_id)
{
    id  = event_id;

    type = UI_EVENT_NO_EVENT;

    context   = 0;
    data      = 0;
    altFlags  = 0;
    deviceFlags = 0;
    values[DEVICE_DIM_T] = 0;
    values[DEVICE_DIM_U] = 0;
    values[DEVICE_DIM_V] = 0;
    values[DEVICE_DIM_W] = 0;
    values[DEVICE_DIM_X] = 0;
    values[DEVICE_DIM_Y] = 0;
    values[DEVICE_DIM_Z] = 0;
    
    time = -1.0;
    serialId = 0;
    qt_key = 0;
}

#endif