event.h

/* Copyright (c) 2006-2013, Stefan Eilemann <eile@equalizergraphics.com>
 *                    2011, Cedric Stalder <cedric.stalder@gmail.com>
 *                    2012, Daniel Nachbaur <danielnachbaur@gmail.com>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef EQFABRIC_EVENT_H
#define EQFABRIC_EVENT_H

#include <eq/fabric/api.h>
#include <eq/fabric/types.h>
#include <eq/fabric/renderContext.h> // member
#include <eq/fabric/statistic.h>     // member


namespace eq
{
namespace fabric
{

struct ResizeEvent
{
    int32_t x; 
    int32_t y; 
    int32_t w; 
    int32_t h; 
    float dw;  
    float dh;  
};

struct PointerEvent
{
    int32_t x;             
    int32_t y;             
    int32_t dx;            
    int32_t dy;            
    uint32_t buttons;      
    uint32_t button;       
    int32_t xAxis;         
    int32_t yAxis;         
};

struct KeyEvent
{
    uint32_t key; 
    // TODO modifier state
};

struct MagellanEvent
{
    uint32_t button;       
    uint32_t buttons;      
    int16_t xAxis;         
    int16_t yAxis;         
    int16_t zAxis;         
    int16_t xRotation;     
    int16_t yRotation;     
    int16_t zRotation;     
};

#   define EQ_USER_EVENT_SIZE 128

struct UserEvent
{
    char data[ EQ_USER_EVENT_SIZE ]; 
};

struct Event
{
    EQFABRIC_API Event();

    enum Type // Also update string table in event.cpp
    {
        WINDOW_EXPOSE = 0,    
        WINDOW_RESIZE,        
        WINDOW_CLOSE,         
        WINDOW_HIDE,          
        WINDOW_SHOW,          
        WINDOW_SCREENSAVER,   
#ifdef EQ_USE_DEPRECATED
        POINTER_MOTION,       

        POINTER_BUTTON_PRESS,
        POINTER_BUTTON_RELEASE,
        POINTER_WHEEL,        
        CHANNEL_POINTER_MOTION = POINTER_MOTION,
        CHANNEL_POINTER_BUTTON_PRESS = POINTER_BUTTON_PRESS,
        CHANNEL_POINTER_BUTTON_RELEASE = POINTER_BUTTON_RELEASE,
        WINDOW_POINTER_WHEEL = POINTER_WHEEL,
#else
        CHANNEL_POINTER_MOTION,
        CHANNEL_POINTER_BUTTON_PRESS,
        CHANNEL_POINTER_BUTTON_RELEASE,
        CHANNEL_POINTER_WHEEL,
        WINDOW_POINTER_WHEEL,
#endif
        WINDOW_POINTER_MOTION,
        WINDOW_POINTER_BUTTON_PRESS,
        WINDOW_POINTER_BUTTON_RELEASE,
        WINDOW_POINTER_GRAB,
        WINDOW_POINTER_UNGRAB,

        KEY_PRESS,            
        KEY_RELEASE,          
        CHANNEL_RESIZE,       
        STATISTIC,            
        VIEW_RESIZE,          
        EXIT,                 
        MAGELLAN_AXIS,        
        MAGELLAN_BUTTON,      
        NODE_TIMEOUT,         

        OBSERVER_MOTION,

        CONFIG_ERROR,
        NODE_ERROR, 
        PIPE_ERROR, 
        WINDOW_ERROR, 
        CHANNEL_ERROR, 

        UNKNOWN,              

        USER = UNKNOWN + 5, // some buffer for binary-compatible patches
        ALL // must be last
    };

    uint32_t type;           

    // keep before 'uint128_t originator' for alignment
    uint32_t serial;       

    int64_t time;

    uint128_t originator;

    union
    {
        ResizeEvent   resize;             
        ResizeEvent   show;               
        ResizeEvent   hide;               

        PointerEvent  pointer;            
        PointerEvent  pointerMotion;      
        PointerEvent  pointerButtonPress; 
        PointerEvent  pointerButtonRelease; 
        PointerEvent  pointerWheel;       

        KeyEvent      key;                
        KeyEvent      keyPress;           
        KeyEvent      keyRelease;         

        Statistic     statistic;          
        MagellanEvent magellan;           

        UserEvent     user;               
    };

    RenderContext context;
};

EQFABRIC_API std::ostream& operator << ( std::ostream&, const Event& );
EQFABRIC_API std::ostream& operator << ( std::ostream&, const Event::Type& );
EQFABRIC_API std::ostream& operator << ( std::ostream&, const ResizeEvent& );
EQFABRIC_API std::ostream& operator << ( std::ostream&, const PointerEvent& );
EQFABRIC_API std::ostream& operator << ( std::ostream&, const KeyEvent& );
EQFABRIC_API std::ostream& operator << ( std::ostream&, const MagellanEvent& );
}
}

namespace lunchbox
{
template<> inline void byteswap( eq::fabric::Event& value )
{
    byteswap( value.type );
    byteswap( value.serial );
    byteswap( value.time );
    byteswap( value.originator );
    // #145 Todo byteswap union
    //byteswap( value.union );
    byteswap( value.context );
}
}

#endif // EQFABRIC_EVENT_H