AbstractSimulationHandler.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2024, EPFL/Blue Brain Project
 * All rights reserved. Do not distribute without permission.
 *
 * 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/Types.h>
 
namespace core
{
class AbstractSimulationHandler
{
public:
    virtual AbstractSimulationHandlerPtr clone() const = 0;
 
    virtual ~AbstractSimulationHandler();
 
    AbstractSimulationHandler& operator=(const AbstractSimulationHandler& rhs);
 
    PLATFORM_API virtual void bind(const MaterialPtr& /* material */){};
 
    PLATFORM_API virtual void unbind(const MaterialPtr& /* material */){};
 
    uint32_t getCurrentFrame() const { return _currentFrame; }
    virtual void* getFrameData(uint32_t frame) { return _frameData.data(); }
 
    uint64_t getFrameSize() const { return _frameSize; }
    void setFrameSize(const uint64_t frameSize) { _frameSize = frameSize; }
    uint32_t getNbFrames() const { return _nbFrames; }
    void setNbFrames(const uint32_t nbFrames) { _nbFrames = nbFrames; }
    double getDt() const { return _dt; }
    const std::string& getUnit() const { return _unit; }
    virtual bool isReady() const { return true; }
    virtual void waitReady() const {}
 
protected:
    uint32_t _getBoundedFrame(const uint32_t frame) const;
 
    uint32_t _currentFrame{std::numeric_limits<uint32_t>::max()};
    uint32_t _nbFrames{0};
    uint64_t _frameSize{0};
    double _dt{0};
    std::string _unit;
 
    floats _frameData;
};
} // namespace core