render-drive.hpp

Go to the documentation of this file.

/*
  RENDER-DRIVE.hpp  -  repetitively advancing a render calculation stream

  Copyright (C)         Lumiera.org
    2023,               Hermann Vosseler <Ichthyostega@web.de>

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of
  the License, or (at your option) any later version.

  This program 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 General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/


#ifndef STEAM_ENGINE_RENDER_DRIVE_H
#define STEAM_ENGINE_RENDER_DRIVE_H

#include "steam/common.hpp"
#include "steam/mobject/model-port.hpp"
#include "steam/engine/dispatcher.hpp"
#include "steam/play/timings.hpp"
#include "vault/gear/job.h"
//#include "lib/nocopy.hpp"


namespace steam {
namespace engine {
  
//  using std::function;
  using vault::gear::JobParameter;
  using vault::gear::JobClosure;
  using mobject::ModelPort;
//  using lib::time::TimeSpan;
//  using lib::time::FSecs;
//  using lib::time::Time;
  using lib::time::FrameCnt;
  using lib::HashVal;
  
  
  class RenderEnvironment
    {
    public:
      virtual ~RenderEnvironment() { }   
      
      virtual play::Timings& effectiveTimings()   =0;
      virtual Dispatcher&    getDispatcher()      =0;
    };
  
  
  class RenderDrive
    : public JobClosure
    {
      
      RenderEnvironment& engine_;
      
//    const ModelPort modelPort_;
//    const uint channel_;
      
      
      /* === JobClosure Interface === */
      
      JobKind
      getJobKind()  const
        {
          return META_JOB;
        }
      
      size_t hashOfInstance (InvocationInstanceID)  const override;
      InvocationInstanceID buildInstanceID(HashVal) const override;
      
      void invokeJobOperation (JobParameter)              override;
      
      
      
      
    public:
      RenderDrive (RenderEnvironment& renderEnvironment
                  ,ModelPort port, uint chan)
        : engine_{renderEnvironment}
        { }
      
      
      play::Timings const&
      getTimings()  const
        {
          return engine_.effectiveTimings();
        }
      
      Job prepareRenderPlanningFrom (FrameCnt startFrame);
      
      
    private:
      void performJobPlanningChunk(FrameCnt nextStartFrame);
      Job buildFollowUpJobFrom (Time refPoint);
    };
  
  
  
}} // namespace steam::engine
#endif /*STEAM_ENGINE_RENDER_DRIVE_H*/