magnum-bindings/src/python/magnum/platform/application.h

#ifndef magnum_platform_application_h
#define magnum_platform_application_h
/*
    This file is part of Magnum.

    Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019
              Vladimír Vondruš <mosra@centrum.cz>

    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.
*/

#include <pybind11/pybind11.h>

#include "corrade/EnumOperators.h"
#include "magnum/bootstrap.h"

namespace magnum { namespace platform {

template<class T, class Trampoline> void application(py::class_<T, Trampoline>& c) {
    py::class_<typename T::Configuration> configuration{c, "Configuration", "Configuration"};
    configuration
        .def(py::init())
        .def_property("title", &T::Configuration::title,
            [](typename T::Configuration& self, const std::string& title) {
                self.setTitle(title);
            }, "Window title")
        .def_property("size", &T::Configuration::size,
            [](typename T::Configuration& self, const Vector2i& size) {
                self.setSize(size);
            }, "Window size");
        /** @todo others */

    py::class_<typename T::GLConfiguration> glConfiguration{c, "GLConfiguration", "OpenGL context configuration"};
    glConfiguration
        .def(py::init());
        /** @todo others */

    c
        /* Constructor */
        .def(py::init<const typename T::Configuration&, const typename T::GLConfiguration&>(), py::arg("configuration") = typename T::Configuration{}, py::arg("gl_configuration") = typename T::GLConfiguration{},
            "Constructor")
        /** @todo the nocreate ones */

        /* Basic things */
        .def("exec", &T::exec, "Execute application main loop")
        .def("exit", &T::exit, "Exit application main loop")

        /* Screen handling */
        .def("swap_buffers", &T::swapBuffers, "Swap buffers")
        /** @todo setMinimalLoopPeriod, needs a getter */
        .def("redraw", &T::redraw, "Redraw immediately")
        .def_property_readonly("window_size", &T::windowSize, "Window size")
        .def_property_readonly("framebuffer_size", &T::framebufferSize, "Framebuffer size")

        /* Event handlers */
        .def("draw_event", &T::drawEvent, "Draw event")
        .def("key_press_event", &T::keyPressEvent, "Key press event")
        .def("key_release_event", &T::keyReleaseEvent, "Key release event")
        .def("mouse_press_event", &T::mousePressEvent, "Mouse press event")
        .def("mouse_release_event", &T::mouseReleaseEvent, "Mouse release event")
        .def("mouse_move_event", &T::mouseMoveEvent, "Mouse move event")
        .def("mouse_scroll_event", &T::mouseScrollEvent, "Mouse scroll event")
        /** @todo more */
        ;
}


template<class T, class ...Args> void inputEvent(py::class_<T, Args...>& c) {
    py::enum_<typename T::Modifier>{c, "Modifier", "Modifier"}
        .value("SHIFT", T::Modifier::Shift)
        .value("CTRL", T::Modifier::Ctrl)
        .value("ALT", T::Modifier::Alt)
        .value("SUPER", T::Modifier::Super);

    c.def_property("accepted", &T::isAccepted, &T::setAccepted, "Accepted status of the event");
}

template<class T, class ...Args> void keyEvent(py::class_<T, Args...>& c) {
    py::enum_<typename T::Key>{c, "Key", "Key"}
        .value("UNKNOWN", T::Key::Unknown)
        .value("LEFT_SHIFT", T::Key::LeftShift)
        .value("RIGHT_SHIFT", T::Key::RightShift)
        .value("LEFT_CTRL", T::Key::LeftCtrl)
        .value("RIGHT_CTRL", T::Key::RightCtrl)
        .value("LEFT_ALT", T::Key::LeftAlt)
        .value("RIGHT_ALT", T::Key::RightAlt)
        .value("LEFT_SUPER", T::Key::LeftSuper)
        .value("RIGHT_SUPER", T::Key::RightSuper)

        .value("ENTER", T::Key::Enter)
        .value("ESC", T::Key::Esc)

        .value("UP", T::Key::Up)
        .value("DOWN", T::Key::Down)
        .value("LEFT", T::Key::Left)
        .value("RIGHT", T::Key::Right)
        .value("HOME", T::Key::Home)
        .value("END", T::Key::End)
        .value("PAGE_UP", T::Key::PageUp)
        .value("PAGE_DOWN", T::Key::PageDown)
        .value("BACKSPACE", T::Key::Backspace)
        .value("INSERT", T::Key::Insert)
        .value("DELETE", T::Key::Delete)

        .value("F1", T::Key::F1)
        .value("F2", T::Key::F2)
        .value("F3", T::Key::F3)
        .value("F4", T::Key::F4)
        .value("F5", T::Key::F5)
        .value("F6", T::Key::F6)
        .value("F7", T::Key::F7)
        .value("F8", T::Key::F8)
        .value("F9", T::Key::F9)
        .value("F10", T::Key::F10)
        .value("F11", T::Key::F11)
        .value("F12", T::Key::F12)

        .value("SPACE", T::Key::Space)
        .value("TAB", T::Key::Tab)
        .value("QUOTE", T::Key::Quote)
        .value("COMMA", T::Key::Comma)
        .value("PERIOD", T::Key::Period)
        .value("MINUS", T::Key::Minus)
        .value("PLUS", T::Key::Plus)
        .value("SLASH", T::Key::Slash)
        .value("PERCENT", T::Key::Percent)
        .value("SEMICOLON", T::Key::Semicolon)
        .value("EQUAL", T::Key::Equal)
        .value("LEFT_BRACKET", T::Key::LeftBracket)
        .value("RIGHT_BRACKET", T::Key::RightBracket)
        .value("BACKSLASH", T::Key::Backslash)
        .value("BACKQUOTE", T::Key::Backquote)

        /* World1 / World2 supported only by GlfwApplication, omitted */

        .value("ZERO", T::Key::Zero)
        .value("ONE", T::Key::One)
        .value("TWO", T::Key::Two)
        .value("THREE", T::Key::Three)
        .value("FOUR", T::Key::Four)
        .value("FIVE", T::Key::Five)
        .value("SIX", T::Key::Six)
        .value("SEVEN", T::Key::Seven)
        .value("EIGHT", T::Key::Eight)
        .value("NINE", T::Key::Nine)

        .value("A", T::Key::A)
        .value("B", T::Key::B)
        .value("C", T::Key::C)
        .value("D", T::Key::D)
        .value("E", T::Key::E)
        .value("F", T::Key::F)
        .value("G", T::Key::G)
        .value("H", T::Key::H)
        .value("I", T::Key::I)
        .value("J", T::Key::J)
        .value("K", T::Key::K)
        .value("L", T::Key::L)
        .value("M", T::Key::M)
        .value("N", T::Key::N)
        .value("O", T::Key::O)
        .value("P", T::Key::P)
        .value("Q", T::Key::Q)
        .value("R", T::Key::R)
        .value("S", T::Key::S)
        .value("T", T::Key::T)
        .value("U", T::Key::U)
        .value("V", T::Key::V)
        .value("W", T::Key::W)
        .value("X", T::Key::X)
        .value("Y", T::Key::Y)
        .value("Z", T::Key::Z)

        .value("NUM_ZERO", T::Key::NumZero)
        .value("NUM_ONE", T::Key::NumOne)
        .value("NUM_TWO", T::Key::NumTwo)
        .value("NUM_THREE", T::Key::NumThree)
        .value("NUM_FOUR", T::Key::NumFour)
        .value("NUM_FIVE", T::Key::NumFive)
        .value("NUM_SIX", T::Key::NumSix)
        .value("NUM_SEVEN", T::Key::NumSeven)
        .value("NUM_EIGHT", T::Key::NumEight)
        .value("NUM_NINE", T::Key::NumNine)
        .value("NUM_DECIMAL", T::Key::NumDecimal)
        .value("NUM_DIVIDE", T::Key::NumDivide)
        .value("NUM_MULTIPLY", T::Key::NumMultiply)
        .value("NUM_SUBTRACT", T::Key::NumSubtract)
        .value("NUM_ADD", T::Key::NumAdd)
        .value("NUM_ENTER", T::Key::NumEnter)
        .value("NUM_EQUAL", T::Key::NumEqual);

    c
        .def_property_readonly("key", &T::key, "Key")
        /** @todo key name? useful? useles?? */
        .def_property_readonly("modifiers", [](T& self) {
            return typename T::Modifier(typename std::underlying_type<typename T::Modifier>::type(self.modifiers()));
        }, "Modifiers")
        .def_property_readonly("is_repeated", &T::isRepeated, "Whether the key press is repeated");
}

template<class T, class ...Args> void mouseEvent(py::class_<T, Args...>& c) {
    py::enum_<typename T::Button>{c, "Button", "Mouse button"}
        .value("LEFT", T::Button::Left)
        .value("MIDDLE", T::Button::Middle)
        .value("RIGHT", T::Button::Right);

    c
        .def_property_readonly("button", &T::button, "Button")
        .def_property_readonly("position", &T::position, "Position")
        .def_property_readonly("modifiers", [](T& self) {
            return typename T::Modifier(typename std::underlying_type<typename T::Modifier>::type(self.modifiers()));
        }, "Modifiers");
}

template<class T, class ...Args> void mouseMoveEvent(py::class_<T, Args...>& c) {
    py::enum_<typename T::Button> buttons{c, "Buttons", "Set of mouse buttons"};
    buttons
        .value("LEFT", T::Button::Left)
        .value("MIDDLE", T::Button::Middle)
        .value("RIGHT", T::Button::Right);
    corrade::enumOperators(buttons);

    c
        .def_property_readonly("position", &T::position, "Position")
        .def_property_readonly("relative_position", &T::position, "Relative position")
        .def_property_readonly("buttons", [](T& self) {
            return typename T::Button(typename std::underlying_type<typename T::Button>::type(self.buttons()));
        }, "Mouse buttons")
        .def_property_readonly("modifiers", [](T& self) {
            return typename T::Modifier(typename std::underlying_type<typename T::Modifier>::type(self.modifiers()));
        }, "Modifiers");
}

template<class T, class ...Args> void mouseScrollEvent(py::class_<T, Args...>& c) {
    c
        .def_property_readonly("offset", &T::offset, "Offset")
        .def_property_readonly("position", &T::position, "Position")
        .def_property_readonly("modifiers", [](T& self) {
            return typename T::Modifier(typename std::underlying_type<typename T::Modifier>::type(self.modifiers()));
        }, "Modifiers");
}

}}

#endif