OpenSpace/modules/globebrowsing/src/tileprovider/tileproviderbylevel.cpp

/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2023                                                               *
 *                                                                                       *
 * 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/globebrowsing/src/tileprovider/tileproviderbylevel.h>

#include <openspace/documentation/documentation.h>

namespace {
    struct [[codegen::Dictionary(TileProviderByLevel)]] Parameters {
        int layerGroupID;

        struct Provider {
            int maxLevel [[codegen::greaterequal(0)]];
            ghoul::Dictionary tileProvider;
        };
        std::vector<Provider> levelTileProviders;
    };
#include "tileproviderbylevel_codegen.cpp"
} // namespace

namespace openspace::globebrowsing {

documentation::Documentation TileProviderByLevel::Documentation() {
    return codegen::doc<Parameters>("globebrowsing_tileproviderbylevel");
}

TileProviderByLevel::TileProviderByLevel(const ghoul::Dictionary& dictionary) {
    ZoneScoped;

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

    layers::Group::ID group = static_cast<layers::Group::ID>(p.layerGroupID);

    for (Parameters::Provider provider : p.levelTileProviders) {
        ghoul::Dictionary& tileProviderDict = provider.tileProvider;
        tileProviderDict.setValue("LayerGroupID", static_cast<int>(group));

        // Pass down the caching information from the enclosing dictionary
        if (dictionary.hasValue<std::string>("GlobeName")) {
            tileProviderDict.setValue(
                "GlobeName",
                dictionary.value<std::string>("GlobeName")
            );
        }
        layers::Layer::ID typeID = layers::Layer::ID::DefaultTileProvider;
        if (tileProviderDict.hasValue<std::string>("Type")) {
            std::string type = tileProviderDict.value<std::string>("Type");
            typeID = ghoul::from_string<layers::Layer::ID>(type);
        }

        std::unique_ptr<TileProvider> tp = createFromDictionary(typeID, tileProviderDict);

        std::string provId = tileProviderDict.value<std::string>("Identifier");
        tp->setIdentifier(provId);
        std::string providerName = tileProviderDict.value<std::string>("Name");
        tp->setGuiName(providerName);
        addPropertySubOwner(tp.get());

        _levelTileProviders.push_back(std::move(tp));

        // Ensure we can represent the max level
        if (static_cast<int>(_providerIndices.size()) < provider.maxLevel) {
            _providerIndices.resize(provider.maxLevel + 1, -1);
        }

        // map this level to the tile provider index
        _providerIndices[provider.maxLevel] =
            static_cast<int>(_levelTileProviders.size()) - 1;
    }

    // Fill in the gaps (value -1) in provider indices, from back to end
    for (int i = static_cast<int>(_providerIndices.size()) - 2; i >= 0; --i) {
        if (_providerIndices[i] == -1) {
            _providerIndices[i] = _providerIndices[i + 1];
        }
    }
}

void TileProviderByLevel::internalInitialize() {
    for (const std::unique_ptr<TileProvider>& prov : _levelTileProviders) {
        prov->initialize();
    }
}

void TileProviderByLevel::internalDeinitialize() {
    for (const std::unique_ptr<TileProvider>& prov : _levelTileProviders) {
        prov->deinitialize();
    }
}

Tile TileProviderByLevel::tile(const TileIndex& tileIndex) {
    ZoneScoped;

    TileProvider* provider = levelProvider(tileIndex.level);
    if (provider) {
        return provider->tile(tileIndex);
    }
    else {
        return Tile();
    }
}

Tile::Status TileProviderByLevel::tileStatus(const TileIndex& index) {
    TileProvider* provider = levelProvider(index.level);
    return provider ? provider->tileStatus(index) : Tile::Status::Unavailable;
}

TileProvider* TileProviderByLevel::levelProvider(int level) const {
    ZoneScoped;

    if (!_levelTileProviders.empty()) {
        int clampedLevel = glm::clamp(
            level,
            0,
            static_cast<int>(_providerIndices.size() - 1)
        );
        int idx = _providerIndices[clampedLevel];
        return _levelTileProviders[idx].get();
    }
    else {
        return nullptr;
    }
}

TileDepthTransform TileProviderByLevel::depthTransform() {
    return { 0.f, 1.f };
}

void TileProviderByLevel::update() {
    for (const std::unique_ptr<TileProvider>& provider : _levelTileProviders) {
        provider->update();
    }
}

void TileProviderByLevel::reset() {
    for (const std::unique_ptr<TileProvider>& provider : _levelTileProviders) {
        provider->reset();
    }
}

int TileProviderByLevel::minLevel() {
    return 1;
}

int TileProviderByLevel::maxLevel() {
    return static_cast<int>(_providerIndices.size() - 1);
}

float TileProviderByLevel::noDataValueAsFloat() {
    return std::numeric_limits<float>::min();
}

} // namespace openspace::globebrowsing