MovieSceneFwd.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Stats/Stats.h"
#include "Misc/EnumClassFlags.h"
#include "HAL/PreprocessorHelpers.h"
 
#include "MovieSceneFwd.generated.h"
 
#ifndef UE_MOVIESCENE_EVENTS
    #define UE_MOVIESCENE_EVENTS WITH_EDITOR
#endif
 
#ifndef UE_MOVIESCENE_EXPENSIVE_CONSISTENCY_CHECKS
    #define UE_MOVIESCENE_EXPENSIVE_CONSISTENCY_CHECKS 0
#endif
 
#ifndef UE_MOVIESCENE_ENTITY_DEBUG
    #define UE_MOVIESCENE_ENTITY_DEBUG !UE_BUILD_SHIPPING
#endif
 
#ifndef MOVIESCENE_DETAILED_STATS
    #define MOVIESCENE_DETAILED_STATS 0
#endif
 
struct FFrameRate;
struct FFrameNumber;
class UObject;
 
namespace UE::MovieScene
{
 
    class ISequenceDataEventHandler;
 
} // namespace UE::MovieScene
 
UENUM()
namespace EMovieScenePlayerStatus
{
    enum Type : int
    {
        Stopped,
        Playing,
        Scrubbing,
        Jumping,
        Stepping,
        Paused,
        MAX
    };
}
 
UENUM(BlueprintType)
enum class EMovieSceneEvaluationType : uint8
{
    FrameLocked,
 
    WithSubFrames,
};
 
UENUM(BlueprintType)
enum class EUpdateClockSource : uint8
{
    Tick,
 
    Platform,
 
    Audio,
 
    RelativeTimecode,
 
    Timecode,
 
    PlayEveryFrame,
 
    Custom,
};
 
 
UENUM(Flags)
enum class EMovieSceneSequenceFlags : uint8
{
    None = 0 UMETA(Hidden),
 
    Volatile = 1 << 0,
 
    BlockingEvaluation = 1 << 1,
 
    DynamicWeighting = 1 << 2,
 
    LoopCuts = 1 << 3,
 
    InheritedFlags = Volatile UMETA(Hidden),
};
ENUM_CLASS_FLAGS(EMovieSceneSequenceFlags);
 
 
UENUM(Flags, meta=(Bitflags, UseEnumValuesAsMaskValuesInEditor = "true"))
enum class EMovieSceneServerClientMask : uint8
{
    None           = 0 UMETA(Hidden),
    Server         = 1 << 0,
    Client         = 1 << 1,
 
    All            = Server | Client UMETA(Hidden)
};
ENUM_CLASS_FLAGS(EMovieSceneServerClientMask)
 
MOVIESCENE_API DECLARE_LOG_CATEGORY_EXTERN(LogMovieScene, Log, All);
MOVIESCENE_API DECLARE_LOG_CATEGORY_EXTERN(LogMovieSceneECS, Log, All);
 
DECLARE_STATS_GROUP(TEXT("Movie Scene Evaluation"), STATGROUP_MovieSceneEval, STATCAT_Advanced);
 
MOVIESCENE_API FFrameRate GetLegacyConversionFrameRate();
MOVIESCENE_API void EmitLegacyOutOfBoundsError(UObject* ErrorContext, FFrameRate InFrameRate, double InTime);
MOVIESCENE_API FFrameNumber UpgradeLegacyMovieSceneTime(UObject* ErrorContext, FFrameRate InFrameRate, double InTime);
 
 
#if MOVIESCENE_DETAILED_STATS
    #define MOVIESCENE_DETAILED_SCOPE_CYCLE_COUNTER SCOPE_CYCLE_COUNTER
#else
    #define MOVIESCENE_DETAILED_SCOPE_CYCLE_COUNTER(...)
#endif
 
 
#if defined(_MSC_VER)
    #define UE_MOVIESCENE_TODO_IMPL(x) __pragma (x)
#else
    #define UE_MOVIESCENE_TODO_IMPL(x) _Pragma (#x)
#endif
 
#ifdef UE_MOVIESCENE_TODOS
    #define UE_MOVIESCENE_TODO(MSG) UE_MOVIESCENE_TODO_IMPL(message("" __FILE__ "(" PREPROCESSOR_TO_STRING(__LINE__) "): warning TODO: " # MSG))
#else
    #define UE_MOVIESCENE_TODO(MSG)
#endif