Files
OpenSpace/modules/webbrowser/include/eventhandler.h

125 lines
4.9 KiB
C++

/*****************************************************************************************
* *
* OpenSpace *
* *
* Copyright (c) 2014-2025 *
* *
* 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 __OPENSPACE_MODULE_WEBBROWSER___EVENT_HANDLER___H__
#define __OPENSPACE_MODULE_WEBBROWSER___EVENT_HANDLER___H__
#include <openspace/util/keys.h>
#include <openspace/util/mouse.h>
#include <openspace/util/touch.h>
#include <ghoul/glm.h>
#include <chrono>
#ifdef _MSC_VER
#pragma warning (push)
#pragma warning (disable : 4100)
#endif // _MSC_VER
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunused-parameter"
#endif // __clang__
#include <include/cef_browser.h>
#ifdef __clang__
#pragma clang diagnostic pop
#endif // __clang__
#ifdef _MSC_VER
#pragma warning (pop)
#endif // _MSC_VER
namespace openspace {
class BrowserInstance;
class EventHandler {
public:
void initialize();
void setBrowserInstance(BrowserInstance* browserInstance);
void resetBrowserInstance();
private:
bool mouseButtonCallback(MouseButton button, MouseAction action, KeyModifier mods);
bool mousePositionCallback(double x, double y);
bool mouseWheelCallback(glm::ivec2 delta);
bool charCallback(unsigned int charCode, KeyModifier modifier);
bool keyboardCallback(Key key, KeyModifier modifier, KeyAction action);
/**
* Detect if there is a special event that should be caught by the GUI before it is
* sent to CEF.
*
* \param key the pressed key
* \param mods the key modifier that was pressed
* \param action the action that was performed that triggered this event
* \return `true` if event found, `false` otherwise
*/
bool specialKeyEvent(Key key, KeyModifier mods, KeyAction action);
/**
* Create a mouse event on the current cursor position.
*/
CefMouseEvent mouseEvent(KeyModifier mods = KeyModifier::None) const;
#ifdef WIN32
/**
* Build a CEF touch event based on our internal structure.
*
* Note: As of 2020-02-21 we are using an older version of CEF on OSX than WIN32. This
* version does not handle the CefTouchEvent type and does not have any internal
* touch handling
*/
CefTouchEvent touchEvent(const TouchInput& input,
const cef_touch_event_type_t eventType) const;
#endif // WIN32
cef_key_event_type_t keyEventType(KeyAction action);
BrowserInstance* _browserInstance = nullptr;
glm::vec2 _mousePosition = glm::vec2(0.f);
struct MouseButtonState {
bool down = false;
glm::vec2 lastClickPosition = glm::vec2(0.f);
std::chrono::high_resolution_clock::time_point lastClickTime;
};
MouseButtonState _leftButton;
MouseButtonState _rightButton;
/// This vector assumes first element to be the active one
std::vector<TouchInput> _validTouchStates;
/**
* Determines if a click should be sent as a double click or not
*/
bool isDoubleClick(const MouseButtonState& button) const;
};
} // namespace openspace
#endif // __OPENSPACE_MODULE_WEBBROWSER___EVENT_HANDLER___H__