Engine.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/Properties.h>
#include <platform/core/common/PropertyMap.h>
#include <platform/core/common/Statistics.h>
 
#include <functional>
 
namespace core
{
class Engine
{
public:
    PLATFORM_API virtual void commit();
 
    PLATFORM_API virtual void preRender();
 
    PLATFORM_API virtual void postRender();
 
    PLATFORM_API virtual Vector2ui getMinimumFrameSize() const = 0;
 
    PLATFORM_API virtual FrameBufferPtr createFrameBuffer(const std::string& name, const Vector2ui& frameSize,
                                                          FrameBufferFormat frameBufferFormat) const = 0;
 
    PLATFORM_API virtual ScenePtr createScene(AnimationParameters& animationParameters,
                                              GeometryParameters& geometryParameters,
                                              VolumeParameters& volumeParameters,
                                              FieldParameters& fieldParameters) const = 0;
 
    PLATFORM_API virtual CameraPtr createCamera() const = 0;
 
    PLATFORM_API virtual RendererPtr createRenderer(const AnimationParameters& animationParameters,
                                                    const RenderingParameters& renderingParameters) const = 0;
 
    PLATFORM_API explicit Engine(ParametersManager& parametersManager);
 
    PLATFORM_API virtual ~Engine() = default;
 
    PLATFORM_API void render();
 
    PLATFORM_API Scene& getScene() { return *_scene; }
 
    PLATFORM_API FrameBuffer& getFrameBuffer() { return *_frameBuffers[0]; }
 
    PLATFORM_API const Camera& getCamera() const { return *_camera; }
    PLATFORM_API Camera& getCamera() { return *_camera; }
 
    PLATFORM_API Renderer& getRenderer();
 
    PLATFORM_API std::function<void()> triggerRender{[] {}};
 
    PLATFORM_API void setKeepRunning(bool keepRunning) { _keepRunning = keepRunning; }
 
    PLATFORM_API bool getKeepRunning() const { return _keepRunning; }
 
    PLATFORM_API Statistics& getStatistics() { return _statistics; }
 
    PLATFORM_API bool continueRendering() const;
 
    PLATFORM_API const auto& getParametersManager() const { return _parametersManager; }
 
    PLATFORM_API void addFrameBuffer(FrameBufferPtr frameBuffer);
 
    PLATFORM_API void removeFrameBuffer(FrameBufferPtr frameBuffer);
 
    PLATFORM_API const std::vector<FrameBufferPtr>& getFrameBuffers() const { return _frameBuffers; }
 
    PLATFORM_API void clearFrameBuffers();
 
    PLATFORM_API void resetFrameBuffers();
 
    PLATFORM_API void setRendererType(const std::string& name) { _rendererType = name; }
 
    PLATFORM_API void addRendererType(const std::string& name, const PropertyMap& properties = {});
 
    PLATFORM_API const strings& getRendererTypes() const { return _rendererTypes; };
 
    PLATFORM_API void addCameraType(const std::string& name, const PropertyMap& properties = {});
 
protected:
    std::string _rendererType{RENDERER_PROPERTY_TYPE_BASIC};
    ParametersManager& _parametersManager;
    ScenePtr _scene;
    CameraPtr _camera;
    RendererPtr _renderer;
    std::vector<FrameBufferPtr> _frameBuffers;
    Statistics _statistics;
    strings _rendererTypes;
    bool _keepRunning{true};
};
} // namespace core