CatchupFixedRateCustomTimeStep.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "FixedFrameRateCustomTimeStep.h"
#include "Estimation/IClockedTimeStep.h"
#include "CatchupFixedRateCustomTimeStep.generated.h"
 
class UEngine;
class UObject;
 
UCLASS(Blueprintable, editinlinenew, meta = (DisplayName = "Catchup Fixed Rate"), MinimalAPI)
class UCatchupFixedRateCustomTimeStep : public UFixedFrameRateCustomTimeStep, public IClockedTimeStep
{
    GENERATED_UCLASS_BODY()
 
public:
    
    //~ Begin UFixedFrameRateCustomTimeStep interface
    TIMEMANAGEMENT_API virtual bool Initialize(UEngine* InEngine) override;
    TIMEMANAGEMENT_API virtual void Shutdown(UEngine* InEngine) override;
    TIMEMANAGEMENT_API virtual bool UpdateTimeStep(UEngine* InEngine) override;
    TIMEMANAGEMENT_API virtual ECustomTimeStepSynchronizationState GetSynchronizationState() const override;
    TIMEMANAGEMENT_API virtual FFrameRate GetFixedFrameRate() const override;
    //~ End UFixedFrameRateCustomTimeStep interface
 
    //~ Begin IClockedTimeStep interface
    TIMEMANAGEMENT_API virtual TOptional<double> GetUnderlyingClockTime_AnyThread() override;
    //~ End IClockedTimeStep interface
    
private:
 
    void BlockUntilPlatformSeconds(const double TargetPlatformSeconds) const;
 
    double CalculateDeltaSeconds(const double CurrentSimulationSeconds, const double CurrentPlatformSeconds) const;
 
public:
 
    UPROPERTY(EditAnywhere, Category = "Timing")
    FFrameRate FrameRate;
 
    UPROPERTY(EditAnywhere, Category = "Timing", meta = (ClampMin = "2"))
    double MaxCatchupSeconds = 16;
 
private:
 
    /* Keeps track of our simulation time, which is intentionally kept close to platform time */
    double SimulationSeconds = 0;
 
};