Renderer.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/PropertyObject.h>
#include <platform/core/parameters/AnimationParameters.h>
#include <platform/core/parameters/RenderingParameters.h>
 
SERIALIZATION_ACCESS(Renderer)
 
namespace core
{
class Renderer : public PropertyObject
{
public:
    struct PickResult
    {
        bool hit{false}; // boolean value that defines if the ray hits anything
        Vector3d pos;    // vector position of the ray intersection
    };
 
    virtual void render(FrameBufferPtr frameBuffer) = 0;
 
    virtual float getVariance() const { return 0.f; }
 
    virtual void commit() = 0;
 
    virtual void setCamera(CameraPtr camera) = 0;
 
    virtual PickResult pick(const Vector2f& /*pickPos*/) { return PickResult(); }
 
    PLATFORM_API Renderer(const AnimationParameters& animationParameters,
                          const RenderingParameters& renderingParameters);
    void setEngine(Engine* engine) { _engine = engine; };
 
    PLATFORM_API bool getHeadLight() const { return _headLight; }
    PLATFORM_API void setHeadLight(const bool value) { _updateValue(_headLight, value); }
 
    PLATFORM_API void setMaxAccumFrames(const size_t value) { _updateValue(_maxAccumFrames, value); }
    PLATFORM_API size_t getMaxAccumFrames() const { return _maxAccumFrames; }
 
    PLATFORM_API uint32_t getSamplesPerPixel() const { return _spp; }
    PLATFORM_API void setSamplesPerPixel(const uint32_t value) { _updateValue(_spp, std::max(1u, value)); }
 
    PLATFORM_API uint32_t getSubsampling() const { return _subsampling; }
    PLATFORM_API void setSubsampling(const uint32_t subsampling)
    {
        _updateValue(_subsampling, std::max(1u, subsampling));
    }
 
    PLATFORM_API const Vector3d& getBackgroundColor() const { return _backgroundColor; }
    PLATFORM_API void setBackgroundColor(const Vector3d& value) { _updateValue(_backgroundColor, value); }
 
    PLATFORM_API bool getAccumulation() const { return _accumulation; }
 
protected:
    const AnimationParameters& _animationParameters;
    const RenderingParameters& _renderingParameters;
    Engine* _engine{nullptr};
 
    bool _accumulation{true};
    bool _headLight{true};
    Vector3d _backgroundColor{0., 0., 0.};
    uint32_t _spp{1};
    uint32_t _subsampling{1};
    size_t _maxAccumFrames{100};
 
private:
    SERIALIZATION_FRIEND(Renderer);
};
} // namespace core