OpenSpace/src/rendering/renderable.cpp

/*****************************************************************************************
 *                                                                                       *
 * 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/renderable.h>

#include <openspace/camera/camera.h>
#include <openspace/documentation/documentation.h>
#include <openspace/engine/globals.h>
#include <openspace/events/event.h>
#include <openspace/events/eventengine.h>
#include <openspace/navigation/navigationhandler.h>
#include <openspace/scene/scenegraphnode.h>
#include <openspace/util/ellipsoid.h>
#include <openspace/util/factorymanager.h>
#include <openspace/util/memorymanager.h>
#include <openspace/util/updatestructures.h>
#include <ghoul/misc/dictionary.h>
#include <ghoul/misc/exception.h>
#include <ghoul/misc/profiling.h>
#include <ghoul/misc/templatefactory.h>
#include <variant>
#include <vector>
#include <string>
#include <utility>

namespace {
    constexpr std::string_view KeyType = "Type";

    constexpr openspace::properties::Property::PropertyInfo EnabledInfo = {
        "Enabled",
        "Enabled",
        "Determines whether this object will be visible or not.",
        openspace::properties::Property::Visibility::AdvancedUser
    };

    constexpr openspace::properties::Property::PropertyInfo RenderableTypeInfo = {
        "Type",
        "Renderable type",
        "The type of the renderable.",
        openspace::properties::Property::Visibility::AdvancedUser
    };

    constexpr openspace::properties::Property::PropertyInfo RenderableRenderBinModeInfo =
    {
        "RenderBinMode",
        "Render bin mode",
        "A value that specifies if the renderable should be rendered in the Background, "
        "Opaque, Pre-/PostDeferredTransparency, Overlay, or Sticker rendering step.",
        openspace::properties::Property::Visibility::AdvancedUser
    };

    constexpr openspace::properties::Property::PropertyInfo DimInAtmosphereInfo = {
        "DimInAtmosphere",
        "Dim in atmosphere",
        "Decides if the object should be dimmed (i.e. faded out) when the camera is in "
        "the sunny part of an atmosphere.",
        openspace::properties::Property::Visibility::AdvancedUser
    };

    // This is the base class for all `Renderable` types. These objects are responsible
    // for rendering the visuals for scene graph nodes in the 3D rendering. Different
    // `Renderable` types create various kinds of visuals, sometimes based on external
    // data files or resources (such as images, 3D models, color maps, or datasets).
    //
    // A `Renderable` is created by adding it to a scene graph node in an asset. In
    // general, this places the rendered object at the position of that scene graph node,
    // unless otherwise specified by the specific `Renderable` type.
    //
    // Each `Renderable` type typically also includes a number of settings to alter its
    // appearance. See the documentation for the individual types for more details.
    struct [[codegen::Dictionary(Renderable)]] Parameters {
        // [[codegen::verbatim(EnabledInfo.description)]]
        std::optional<bool> enabled;

        // This value determines the opacity of this renderable. A value of 0 means
        // completely transparent.
        std::optional<float> opacity [[codegen::inrange(0.0, 1.0)]];

        // A single tag or a list of tags that this renderable will respond to when
        // setting properties.
        std::optional<std::variant<std::vector<std::string>, std::string>> tag;

        // [[codegen::verbatim(RenderableTypeInfo.description)]]
        std::optional<std::string> type;

        // Fragile! Keep in sync with documentation
        enum class [[codegen::map(openspace::Renderable::RenderBin)]] RenderBinMode {
            Background,
            Opaque,
            PreDeferredTransparent,
            Overlay,
            PostDeferredTransparent,
            Sticker
        };

        // [[codegen::verbatim(RenderableRenderBinModeInfo.description)]]
        std::optional<RenderBinMode> renderBinMode;

        // [[codegen::verbatim(DimInAtmosphereInfo.description)]]
        std::optional<bool> dimInAtmosphere;
    };
#include "renderable_codegen.cpp"
} // namespace

namespace openspace {

documentation::Documentation Renderable::Documentation() {
    return codegen::doc<Parameters>("renderable");
}

ghoul::mm_unique_ptr<Renderable> Renderable::createFromDictionary(
                                                      const ghoul::Dictionary& dictionary)
{
    ZoneScoped;

    if (!dictionary.hasKey(KeyType)) {
        throw ghoul::RuntimeError("Tried to create Renderable but no 'Type' was found");
    }

    // This should be done in the constructor instead with noexhaustive
    documentation::testSpecificationAndThrow(Documentation(), dictionary, "Renderable");

    const std::string renderableType = dictionary.value<std::string>(KeyType);
    ghoul::TemplateFactory<Renderable>* factory =
        FactoryManager::ref().factory<Renderable>();
    ghoul_assert(factory, "Renderable factory did not exist");
    Renderable* result = factory->create(
        renderableType,
        dictionary,
        &global::memoryManager->PersistentMemory
    );
    result->_type = renderableType;
    return ghoul::mm_unique_ptr<Renderable>(result);
}

Renderable::Renderable(const ghoul::Dictionary& dictionary, RenderableSettings settings)
    : properties::PropertyOwner({ "Renderable" })
    , _enabled(EnabledInfo, true)
    , _renderableType(RenderableTypeInfo, "Renderable")
    , _dimInAtmosphere(DimInAtmosphereInfo, false)
    , _shouldUpdateIfDisabled(settings.shouldUpdateIfDisabled)
    , _automaticallyUpdateRenderBin(settings.automaticallyUpdateRenderBin)
{
    ZoneScoped;

    const Parameters p = codegen::bake<Parameters>(dictionary);

    if (p.renderBinMode.has_value()) {
        _automaticallyUpdateRenderBin = false;
        _hasOverrideRenderBin = true;
        setRenderBin(codegen::map<Renderable::RenderBin>(*p.renderBinMode));
    }

    if (_automaticallyUpdateRenderBin) {
        ghoul_assert(!p.renderBinMode.has_value(), "Something misfired in constructor");
        registerUpdateRenderBinFromOpacity();
    }

    if (p.tag.has_value()) {
        if (std::holds_alternative<std::string>(*p.tag)) {
            if (!std::get<std::string>(*p.tag).empty()) {
                addTag(std::get<std::string>(*p.tag));
            }
        }
        else {
            ghoul_assert(std::holds_alternative<std::vector<std::string>>(*p.tag), "");
            for (std::string tag : std::get<std::vector<std::string>>(*p.tag)) {
                addTag(std::move(tag));
            }
        }
    }

    _enabled = p.enabled.value_or(_enabled);
    addProperty(_enabled);
    _enabled.onChange([this]() {
        if (isEnabled()) {
            global::eventEngine->publishEvent<events::EventRenderableEnabled>(_parent);
        }
        else {
            global::eventEngine->publishEvent<events::EventRenderableDisabled>(_parent);
        }
    });

    _opacity = p.opacity.value_or(_opacity);
    // We don't add the property here as subclasses should decide on their own whether
    // they to expose the opacity or not

    addProperty(Fadeable::_fade);

    // set type for UI
    _renderableType = p.type.value_or(_renderableType);
    _renderableType.setReadOnly(true);
    addProperty(_renderableType);

    _dimInAtmosphere = p.dimInAtmosphere.value_or(_dimInAtmosphere);
    addProperty(_dimInAtmosphere);
}

void Renderable::initialize() {}

void Renderable::initializeGL() {}

void Renderable::deinitialize() {}

void Renderable::deinitializeGL() {}

void Renderable::update(const UpdateData&) {}

void Renderable::render(const RenderData&, RendererTasks&) {}

void Renderable::renderSecondary(const RenderData&, RendererTasks&) {}

void Renderable::setBoundingSphere(double boundingSphere) {
    _boundingSphere = boundingSphere;
}

double Renderable::boundingSphere() const noexcept {
    return _boundingSphere;
}

void Renderable::setInteractionSphere(double interactionSphere) {
    _interactionSphere = interactionSphere;
}

double Renderable::interactionSphere() const noexcept {
    return _interactionSphere;
}

std::string_view Renderable::typeAsString() const noexcept {
    return _renderableType;
}

SurfacePositionHandle Renderable::calculateSurfacePositionHandle(
                                                 const glm::dvec3& targetModelSpace) const
{
    const glm::dvec3 directionFromCenterToTarget = glm::normalize(targetModelSpace);
    return {
        directionFromCenterToTarget * _parent->interactionSphere(),
        directionFromCenterToTarget,
        0.0
    };
}

Ellipsoid Renderable::ellipsoid() const {
    return Ellipsoid(glm::dvec3(_interactionSphere));
}

bool Renderable::renderedWithDesiredData() const {
    return true;
}

Renderable::RenderBin Renderable::renderBin() const {
    return _renderBin;
}

void Renderable::setRenderBin(RenderBin bin) {
    _renderBin = bin;
}

bool Renderable::matchesRenderBinMask(int binMask) const noexcept {
    return binMask & static_cast<int>(_renderBin);
}

bool Renderable::matchesSecondaryRenderBin(int binMask) const noexcept {
    if (!_secondaryRenderBin.has_value()) {
        return false;
    }
    return binMask & static_cast<int>(*_secondaryRenderBin);
}

bool Renderable::isVisible() const {
    return _enabled && Fadeable::isVisible();
}

bool Renderable::isReady() const {
    return true;
}

bool Renderable::isEnabled() const {
    return _enabled;
}

bool Renderable::shouldUpdateIfDisabled() const noexcept {
    return _shouldUpdateIfDisabled;
}

void Renderable::onEnabledChange(std::function<void(bool)> callback) {
    _enabled.onChange([this, c = std::move(callback)]() {
        c(isEnabled());
    });
}

void Renderable::setRenderBinFromOpacity() {
    if ((_renderBin != Renderable::RenderBin::PostDeferredTransparent) &&
        (_renderBin != Renderable::RenderBin::Overlay))
    {
        const float v = opacity();
        if (v >= 0.f && v < 1.f) {
            setRenderBin(Renderable::RenderBin::PreDeferredTransparent);
        }
        else {
            setRenderBin(Renderable::RenderBin::Opaque);
        }
    }
}

void Renderable::registerUpdateRenderBinFromOpacity() {
    _opacity.onChange([this]() { setRenderBinFromOpacity(); });
    _fade.onChange([this]() { setRenderBinFromOpacity(); });

    _automaticallyUpdateRenderBin = true;
}

float Renderable::opacity() const noexcept {
    // Rendering should depend on if camera is in the atmosphere and if camera is at the
    // dark part of the globe
    const float dimming = _dimInAtmosphere ?
        global::navigationHandler->camera()->atmosphereDimmingFactor() :
        1.f;
    return dimming * Fadeable::opacity();
}

SceneGraphNode* Renderable::parent() const noexcept {
    ghoul_assert(dynamic_cast<SceneGraphNode*>(owner()), "Owner is not a SceneGraphNode");
    return static_cast<SceneGraphNode*>(owner());
}

bool Renderable::automaticallyUpdatesRenderBin() const noexcept {
    return _automaticallyUpdateRenderBin;
}

bool Renderable::hasOverrideRenderBin() const noexcept {
    return _hasOverrideRenderBin;
}

glm::dmat4 Renderable::calcModelTransform(const RenderData& data,
                                          const AlternativeTransform& altTransform) const
{
    const glm::dvec3 translation =
        altTransform.translation.value_or(data.modelTransform.translation);
    const glm::dmat3 rot = altTransform.rotation.value_or(data.modelTransform.rotation);
    const glm::dvec3 scale = altTransform.scale.value_or(data.modelTransform.scale);

    return glm::translate(glm::dmat4(1.0), translation) *
        glm::dmat4(rot) *
        glm::scale(glm::dmat4(1.0), scale);
}

glm::dmat4 Renderable::calcModelViewTransform(const RenderData& data,
                                    const std::optional<glm::dmat4>& modelTransform) const
{
    const glm::dmat4 modelMatrix = modelTransform.value_or(calcModelTransform(data));
    return data.camera.combinedViewMatrix() * modelMatrix;
}

glm::dmat4 Renderable::calcModelViewProjectionTransform(const RenderData& data,
                                    const std::optional<glm::dmat4>& modelTransform) const
{
    const glm::dmat4& modelMatrix = modelTransform.value_or(calcModelTransform(data));
    const glm::dmat4 viewMatrix = data.camera.combinedViewMatrix();
    const glm::dmat4 projectionMatrix = data.camera.projectionMatrix();
    return glm::dmat4(projectionMatrix * viewMatrix * modelMatrix);
}

std::tuple<glm::dmat4, glm::dmat4, glm::dmat4> Renderable::calcAllTransforms(
                                                                   const RenderData& data,
                                      const AlternativeTransform& altModelTransform) const
{
    const glm::dmat4 modelTransform = calcModelTransform(data, altModelTransform);
    const glm::dmat4 modelViewTransform = calcModelViewTransform(data, modelTransform);
    const glm::dmat4 modelViewProjectionTransform = calcModelViewProjectionTransform(
        data,
        modelTransform
    );

    return {
        modelTransform,
        modelViewTransform,
        modelViewProjectionTransform
    };
}

}  // namespace openspace