OpenSpace/modules/iswa/rendering/iswakameleongroup.cpp

/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2024                                                               *
 *                                                                                       *
 * 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/iswa/rendering/iswakameleongroup.h>

#include <modules/iswa/util/iswamanager.h>
#include <openspace/json.h>
#include <openspace/engine/globals.h>
#include <openspace/scripting/scriptengine.h>
#include <ghoul/logging/logmanager.h>
#include <fstream>

namespace {
    constexpr std::string_view _loggerCat = "IswaDataGroup";
    using json = nlohmann::json;

    constexpr openspace::properties::Property::PropertyInfo ResolutionInfo = {
        "Resolution",
        "Resolution",
        "", // @TODO Missing documentation
        openspace::properties::Property::Visibility::AdvancedUser
    };

    constexpr openspace::properties::Property::PropertyInfo FieldlineSeedInfo = {
        "FieldlineSeedsIndexFile",
        "Fieldline Seedpoints",
        "", // @TODO Missing documentation
        openspace::properties::Property::Visibility::Developer
    };
} // namespace

namespace openspace{
IswaKameleonGroup::IswaKameleonGroup(std::string name, std::string type)
    : IswaDataGroup(name, type)
    , _resolution(ResolutionInfo, 100.f, 10.f, 200.f)
    , _fieldlines(FieldlineSeedInfo)
{
    addProperty(_resolution);
    addProperty(_fieldlines);
    registerProperties();
}

IswaKameleonGroup::~IswaKameleonGroup() {}

void IswaKameleonGroup::clearGroup() {
    IswaBaseGroup::clearGroup();
    clearFieldlines();
}

std::set<std::string> IswaKameleonGroup::fieldlineValue() const {
    return _fieldlines;
}

void IswaKameleonGroup::setFieldlineInfo(std::string fieldlineIndexFile,
                                         std::string kameleonPath)
{
    if (fieldlineIndexFile != _fieldlineIndexFile) {
        _fieldlineIndexFile = std::move(fieldlineIndexFile);
        readFieldlinePaths(_fieldlineIndexFile);
    }

    if (kameleonPath != _kameleonPath) {
        _kameleonPath = std::move(kameleonPath);
        clearFieldlines();
        updateFieldlineSeeds();
    }
}

void IswaKameleonGroup::registerProperties() {
    _resolution.onChange([this]() {
        LDEBUG("Group " + identifier() + " published resolutionChanged");
        ghoul::Dictionary d;
        d.setValue("resolution", static_cast<double>(_resolution));
        _groupEvent.publish("resolutionChanged", d);
    });

    _fieldlines.onChange([this]() { updateFieldlineSeeds(); });
}

void IswaKameleonGroup::readFieldlinePaths(const std::string& indexFile) {
    LINFO(fmt::format("Reading seed points paths from file '{}'", indexFile));

    // Read the index file from disk
    std::ifstream seedFile(indexFile);
    if (!seedFile.good()) {
        LERROR(fmt::format("Could not open seed points file '{}'", indexFile));
    }
    else {
        std::string line;
        std::string fileContent;
        while (std::getline(seedFile, line)) {
            fileContent += line;
        }

        try {
            //Parse and add each fieldline as an selection
            json fieldlines = json::parse(fileContent);
            int i = 0;

            for (json::iterator it = fieldlines.begin(); it != fieldlines.end(); ++it) {
                _fieldlines.addOption(it.key());
                _fieldlineState[i] = std::make_tuple<std::string, std::string, bool>(
                    identifier() + "/" + it.key(),
                    it.value(),
                    false
                );
                i++;
            }

        } catch (const std::exception& e) {
            LERROR(
                "Error when reading json file with paths to seedpoints: " +
                std::string(e.what())
            );
        }
    }
}

void IswaKameleonGroup::updateFieldlineSeeds() {
    const std::set<std::string>& options = _fieldlines;
    std::vector<std::string> opts = _fieldlines.options();

    // SeedPath == map<int selectionValue, tuple<string name, string path, bool active>>
    using K = int;
    using V = std::tuple<std::string, std::string, bool>;
    for (std::pair<const K, V>& seedPath : _fieldlineState) {
        // if this option was turned off
        std::string o = opts[seedPath.first];
        const auto it = std::find(options.begin(), options.end(), o);
        if (it == options.end() && std::get<2>(seedPath.second)) {
            LDEBUG("Removed fieldlines: " + std::get<0>(seedPath.second));

            global::scriptEngine->queueScript(
                "openspace.removeSceneGraphNode('" + std::get<0>(seedPath.second) + "')",
                scripting::ScriptEngine::ShouldBeSynchronized::Yes,
                scripting::ScriptEngine::ShouldSendToRemote::Yes
            );
            std::get<2>(seedPath.second) = false;
        // if this option was turned on
        }
        else if (it != options.end() && !std::get<2>(seedPath.second)) {
            LDEBUG("Created fieldlines: " + std::get<0>(seedPath.second));

            IswaManager::ref().createFieldline(
                std::get<0>(seedPath.second),
                _kameleonPath,
                std::get<1>(seedPath.second)
            );
            std::get<2>(seedPath.second) = true;
        }
    }
}

void IswaKameleonGroup::clearFieldlines() {
    using K = int;
    using V = std::tuple<std::string, std::string, bool>;
    for (std::pair<const K, V>& seedPath : _fieldlineState) {
        if (std::get<2>(seedPath.second)) {
            LDEBUG("Removed fieldlines: " + std::get<0>(seedPath.second));

            global::scriptEngine->queueScript(
                "openspace.removeSceneGraphNode('" + std::get<0>(seedPath.second) + "')",
                scripting::ScriptEngine::ShouldBeSynchronized::Yes,
                scripting::ScriptEngine::ShouldSendToRemote::Yes
            );
            std::get<2>(seedPath.second) = false;
        }
    }
}

void IswaKameleonGroup::changeCdf(std::string path) {
    _kameleonPath = path;
    clearFieldlines();
    updateFieldlineSeeds();

    ghoul::Dictionary d;
    d.setValue("path", std::move(path));
    _groupEvent.publish("cdfChanged", d);
}

} //namespace openspace