UI_interface.h

Go to the documentation of this file.

/*
**  UI_interface.h
**
**  This is part of Shiokaze, a research-oriented fluid solver for computer graphics.
**  Created by Ryoichi Ando <rand@nii.ac.jp> on July 16, 2019.
**
**  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 SHKZ_UI_INTERFACE_H
#define SHKZ_UI_INTERFACE_H
//
#include <shiokaze/graphics/graphics_engine.h>
#include <dlfcn.h>
//
SHKZ_BEGIN_NAMESPACE
//
static bool *g_shkz_has_graphical_interface {nullptr};
//
class UI_interface {
public:
    //
    enum ACTION {
        RELEASE = 0,
        PRESS = 1,
        REPEAT = 2,
    };
    //
    enum MODIFIER {
        MOD_SHIFT = 0x0001,
        MOD_CONTROL = 0x0002,
        MOD_ALT = 0x0004,
        MOD_SUPER = 0x0008,
        MOD_CAPS_LOCK = 0x0010,
        MOD_NUM_LOCK = 0x0020,
    };
    //
    enum MOUSE_BUTTON {
        LEFT = 1,
        RIGHT = 2,
        MIDDLE = 3,
    };
    //
    #include "keymap.h"
    //
    struct event_structure {
        //
        enum EVENT_TYPE {
            KEYBOARD,
            CURSOR,
            MOUSE,
            SCROLL,
            DRAG,
            RESIZE,
            DRAW,
        };
        EVENT_TYPE type;
        int button {0};
        int key {0};
        int action {0};
        int mods {0};
        int width {0};
        int height {0};
        double x {0.0};
        double y {0.0};
        double z {0.0};
        double u {0.0};
        double v {0.0};
        double w {0.0};
        graphics_engine *g {nullptr};
    };
    virtual bool handle_event( const event_structure &event ) {
        switch( event.type ) {
            case event_structure::KEYBOARD:
                return keyboard(event.key,event.action,event.mods);
                break;
            case event_structure::CURSOR:
                cursor(event.x,event.y,event.z);
                break;
            case event_structure::MOUSE:
                mouse(event.x,event.y,event.z,event.button,event.action,event.mods);
                break;
            case event_structure::SCROLL:
                scroll(event.x,event.y);
                break;
            case event_structure::DRAG:
                drag(event.x,event.y,event.z,event.u,event.v,event.w);
                break;
            case event_structure::RESIZE:
                resize(event.width,event.height);
                break;
            case event_structure::DRAW:
                assert(event.g);
                draw(*event.g);
                break;
        }
        return false;
    }
    virtual bool relay_event( const event_structure &event ) const { return true; }
    //
    enum CURSOR_TYPE {
        ARROW_CURSOR = 0,
        HAND_CURSOR = 1,
        IBEAM_CURSOR = 2,
        CROSSHAIR_CURSOR = 3,
        HRESIZE_CURSOR = 4,
        VRESIZE_CURSOR = 5,
    };
    virtual CURSOR_TYPE get_current_cursor() const {
        return ARROW_CURSOR;
    }
    static bool has_graphical_interface() {
        if( ! g_shkz_has_graphical_interface ) {
            g_shkz_has_graphical_interface = static_cast<bool *>(::dlsym(RTLD_DEFAULT,"g_shkz_has_graphical_interface"));
            assert(g_shkz_has_graphical_interface);
        }
        return *g_shkz_has_graphical_interface;
    }
    //
protected:
    //
    virtual void resize( int width, int height ) {}
    virtual void draw( graphics_engine &g ) const {}
    virtual bool keyboard( int key, int action, int mods ) { return false; }
    virtual void cursor( double x, double y, double z ) {};
    virtual void mouse( double x, double y, double z, int button, int action, int mods ) {};
    virtual void scroll( double xoffset, double yoffset ) {};
    virtual void drag( double x, double y, double z, double u, double v, double w ) {};
};
//
SHKZ_END_NAMESPACE
//
#endif
//