Scene.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2024, EPFL/Blue Brain Project
 *
 * The Blue Brain BioExplorer is a tool for scientists to extract and analyse
 * scientific data from visualization
 *
 * 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/Api.h>
#include <platform/core/common/BaseObject.h>
#include <platform/core/common/Types.h>
#include <platform/core/common/loader/LoaderRegistry.h>
#include <platform/core/engineapi/LightManager.h>
 
#include <shared_mutex>
 
SERIALIZATION_ACCESS(Scene)
 
namespace core
{
class Scene : public BaseObject
{
public:
    PLATFORM_API virtual void commit();
 
    PLATFORM_API virtual bool commitLights() = 0;
 
    PLATFORM_API virtual ModelPtr createModel() const = 0;
 
    PLATFORM_API Scene(AnimationParameters& animationParameters, GeometryParameters& geometryParameters,
                       VolumeParameters& volumeParameters, FieldParameters& fieldParameters);
    PLATFORM_API const Boxd& getBounds() const { return _bounds; }
 
    PLATFORM_API LightManager& getLightManager() { return _lightManager; }
 
    PLATFORM_API size_t addModel(ModelDescriptorPtr model);
 
    PLATFORM_API bool removeModel(const size_t id);
    PLATFORM_API const ModelDescriptors& getModelDescriptors() const { return _modelDescriptors; }
 
    PLATFORM_API ModelDescriptorPtr getModel(const size_t id) const;
 
    PLATFORM_API void buildDefault();
 
    PLATFORM_API bool empty() const;
 
    PLATFORM_API size_t addClipPlane(const Plane& plane);
 
    PLATFORM_API ClipPlanePtr getClipPlane(const size_t id) const;
 
    PLATFORM_API void removeClipPlane(const size_t id);
 
    PLATFORM_API const ClipPlanes& getClipPlanes() const { return _clipPlanes; }
 
    PLATFORM_API size_t getSizeInBytes() const;
 
    PLATFORM_API size_t getNumModels() const;
 
    PLATFORM_API void setMaterialsColorMap(MaterialsColorMap colorMap);
 
    PLATFORM_API bool setEnvironmentMap(const std::string& envMap);
 
    PLATFORM_API const std::string& getEnvironmentMap() const { return _environmentMap; }
 
    PLATFORM_API bool hasEnvironmentMap() const;
 
    PLATFORM_API MaterialPtr getBackgroundMaterial() const { return _backgroundMaterial; }
 
    PLATFORM_API ModelDescriptorPtr loadModel(Blob&& blob, const ModelParams& params, LoaderProgress cb);
 
    PLATFORM_API ModelDescriptorPtr loadModel(const std::string& path, const ModelParams& params, LoaderProgress cb);
 
    PLATFORM_API void visitModels(const std::function<void(Model&)>& functor);
 
    PLATFORM_API LoaderRegistry& getLoaderRegistry() { return _loaderRegistry; }
 
    PLATFORM_API auto acquireReadAccess() const { return std::shared_lock<std::shared_timed_mutex>(_modelMutex); }
 
    PLATFORM_API void copyFrom(const Scene& rhs);
 
    PLATFORM_API void computeBounds();
 
protected:
    virtual bool supportsConcurrentSceneUpdates() const { return false; }
 
    void _loadIBLMaps(const std::string& envMap);
 
    AnimationParameters& _animationParameters;
    GeometryParameters& _geometryParameters;
    VolumeParameters& _volumeParameters;
    FieldParameters& _fieldParameters;
    MaterialPtr _backgroundMaterial{nullptr};
    std::string _environmentMap;
 
    size_t _modelID{0};
    ModelDescriptors _modelDescriptors;
    mutable std::shared_timed_mutex _modelMutex;
 
    LightManager _lightManager;
    ClipPlanes _clipPlanes;
 
    LoaderRegistry _loaderRegistry;
    Boxd _bounds;
 
private:
    SERIALIZATION_FRIEND(Scene)
};
} // namespace core