Ticker.h

// Copyright (c) 2016-2018 Kiwano - Nomango
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#pragma once
#include <kiwano/utils/Timer.h>
 
namespace kiwano
{
 
class KGE_API Ticker : public ObjectBase
{
public:
    Ticker(Duration interval, int tick_count = -1);
 
    Ticker();
 
    virtual bool Tick();
 
    virtual bool Tick(Duration dt);
 
    Duration GetDeltaTime();
 
    bool IsPausing() const;
 
    void Pause();
 
    void Resume();
 
    int GetTickedCount() const;
 
    int GetTotalTickCount() const;
 
    void SetTotalTickCount(int count);
 
    Duration GetInterval() const;
 
    void SetInterval(Duration interval);
 
    Duration GetErrorTime() const;
 
    RefPtr<Timer> GetTimer();
 
    void SetTimer(RefPtr<Timer> timer);
 
    void Reset();
 
private:
    bool          is_paused_;
    int           ticked_count_;
    int           total_tick_count_;
    Duration      interval_;
    Duration      elapsed_time_;
    Duration      delta_time_;
    Duration      error_time_;
    RefPtr<Timer> timer_;
};
 
inline bool Ticker::IsPausing() const
{
    return is_paused_;
}
 
inline int Ticker::GetTickedCount() const
{
    return ticked_count_;
}
 
inline int Ticker::GetTotalTickCount() const
{
    return total_tick_count_;
}
 
inline void Ticker::SetTotalTickCount(int count)
{
    total_tick_count_ = count;
}
 
inline Duration Ticker::GetInterval() const
{
    return interval_;
}
 
inline void Ticker::SetInterval(Duration interval)
{
    interval_ = interval;
}
 
inline Duration Ticker::GetErrorTime() const
{
    return error_time_;
}
 
}  // namespace kiwano