mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2026-01-01 09:10:18 -06:00
32cff07bf8
* First version of new screenspacetext and screenspacetextdate * Code restructuring and adding new types - ScreenSpaceFramebuffer -> ScreenSpaceRenderableFramebuffer - ScreenSpaceText -> ScreenSpaceRenderableText - Add new user-facing ScreenSpaceText - Add examples * Add documentation for new ScreenSpace objects * Add visual tests to new screenspace objects * Address PR comments
72 lines
3.3 KiB
C++
72 lines
3.3 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. *
|
|
****************************************************************************************/
|
|
|
|
#include <modules/base/rendering/screenspacetext.h>
|
|
|
|
#include <ghoul/opengl/framebufferobject.h>
|
|
#include <ghoul/opengl/texture.h>
|
|
|
|
namespace {
|
|
constexpr openspace::properties::Property::PropertyInfo TextInfo = {
|
|
"Text",
|
|
"Text",
|
|
"The text to be displayed.",
|
|
openspace::properties::Property::Visibility::User
|
|
};
|
|
|
|
// This `ScreenSpaceRenderable` shows a static text that can be changed via a
|
|
// property.
|
|
struct [[codegen::Dictionary(DashboardItemText)]] Parameters {
|
|
// [[codegen::verbatim(TextInfo.description)]]
|
|
std::optional<std::string> text;
|
|
};
|
|
#include "screenspacetext_codegen.cpp"
|
|
} // namespace
|
|
|
|
namespace openspace {
|
|
|
|
documentation::Documentation ScreenSpaceText::Documentation() {
|
|
return codegen::doc<Parameters>(
|
|
"base_screenspace_text",
|
|
ScreenSpaceRenderableText::Documentation()
|
|
);
|
|
}
|
|
|
|
ScreenSpaceText::ScreenSpaceText(const ghoul::Dictionary& dictionary)
|
|
: ScreenSpaceRenderableText(dictionary)
|
|
, _text(TextInfo, "")
|
|
{
|
|
const Parameters p = codegen::bake<Parameters>(dictionary);
|
|
_text = p.text.value_or(_text);
|
|
addProperty(_text);
|
|
}
|
|
|
|
void ScreenSpaceText::update() {
|
|
_buffer = _text.value();
|
|
|
|
ScreenSpaceRenderableText::update();
|
|
}
|
|
|
|
} // namespace openspace
|