Files
OpenSpace/modules/webbrowser/webbrowsermodule.h
Alexander Bock c3ba532bdb Feature/cleanup (#1608)
* Revert screenlog back to showing Info and above messages
 * Various code cleanup
2021-05-25 14:08:33 +02:00

87 lines
3.8 KiB
C++

/*****************************************************************************************
* *
* OpenSpace *
* *
* Copyright (c) 2014-2021 *
* *
* 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___WEBBROWSERMODULE___H__
#define __OPENSPACE_MODULE_WEBBROWSER___WEBBROWSERMODULE___H__
#include <openspace/util/openspacemodule.h>
#include <openspace/properties/scalar/boolproperty.h>
#include <openspace/properties/scalar/floatproperty.h>
#include <chrono>
#include <filesystem>
namespace openspace {
class BrowserInstance;
class CefHost;
class EventHandler;
namespace webbrowser {
extern std::chrono::microseconds interval;
extern std::chrono::time_point<std::chrono::high_resolution_clock> latestCall;
extern CefHost* cefHost;
void update();
} // namespace webbrowser
class WebBrowserModule : public OpenSpaceModule {
public:
static constexpr const char* Name = "WebBrowser";
WebBrowserModule();
virtual ~WebBrowserModule() = default;
void addBrowser(BrowserInstance*);
void removeBrowser(BrowserInstance*);
void attachEventHandler(BrowserInstance* browserInstance);
void detachEventHandler();
bool isEnabled() const;
protected:
void internalInitialize(const ghoul::Dictionary& dictionary) override;
void internalDeinitialize() override;
private:
/**
* Try to find the CEF Helper executable. It looks in the bin/openspace folder.
* Therefore, if you change that this might cause a crash here.
*
* \return the absolute path to the file
*/
std::filesystem::path findHelperExecutable();
properties::BoolProperty _updateBrowserBetweenRenderables;
properties::FloatProperty _browserUpdateInterval;
std::vector<BrowserInstance*> _browsers;
std::unique_ptr<EventHandler> _eventHandler;
std::unique_ptr<CefHost> _cefHost;
std::filesystem::path _webHelperLocation;
bool _enabled = true;
};
} // namespace openspace
#endif // __OPENSPACE_MODULE_WEBBROWSER___WEBBROWSERMODULE___H__