mirror of https://github.com/mosra/magnum.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
341 lines
12 KiB
341 lines
12 KiB
#ifndef Magnum_Platform_AbstractXApplication_h |
|
#define Magnum_Platform_AbstractXApplication_h |
|
/* |
|
Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz> |
|
|
|
This file is part of Magnum. |
|
|
|
Magnum is free software: you can redistribute it and/or modify |
|
it under the terms of the GNU Lesser General Public License version 3 |
|
only, as published by the Free Software Foundation. |
|
|
|
Magnum 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 version 3 for more details. |
|
*/ |
|
|
|
/** @file |
|
* @brief Class Magnum::Platform::AbstractXApplication |
|
*/ |
|
|
|
#include <Containers/EnumSet.h> |
|
|
|
#include "Magnum.h" |
|
|
|
#include <X11/Xlib.h> |
|
#include <X11/Xutil.h> |
|
/* undef Xlib nonsense to avoid conflicts */ |
|
#undef None |
|
#undef Always |
|
|
|
#include "Math/Vector2.h" |
|
#include "AbstractContextHandler.h" |
|
|
|
#include "magnumCompatibility.h" |
|
|
|
namespace Magnum { |
|
|
|
class Context; |
|
|
|
namespace Platform { |
|
|
|
/** @nosubgrouping |
|
@brief Base for X11-based applications |
|
|
|
Supports keyboard and mouse handling. |
|
|
|
@note Not meant to be used directly, see subclasses. |
|
*/ |
|
class AbstractXApplication { |
|
public: |
|
/** |
|
* @brief Constructor |
|
* @param contextHandler OpenGL context handler |
|
* @param argc Count of arguments of `main()` function |
|
* @param argv Arguments of `main()` function |
|
* @param title Window title |
|
* @param size Window size |
|
* |
|
* Creates window with double-buffered OpenGL ES 2 context. |
|
*/ |
|
AbstractXApplication(AbstractContextHandler<Display*, VisualID, Window>* contextHandler, int& argc, char** argv, const std::string& title = "Magnum X application", const Math::Vector2<GLsizei>& size = Math::Vector2<GLsizei>(800, 600)); |
|
|
|
/** |
|
* @brief Destructor |
|
* |
|
* Deletes context and destroys the window. |
|
*/ |
|
virtual ~AbstractXApplication() = 0; |
|
|
|
/** |
|
* @brief Execute main loop |
|
* @return Value for returning from `main()`. |
|
*/ |
|
int exec(); |
|
|
|
/** @brief Exit application main loop */ |
|
inline void exit() { flags |= Flag::Exit; } |
|
|
|
/** @{ @name Drawing functions */ |
|
|
|
protected: |
|
/** @copydoc GlutApplication::viewportEvent() */ |
|
virtual void viewportEvent(const Math::Vector2<GLsizei>& size) = 0; |
|
|
|
/** @copydoc GlutApplication::drawEvent() */ |
|
virtual void drawEvent() = 0; |
|
|
|
/** @copydoc GlutApplication::swapBuffers() */ |
|
inline void swapBuffers() { contextHandler->swapBuffers(); } |
|
|
|
/** @copydoc GlutApplication::redraw() */ |
|
inline void redraw() { flags |= Flag::Redraw; } |
|
|
|
/*@}*/ |
|
|
|
/** @{ @name Keyboard handling */ |
|
|
|
public: |
|
/** |
|
* @brief %Modifier |
|
* |
|
* @see Modifiers, keyPressEvent(), keyReleaseEvent(), |
|
* mousePressEvent(), mouseReleaseEvent(), mouseMotionEvent() |
|
*/ |
|
enum class Modifier: unsigned int { |
|
Shift = ShiftMask, /**< Shift */ |
|
Ctrl = ControlMask, /**< Ctrl */ |
|
Alt = Mod1Mask, /**< Alt */ |
|
AltGr = Mod5Mask, /**< AltGr */ |
|
|
|
LeftButton = Button1Mask, /**< Left mouse button */ |
|
MiddleButton = Button2Mask, /**< Middle mouse button */ |
|
RightButton = Button3Mask, /**< Right mouse button */ |
|
|
|
CapsLock = LockMask, /**< Caps lock */ |
|
NumLock = Mod2Mask /**< Num lock */ |
|
}; |
|
|
|
/** |
|
* @brief Set of modifiers |
|
* |
|
* @see keyPressEvent(), keyReleaseEvent() |
|
*/ |
|
typedef Corrade::Containers::EnumSet<Modifier, unsigned int> Modifiers; |
|
|
|
/** |
|
* @brief Key |
|
* |
|
* @see keyPressEvent(), keyReleaseEvent() |
|
*/ |
|
enum class Key: KeySym { |
|
Enter = XK_Return, /**< Enter */ |
|
Esc = XK_Escape, /**< Escape */ |
|
|
|
Up = XK_Up, /**< Up arrow */ |
|
Down = XK_Down, /**< Down arrow */ |
|
Left = XK_Left, /**< Left arrow */ |
|
Right = XK_Right, /**< Right arrow */ |
|
F1 = XK_F1, /**< F1 */ |
|
F2 = XK_F2, /**< F2 */ |
|
F3 = XK_F3, /**< F3 */ |
|
F4 = XK_F4, /**< F4 */ |
|
F5 = XK_F5, /**< F5 */ |
|
F6 = XK_F6, /**< F6 */ |
|
F7 = XK_F7, /**< F7 */ |
|
F8 = XK_F8, /**< F8 */ |
|
F9 = XK_F9, /**< F9 */ |
|
F10 = XK_F10, /**< F10 */ |
|
F11 = XK_F11, /**< F11 */ |
|
F12 = XK_F12, /**< F12 */ |
|
Home = XK_Home, /**< Home */ |
|
End = XK_End, /**< End */ |
|
PageUp = XK_Page_Up, /**< Page up */ |
|
PageDown = XK_Page_Down, /**< Page down */ |
|
|
|
Space = XK_space, /**< Space */ |
|
Comma = XK_comma, /**< Comma */ |
|
Period = XK_period, /**< Period */ |
|
Minus = XK_minus, /**< Minus */ |
|
Plus = XK_plus, /**< Plus */ |
|
Slash = XK_slash, /**< Slash */ |
|
Percent = XK_percent, /**< Percent */ |
|
Equal = XK_equal, /**< Equal */ |
|
|
|
Zero = XK_0, /**< Zero */ |
|
One = XK_1, /**< One */ |
|
Two = XK_2, /**< Two */ |
|
Three = XK_3, /**< Three */ |
|
Four = XK_4, /**< Four */ |
|
Five = XK_5, /**< Five */ |
|
Six = XK_6, /**< Six */ |
|
Seven = XK_7, /**< Seven */ |
|
Eight = XK_8, /**< Eight */ |
|
Nine = XK_9, /**< Nine */ |
|
|
|
A = XK_a, /**< Small letter A */ |
|
B = XK_b, /**< Small letter B */ |
|
C = XK_c, /**< Small letter C */ |
|
D = XK_d, /**< Small letter D */ |
|
E = XK_e, /**< Small letter E */ |
|
F = XK_f, /**< Small letter F */ |
|
G = XK_g, /**< Small letter G */ |
|
H = XK_h, /**< Small letter H */ |
|
I = XK_i, /**< Small letter I */ |
|
J = XK_j, /**< Small letter J */ |
|
K = XK_k, /**< Small letter K */ |
|
L = XK_l, /**< Small letter L */ |
|
M = XK_m, /**< Small letter M */ |
|
N = XK_n, /**< Small letter N */ |
|
O = XK_o, /**< Small letter O */ |
|
P = XK_p, /**< Small letter P */ |
|
Q = XK_q, /**< Small letter Q */ |
|
R = XK_r, /**< Small letter R */ |
|
S = XK_s, /**< Small letter S */ |
|
T = XK_t, /**< Small letter T */ |
|
U = XK_u, /**< Small letter U */ |
|
V = XK_v, /**< Small letter V */ |
|
W = XK_w, /**< Small letter W */ |
|
X = XK_x, /**< Small letter X */ |
|
Y = XK_y, /**< Small letter Y */ |
|
Z = XK_z /**< Small letter Z */ |
|
}; |
|
|
|
protected: |
|
/** |
|
* @brief Key press event |
|
* @param key Key pressed |
|
* @param modifiers Active modifiers |
|
* @param position Cursor position |
|
* |
|
* Called when an key is pressed. Default implementation does nothing. |
|
*/ |
|
virtual void keyPressEvent(Key key, Modifiers modifiers, const Math::Vector2<int>& position); |
|
|
|
/** |
|
* @brief Key press event |
|
* @param key Key released |
|
* @param modifiers Active modifiers |
|
* @param position Cursor position |
|
* |
|
* Called when an key is released. Default implementation does nothing. |
|
*/ |
|
virtual void keyReleaseEvent(Key key, Modifiers modifiers, const Math::Vector2<int>& position); |
|
|
|
/*@}*/ |
|
|
|
/** @{ @name Mouse handling */ |
|
|
|
public: |
|
/** |
|
* @brief Mouse button |
|
* |
|
* @see mousePressEvent(), mouseReleaseEvent() |
|
*/ |
|
enum class MouseButton: unsigned int { |
|
Left = Button1, /**< Left button */ |
|
Middle = Button2, /**< Middle button */ |
|
Right = Button3, /**< Right button */ |
|
WheelUp = Button4, /**< Wheel up */ |
|
WheelDown = Button5 /**< Wheel down */ |
|
}; |
|
|
|
protected: |
|
/** |
|
* @brief Mouse press event |
|
* @param button Button pressed |
|
* @param modifiers Active modifiers |
|
* @param position Cursor position |
|
* |
|
* Called when mouse button is pressed. Default implementation does |
|
* nothing. |
|
*/ |
|
virtual void mousePressEvent(MouseButton button, Modifiers modifiers, const Math::Vector2<int>& position); |
|
|
|
/** |
|
* @brief Mouse release event |
|
* @param button Button released |
|
* @param modifiers Active modifiers |
|
* @param position Cursor position |
|
* |
|
* Called when mouse button is released. Default implementation does |
|
* nothing. |
|
*/ |
|
virtual void mouseReleaseEvent(MouseButton button, Modifiers modifiers, const Math::Vector2<int>& position); |
|
|
|
/** |
|
* @brief Mouse motion event |
|
* @param modifiers Active modifiers |
|
* @param position Cursor position |
|
* |
|
* Called when mouse is moved. |
|
*/ |
|
virtual void mouseMotionEvent(Modifiers modifiers, const Math::Vector2<int>& position); |
|
|
|
/*@}*/ |
|
|
|
private: |
|
enum class Flag: unsigned int { |
|
Redraw = 1 << 0, |
|
Exit = 1 << 1 |
|
}; |
|
|
|
typedef Corrade::Containers::EnumSet<Flag, unsigned int> Flags; |
|
CORRADE_ENUMSET_FRIEND_OPERATORS(Flags) |
|
|
|
Display* display; |
|
Window window; |
|
Atom deleteWindow; |
|
|
|
AbstractContextHandler<Display*, VisualID, Window>* contextHandler; |
|
|
|
Context* c; |
|
|
|
/** @todo Get this from the created window */ |
|
Math::Vector2<GLsizei> viewportSize; |
|
|
|
Flags flags; |
|
}; |
|
|
|
/** @hideinitializer |
|
@param className Class name |
|
|
|
Can be used as equivalent to the following code to achieve better portability, |
|
see @ref portability-applications for more information. |
|
@code |
|
int main(int argc, char** argv) { |
|
className app(argc, argv); |
|
return app.exec(); |
|
} |
|
@endcode |
|
When no other application header is included this macro is also aliased to |
|
`MAGNUM_APPLICATION_MAIN()`. |
|
*/ |
|
#define MAGNUM_XAPPLICATION_MAIN(className) \ |
|
int main(int argc, char** argv) { \ |
|
className app(argc, argv); \ |
|
return app.exec(); \ |
|
} |
|
|
|
#ifndef DOXYGEN_GENERATING_OUTPUT |
|
#ifndef MAGNUM_APPLICATION_MAIN |
|
#define MAGNUM_APPLICATION_MAIN(className) MAGNUM_XAPPLICATION_MAIN(className) |
|
#else |
|
#undef MAGNUM_APPLICATION_MAIN |
|
#endif |
|
#endif |
|
|
|
CORRADE_ENUMSET_OPERATORS(AbstractXApplication::Modifiers) |
|
CORRADE_ENUMSET_OPERATORS(AbstractXApplication::Flags) |
|
|
|
/* Implementations for inline functions with unused parameters */ |
|
inline void AbstractXApplication::keyPressEvent(Key, Modifiers, const Math::Vector2<int>&) {} |
|
inline void AbstractXApplication::keyReleaseEvent(Key, Modifiers, const Math::Vector2<int>&) {} |
|
inline void AbstractXApplication::mousePressEvent(MouseButton, Modifiers, const Math::Vector2<int>&) {} |
|
inline void AbstractXApplication::mouseReleaseEvent(MouseButton, Modifiers, const Math::Vector2<int>&) {} |
|
inline void AbstractXApplication::mouseMotionEvent(Modifiers, const Math::Vector2<int>&) {} |
|
|
|
}} |
|
|
|
#endif
|
|
|