Loader.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2024, EPFL/Blue Brain Project
 *
 * Responsible Author: Daniel.Nachbaur@epfl.ch
 *
 * This file is part of Blue Brain BioExplorer <https://github.com/BlueBrain/BioExplorer>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3.0 as published
 * by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <platform/core/common/PropertyMap.h>
#include <platform/core/common/Types.h>
 
#include <functional>
 
#ifdef BRAYNS_USE_OPENMP
#include <omp.h>
#endif
 
namespace core
{
class LoaderProgress
{
public:
    using CallbackFn = std::function<void(const std::string&, float)>;
 
    LoaderProgress(CallbackFn callback)
        : _callback(std::move(callback))
    {
    }
 
    LoaderProgress() = default;
    ~LoaderProgress() = default;
 
    void updateProgress(const std::string& message, const float fraction) const
    {
#ifdef BRAYNS_USE_OPENMP
        if (omp_get_thread_num() == 0)
#endif
            if (_callback)
                _callback(message, fraction);
    }
 
    CallbackFn _callback;
};
 
class Loader
{
public:
    Loader(Scene& scene)
        : _scene(scene)
    {
    }
 
    virtual ~Loader() = default;
 
    virtual std::vector<std::string> getSupportedStorage() const = 0;
 
    virtual std::string getName() const = 0;
 
    virtual PropertyMap getProperties() const { return {}; }
    virtual ModelDescriptorPtr importFromBlob(Blob&& blob, const LoaderProgress& callback,
                                              const PropertyMap& properties) const = 0;
 
    virtual ModelDescriptorPtr importFromStorage(const std::string& storage, const LoaderProgress& callback,
                                                 const PropertyMap& properties) const = 0;
 
    virtual bool isSupported(const std::string& filename, const std::string& extension) const = 0;
 
protected:
    Scene& _scene;
};
} // namespace core