simulation.h

Go to the documentation of this file.

#pragma once
 
#include <chrono>
#include <cstdint>
#include <vector>
 
namespace unravel
{
 
//-----------------------------------------------------------------------------
// Main Class Declarations
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
//  Name : simulation (Class)
//-----------------------------------------------------------------------------
struct simulation
{
    using clock_t = std::chrono::steady_clock;
    using timepoint_t = clock_t::time_point;
    using duration_t = clock_t::duration;
    using delta_t = std::chrono::duration<float>;
    simulation();
 
    //-----------------------------------------------------------------------------
    //  Name : run_one_frame ()
    //-----------------------------------------------------------------------------
    void run_one_frame(bool is_active);
 
    void reset_delta_clock();
 
    //-----------------------------------------------------------------------------
    //  Name : get_frame ()
    //-----------------------------------------------------------------------------
    auto get_frame() const -> uint64_t;
 
    //-----------------------------------------------------------------------------
    //  Name : set_min_fps ()
    //-----------------------------------------------------------------------------
    void set_min_fps(uint32_t fps);
 
    //-----------------------------------------------------------------------------
    //  Name : set_max_fps ()
    //-----------------------------------------------------------------------------
    void set_max_fps(uint32_t fps);
 
    //-----------------------------------------------------------------------------
    //  Name : set_max_inactive_fps ()
    //-----------------------------------------------------------------------------
    void set_max_inactive_fps(uint32_t fps);
 
    //-----------------------------------------------------------------------------
    //  Name : set_time_smoothing_step ()
    //-----------------------------------------------------------------------------
    void set_time_smoothing_step(uint32_t step);
 
    //-----------------------------------------------------------------------------
    //  Name : get_time_since_launch ()
    //-----------------------------------------------------------------------------
    auto get_time_since_launch() const -> duration_t;
 
    //-----------------------------------------------------------------------------
    //  Name : get_fps ()
    //-----------------------------------------------------------------------------
    auto get_fps() const -> float;
 
    //-----------------------------------------------------------------------------
    //  Name : get_delta_time ()
    //-----------------------------------------------------------------------------
    auto get_delta_time() const -> delta_t;
 
 
    void set_time_scale(float time_scale = 1.0f);
    auto get_time_scale() const -> float;
 
    //-----------------------------------------------------------------------------
    //  Name : get_max_fps ()
    //-----------------------------------------------------------------------------
    auto get_max_fps() const -> uint32_t;
 
    //-----------------------------------------------------------------------------
    //  Name : get_last_sleep_duration ()
    //-----------------------------------------------------------------------------
    auto get_last_sleep_duration() const -> duration_t;
 
protected:
    float time_scale_{1.0f};
    uint32_t min_fps_ = 0;
    uint32_t max_fps_ = 0;
    uint32_t max_inactive_fps_ = 20;
    std::vector<duration_t> previous_timesteps_;
    duration_t timestep_ = duration_t::zero();
    duration_t last_sleep_duration_ = duration_t::zero();
    uint64_t frame_ = 0;
    uint32_t smoothing_step_ = 11;
    timepoint_t last_frame_timepoint_ = clock_t::now();
    timepoint_t launch_timepoint_ = clock_t::now();
};
} // namespace unravel