TimeManagementBlueprintLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "Misc/FrameNumber.h"
#include "Misc/FrameRate.h"
#include "Misc/FrameTime.h"
#include "Misc/QualifiedFrameTime.h"
#include "Misc/Timecode.h"
#include "UObject/ObjectMacros.h"
#include "UObject/UObjectGlobals.h"
 
#include "TimeManagementBlueprintLibrary.generated.h"
 
class UObject;
struct FFrame;
struct FQualifiedFrameTime;
 
UCLASS(meta = (BlueprintThreadSafe, ScriptName = "TimeManagementLibrary"), MinimalAPI)
class UTimeManagementBlueprintLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
public:
    UE_DEPRECATED(5.3, "Conv_FrameRateToSeconds has been deprecated, use Conv_FrameRateToInterval instead")
    UFUNCTION(BlueprintPure, meta = (DisplayName = "FrameRate To Seconds", BlueprintAutocast, DeprecatedFunction, DeprecationMessage = "FrameRateToInterval replaces this function, which returns the expected result of seconds per frame, rather than (incorrectly) frames per second."), Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API float Conv_FrameRateToSeconds(const FFrameRate& InFrameRate);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "FrameRate To Interval", BlueprintAutocast), Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API float Conv_FrameRateToInterval(const FFrameRate InFrameRate);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "QualifiedFrameTime To Seconds", BlueprintAutocast), Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API float Conv_QualifiedFrameTimeToSeconds(const FQualifiedFrameTime& InFrameTime);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Seconds * FrameRate", CompactNodeTitle = "*"), Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API FFrameTime Multiply_SecondsFrameRate(float TimeInSeconds, const FFrameRate& FrameRate);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Timecode To String", BlueprintAutocast), Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API FString Conv_TimecodeToString(const FTimecode& InTimecode, bool bForceSignDisplay = false);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Is Valid Frame Rate"), Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API bool IsValid_Framerate(const FFrameRate& InFrameRate);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Is Multiple Of"), Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API bool IsValid_MultipleOf(const FFrameRate& InFrameRate, const FFrameRate& OtherFramerate);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Transform Frame Time"), Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API FFrameTime TransformTime(const FFrameTime& SourceTime, const FFrameRate& SourceRate, const FFrameRate& DestinationRate);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "Snap Frame Time"), Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API FFrameTime SnapFrameTimeToRate(const FFrameTime& SourceTime, const FFrameRate& SourceRate, const FFrameRate& SnapToRate);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "FrameNumber + FrameNumber", CompactNodeTitle = "+", Keywords = "+ add plus", CommutativeAssociativeBinaryOperator = "true", ScriptMethod, ScriptMethodSelfReturn, ScriptOperator = "+;+="), Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API FFrameNumber Add_FrameNumberFrameNumber(FFrameNumber A, FFrameNumber B);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "FrameNumber - FrameNumber", CompactNodeTitle = "-", Keywords = "- subtract minus", ScriptMethod, ScriptMethodSelfReturn, ScriptOperator = "-;-="), Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API FFrameNumber Subtract_FrameNumberFrameNumber(FFrameNumber A, FFrameNumber B);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "FrameNumber + Int", CompactNodeTitle = "+", Keywords = "+ add plus", ScriptMethod, ScriptMethodSelfReturn, ScriptOperator = "+;+="), Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API FFrameNumber Add_FrameNumberInteger(FFrameNumber A, int32 B);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "FrameNumber - Int", CompactNodeTitle = "-", Keywords = "- subtract minus", ScriptMethod, ScriptMethodSelfReturn, ScriptOperator = "-;-="), Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API FFrameNumber Subtract_FrameNumberInteger(FFrameNumber A, int32 B);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "FrameNumber * Int", CompactNodeTitle = "*", Keywords = "* multiply", ScriptMethod, ScriptMethodSelfReturn, ScriptOperator = "*;*="), Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API FFrameNumber Multiply_FrameNumberInteger(FFrameNumber A, int32 B);
 
    UFUNCTION(BlueprintPure, meta = (DisplayName = "FrameNumber / FrameNumber", CompactNodeTitle = "/", Keywords = "/ divide", ScriptMethod, ScriptMethodSelfReturn, ScriptOperator = "/;/="), Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API FFrameNumber Divide_FrameNumberInteger(FFrameNumber A, int32 B);
    
    UFUNCTION(BlueprintPure, meta = (DisplayName = "FrameNumber to Integer", ScriptName="FrameNumberToInteger", BlueprintAutocast), Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API int32 Conv_FrameNumberToInteger(const FFrameNumber& InFrameNumber);
 
public:
    UFUNCTION(BlueprintPure, Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API FTimecode GetTimecode();
 
    UFUNCTION(BlueprintPure, Category = "Utilities|Time Management")
    static TIMEMANAGEMENT_API FFrameRate GetTimecodeFrameRate();
};