Files
OpenSpace/src/rendering/dashboardtextitem.cpp
2025-12-16 13:40:19 +01:00

117 lines
5.0 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 <openspace/rendering/dashboardtextitem.h>
#include <openspace/documentation/documentation.h>
#include <openspace/engine/globals.h>
#include <ghoul/font/font.h>
#include <ghoul/font/fontmanager.h>
#include <ghoul/font/fontrenderer.h>
#include <ghoul/misc/dictionary.h>
#include <string_view>
#include <optional>
namespace {
constexpr openspace::properties::Property::PropertyInfo FontNameInfo = {
"FontName",
"Font name",
"This value is the name of the font that is used. It can either refer to an "
"internal name registered previously, or it can refer to a path that is used.",
openspace::properties::Property::Visibility::User
};
constexpr openspace::properties::Property::PropertyInfo FontSizeInfo = {
"FontSize",
"Font size",
"This value determines the size of the font that is used to render the distance.",
openspace::properties::Property::Visibility::User
};
struct [[codegen::Dictionary(DashboardTextItem)]] Parameters {
// [[codegen::verbatim(FontNameInfo.description)]]
std::optional<std::string> fontName;
// [[codegen::verbatim(FontSizeInfo.description)]]
std::optional<float> fontSize;
};
#include "dashboardtextitem_codegen.cpp"
} // namespace
namespace openspace {
documentation::Documentation DashboardTextItem::Documentation() {
return codegen::doc<Parameters>("dashboardtextitem");
}
DashboardTextItem::DashboardTextItem(const ghoul::Dictionary& dictionary)
: DashboardItem(dictionary)
, _fontName(FontNameInfo, "Mono")
, _fontSize(FontSizeInfo, 10.f, 6.f, 144.f, 1.f)
{
const Parameters p = codegen::bake<Parameters>(dictionary);
_fontName = p.fontName.value_or(_fontName);
_fontName.onChange([this]() {
_font = global::fontManager->font(_fontName, _fontSize);
});
addProperty(_fontName);
_fontSize = p.fontSize.value_or(_fontSize);
_fontSize.onChange([this]() {
_font = global::fontManager->font(_fontName, _fontSize);
});
addProperty(_fontSize);
_font = global::fontManager->font(_fontName, _fontSize);
}
void DashboardTextItem::render(glm::vec2& penPosition) {
if (_buffer.empty()) {
return;
}
// Go through the text in the buffer and render each line separately. We can't use the
// multiline version for a variety of reasons, which all boil down to the fact that
// the dashboard gets rendered top to bottom with potentially different font sizes
std::string_view text = _buffer;
size_t end = text.find('\n');
while (end != std::string_view::npos) {
// Render the current text
penPosition.y -= _font->height();
RenderFont(*_font, penPosition, text.substr(0, end));
// Remove the already rendered text
text.remove_prefix(end + 1);
end = text.find('\n');
}
// There is one line left
penPosition.y -= _font->height();
RenderFont(*_font, penPosition, text);
}
} // namespace openspace