Add generic Labels class

modules/space/CMakeLists.txt

@@ -27,6 +27,7 @@ include(${OPENSPACE_CMAKE_EXT_DIR}/module_definition.cmake)
 set(HEADER_FILES
   horizonsfile.h
   kepler.h
+  specklabels.h
   speckloader.h
   rendering/renderableconstellationbounds.h
   rendering/renderablefluxnodes.h
@@ -47,6 +48,7 @@ set(SOURCE_FILES
   horizonsfile.cpp
   kepler.cpp
   spacemodule_lua.inl
+  specklabels.cpp
   speckloader.cpp
   rendering/renderableconstellationbounds.cpp
   rendering/renderablefluxnodes.cpp

modules/space/spacemodule.cpp

@@ -31,6 +31,7 @@
 #include <modules/space/rendering/renderablerings.h>
 #include <modules/space/rendering/renderablestars.h>
 #include <modules/space/rendering/renderabletravelspeed.h>
+#include <modules/space/specklabels.h>
 #include <modules/space/translation/keplertranslation.h>
 #include <modules/space/translation/spicetranslation.h>
 #include <modules/space/translation/gptranslation.h>
@@ -123,6 +124,7 @@ std::vector<documentation::Documentation> SpaceModule::documentations() const {
         RenderableTravelSpeed::Documentation(),
         SpiceRotation::Documentation(),
         SpiceTranslation::Documentation(),
+        speck::SpeckLabels::Documentation(),
         GPTranslation::Documentation()
     };
 }

modules/space/specklabels.cpp

@@ -0,0 +1,222 @@
+/*****************************************************************************************
+ *                                                                                       *
+ * OpenSpace                                                                             *
+ *                                                                                       *
+ * Copyright (c) 2014-2022                                                               *
+ *                                                                                       *
+ * 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/space/specklabels.h>
+
+#include <openspace/engine/globals.h>
+#include <openspace/engine/windowdelegate.h>
+#include <openspace/documentation/documentation.h>
+#include <openspace/util/updatestructures.h>
+#include <ghoul/filesystem/filesystem.h>
+#include <ghoul/font/fontmanager.h>
+#include <ghoul/font/fontrenderer.h>
+#include <optional>
+
+namespace {
+    constexpr int RenderOptionViewDirection = 0;
+    constexpr int RenderOptionPositionNormal = 1;
+
+    constexpr openspace::properties::Property::PropertyInfo FileInfo = {
+        "File",
+        "File",
+        "The speck label file with tha data for the labels"
+    };
+
+    constexpr openspace::properties::Property::PropertyInfo UnitInfo = {
+        "Unit",
+        "Unit",
+        "Distance unit for the label data"
+    };
+
+    constexpr openspace::properties::Property::PropertyInfo OpacityInfo = {
+        "Opacity",
+        "Opacity",
+        "Determines the transparency of the labels, where 1 is completely opaque "
+        "and 0 fully transparent"
+    };
+    constexpr openspace::properties::Property::PropertyInfo ColorInfo = {
+        "Color",
+        "Color",
+        "The color of the labels"
+    };
+    constexpr openspace::properties::Property::PropertyInfo SizeInfo = {
+        "Size",
+        "Size",
+        "The size of the labels in pixels"
+    };
+    constexpr openspace::properties::Property::PropertyInfo MinMaxInfo = {
+        "MinMaxSize",
+        "Min/Max Size",
+        "The minimum and maximum size (in pixels) of the labels"
+    };
+
+    constexpr openspace::properties::Property::PropertyInfo RenderOptionInfo = {
+        "RenderOption",
+        "Render Option",
+        "Debug option for rendering of billboards and texts"
+    };
+
+    struct [[codegen::Dictionary(SpeckLabels)]] Parameters {
+        // [[codegen::verbatim(FileInfo.description)]]
+        std::filesystem::path file;
+
+        // [[codegen::verbatim(OpacityInfo.description)]]
+        std::optional<float> opacity [[codegen::inrange(0.0, 1.0)]];
+
+        // [[codegen::verbatim(ColorInfo.description)]]
+        std::optional<glm::vec3> color [[codegen::color()]];
+
+        // [[codegen::verbatim(SizeInfo.description)]]
+        std::optional<float> size;
+
+        // [[codegen::verbatim(MinMaxInfo.description)]]
+        std::optional<glm::ivec2> minMaxSize;
+
+        enum class [[codegen::map(openspace::DistanceUnit)]] Unit {
+            Meter [[codegen::key("m")]],
+            Kilometer [[codegen::key("Km")]],
+            Parsec [[codegen::key("pc")]],
+            Kiloparsec [[codegen::key("Kpc")]],
+            Megaparsec [[codegen::key("Mpc")]],
+            Gigaparsec [[codegen::key("Gpc")]],
+            Gigalightyear [[codegen::key("Gly")]]
+        };
+        std::optional<Unit> unit;
+    };
+#include "specklabels_codegen.cpp"
+} // namespace
+
+namespace openspace::speck {
+
+documentation::Documentation SpeckLabels::Documentation() {
+    return codegen::doc<Parameters>("space_specklabels");
+}
+
+SpeckLabels::SpeckLabels(const ghoul::Dictionary& dictionary)
+    : properties::PropertyOwner({ "SpeckLabels" })
+    , _opacity(OpacityInfo, 1.f, 0.f, 1.f)
+    , _color(ColorInfo, glm::vec3(1.f), glm::vec3(0.f), glm::vec3(1.f))
+    , _size(SizeInfo, 8.f, 0.5f, 24.f)
+    , _minMaxSize(
+        MinMaxInfo,
+        glm::ivec2(8, 500),
+        glm::ivec2(0),
+        glm::ivec2(1000)
+    )
+    , _renderOption(RenderOptionInfo, properties::OptionProperty::DisplayType::Dropdown)
+{
+    const Parameters p = codegen::bake<Parameters>(dictionary);
+
+    //setRenderBin(RenderBin::Overlay);
+
+    _labelFile = absPath(p.file);
+
+    if (p.unit.has_value()) {
+        _unit = codegen::map<DistanceUnit>(*p.unit);
+    }
+    else {
+        _unit = DistanceUnit::Meter;
+    }
+
+    _opacity = p.opacity.value_or(_opacity);
+    addProperty(_opacity);
+
+    _color = p.color.value_or(_color);
+    _color.setViewOption(properties::Property::ViewOptions::Color);
+    addProperty(_color);
+
+    _size = p.size.value_or(_size);
+    addProperty(_size);
+
+    _minMaxSize = p.minMaxSize.value_or(_minMaxSize);
+    _minMaxSize.setViewOption(properties::Property::ViewOptions::MinMaxRange);
+    addProperty(_minMaxSize);
+
+    _renderOption.addOption(RenderOptionViewDirection, "Camera View Direction");
+    _renderOption.addOption(RenderOptionPositionNormal, "Camera Position Normal");
+    // @TODO (abock. 2021-01-31) In the other DU classes, this is done with an enum, and
+    // doing it based on the fisheye rendering seems a bit brittle?
+    if (global::windowDelegate->isFisheyeRendering()) {
+        _renderOption = RenderOptionPositionNormal;
+    }
+    else {
+        _renderOption = RenderOptionViewDirection;
+    }
+    addProperty(_renderOption);
+}
+
+void SpeckLabels::initialize() {
+    if (!_font) {
+        constexpr int FontSize = 50;
+        _font = global::fontManager->font(
+            "Mono",
+            static_cast<float>(FontSize),
+            ghoul::fontrendering::FontManager::Outline::Yes,
+            ghoul::fontrendering::FontManager::LoadGlyphs::No
+        );
+    }
+}
+
+void SpeckLabels::loadLabels() {
+    _labelset = speck::label::loadFileWithCache(_labelFile);
+}
+
+bool SpeckLabels::isReady() const {
+    return !(_labelset.entries.empty());
+}
+
+void SpeckLabels::render(const RenderData& data, const glm::dmat4& modelViewProjectionMatrix,
+    const glm::vec3& orthoRight, const glm::vec3& orthoUp)
+{
+    float scale = static_cast<float>(toMeter(_unit));
+
+    ghoul::fontrendering::FontRenderer::ProjectedLabelsInformation labelInfo;
+    labelInfo.orthoRight = orthoRight;
+    labelInfo.orthoUp = orthoUp;
+    labelInfo.minSize = _minMaxSize.value().x;
+    labelInfo.maxSize = _minMaxSize.value().y;
+    labelInfo.cameraPos = data.camera.positionVec3();
+    labelInfo.cameraLookUp = data.camera.lookUpVectorWorldSpace();
+    labelInfo.renderType = _renderOption;
+    labelInfo.mvpMatrix = modelViewProjectionMatrix;
+    labelInfo.scale = pow(10.f, _size);
+    labelInfo.enableDepth = true;
+    labelInfo.enableFalseDepth = false;
+
+    glm::vec4 textColor = glm::vec4(glm::vec3(_color), _opacity);
+
+    for (const speck::Labelset::Entry& e : _labelset.entries) {
+        glm::vec3 scaledPos(e.position);
+        scaledPos *= scale;
+        ghoul::fontrendering::FontRenderer::defaultProjectionRenderer().render(
+            *_font,
+            scaledPos,
+            e.text,
+            textColor,
+            labelInfo
+        );
+    }
+}
+
+} // namespace openspace::speck

modules/space/specklabels.h

@@ -0,0 +1,85 @@
+/*****************************************************************************************
+ *                                                                                       *
+ * OpenSpace                                                                             *
+ *                                                                                       *
+ * Copyright (c) 2014-2022                                                               *
+ *                                                                                       *
+ * 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_SPACE___SPECKLABELS___H__
+#define __OPENSPACE_MODULE_SPACE___SPECKLABELS___H__
+
+#include <openspace/properties/propertyowner.h>
+
+#include <modules/space/speckloader.h>
+#include <openspace/properties/optionproperty.h>
+#include <openspace/properties/scalar/floatproperty.h>
+#include <openspace/properties/vector/ivec2property.h>
+#include <openspace/properties/vector/vec3property.h>
+#include <openspace/util/distanceconversion.h>
+#include <ghoul/glm.h>
+#include <filesystem>
+
+namespace ghoul::fontrendering { class Font; }
+
+namespace openspace {
+    struct RenderData;
+
+namespace documentation { struct Documentation; }
+
+namespace speck {
+
+class SpeckLabels : public properties::PropertyOwner {
+public:
+    explicit SpeckLabels(const ghoul::Dictionary& dictionary);
+    ~SpeckLabels() override = default;
+
+    void initialize();
+
+    void loadLabels();
+
+    bool isReady() const;
+
+    void render(const RenderData& data, const glm::dmat4& modelViewProjectionMatrix,
+        const glm::vec3& orthoRight, const glm::vec3& orthoUp);
+
+    static documentation::Documentation Documentation();
+
+private:
+    std::filesystem::path _labelFile;
+    DistanceUnit _unit = DistanceUnit::Parsec;
+    speck::Labelset _labelset;
+
+    std::shared_ptr<ghoul::fontrendering::Font> _font = nullptr;
+
+    // Properties
+    properties::FloatProperty _opacity;
+    properties::Vec3Property _color;
+    properties::FloatProperty _size;
+    properties::IVec2Property _minMaxSize;
+
+    // DEBUG:
+    properties::OptionProperty _renderOption;
+};
+
+} // namespace speck
+
+} // namespace openspace
+
+#endif // __OPENSPACE_MODULE_SPACE___SPECKLABELS___H__