MovieSceneFwd.h File Reference

#include "CoreTypes.h"
#include "Stats/Stats.h"
#include "Misc/EnumClassFlags.h"
#include "HAL/PreprocessorHelpers.h"
#include "MovieSceneFwd.generated.h"

Go to the source code of this file.

Namespaces
namespace	UE
namespace	UE::MovieScene
namespace	EMovieScenePlayerStatus

Macros
#define	UE_MOVIESCENE_EVENTS   WITH_EDITOR
#define	UE_MOVIESCENE_EXPENSIVE_CONSISTENCY_CHECKS   0
#define	UE_MOVIESCENE_ENTITY_DEBUG   !UE_BUILD_SHIPPING
#define	MOVIESCENE_DETAILED_STATS   0
#define	MOVIESCENE_DETAILED_SCOPE_CYCLE_COUNTER(...)
#define	UE_MOVIESCENE_TODO_IMPL(x)   _Pragma (#x)
#define	UE_MOVIESCENE_TODO(MSG)

Enumerations
enum	EMovieScenePlayerStatus::Type : int {   EMovieScenePlayerStatus::Stopped , EMovieScenePlayerStatus::Playing , EMovieScenePlayerStatus::Scrubbing , EMovieScenePlayerStatus::Jumping ,   EMovieScenePlayerStatus::Stepping , EMovieScenePlayerStatus::Paused , EMovieScenePlayerStatus::MAX }
enum class	EMovieSceneEvaluationType : uint8 { FrameLocked , WithSubFrames }
enum class	EUpdateClockSource : uint8 {   Tick , Platform , Audio , RelativeTimecode ,   Timecode , PlayEveryFrame , Custom }
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	EMovieSceneServerClientMask : uint8 { None = 0 UMETA(Hidden) , Server = 1 << 0 , Client = 1 << 1 , All = Server | Client UMETA(Hidden) }

Functions
	ENUM_CLASS_FLAGS (EMovieSceneSequenceFlags)
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)

Macro Definition Documentation

MOVIESCENE_DETAILED_SCOPE_CYCLE_COUNTER

#define MOVIESCENE_DETAILED_SCOPE_CYCLE_COUNTER

(

...

)

MOVIESCENE_DETAILED_STATS

#define MOVIESCENE_DETAILED_STATS   0

UE_MOVIESCENE_ENTITY_DEBUG

#define UE_MOVIESCENE_ENTITY_DEBUG   !UE_BUILD_SHIPPING

UE_MOVIESCENE_EVENTS

#define UE_MOVIESCENE_EVENTS   WITH_EDITOR

UE_MOVIESCENE_EXPENSIVE_CONSISTENCY_CHECKS

#define UE_MOVIESCENE_EXPENSIVE_CONSISTENCY_CHECKS   0

UE_MOVIESCENE_TODO

#define UE_MOVIESCENE_TODO

(

MSG

)

UE_MOVIESCENE_TODO_IMPL

#define UE_MOVIESCENE_TODO_IMPL

(

x

)

_Pragma (#x)

Enumeration Type Documentation

EMovieSceneEvaluationType

enum class EMovieSceneEvaluationType : uint8

strong

Enumerator
FrameLocked	Play the sequence frame-locked to its playback rate (snapped to the tick resolution - no sub-frames)
WithSubFrames	Play the sequence in real-time, with sub-frame interpolation if necessary

EMovieSceneSequenceFlags

enum class EMovieSceneSequenceFlags : uint8

strong

Bitfield flags that define special behavior for any UMovieSceneSequence.

Enumerator
None	Symbolic entry for no flags
Volatile	Flag signifying that this sequence can change dynamically at runtime or during the game so the template must be checked for validity and recompiled as necessary before each evaluation. The absence of this flag will result in the same compiled data being used for the duration of the program, as well as being pre-built during cook. As such, any dynamic changes to the sequence will not be reflected in the evaluation itself. This flag must be set if any procedural changes will be made to the source sequence data in-game.
BlockingEvaluation	Indicates that a sequence must fully evaluate and apply its state every time it is updated, blocking until complete. Should be used sparingly as it will severely affect performance.
DynamicWeighting	Indicates that a sequence will utilize dynamic weighting when it is played back. Setting this flag ensures that initial values are cached correctly so the sequence can be blended into and out of
LoopCuts	When enabled, the sequence considers looping as a jump/cut. When disabled, the sequence considers looping to be seamless.
InheritedFlags	Symbolic entry for all flags that should be inherited by parent sequences when present on a sub sequence

EMovieSceneServerClientMask

enum class EMovieSceneServerClientMask : uint8

strong

Enumerator
None
Server
Client
All

EUpdateClockSource

enum class EUpdateClockSource : uint8

strong

Enum used to define how to update to a particular time

Enumerator
Tick	Use the default world tick delta for timing. Honors world and actor pause state, but is susceptible to accumulation errors
Platform	Use the platform clock for timing. Does not honor world or actor pause state.
Audio	Use the audio clock for timing. Does not honor world or actor pause state.
RelativeTimecode	Time relative to the timecode provider for timing. Does not honor world or actor pause state.
Timecode	Use current timecode provider for timing. Does not honor world or actor pause state.
PlayEveryFrame	Debugging Tool: Hold on each whole frame for a Sequencer.SecondsPerFrame many wall-clock seconds before advancing to the next one. Does not honor world or actor pause state or time dilation and audio will be out of sync.
Custom	Custom clock source created and defined externally.

Function Documentation

DECLARE_LOG_CATEGORY_EXTERN() [1/2]

MOVIESCENE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogMovieScene	,
		Log	,
		All
	)

DECLARE_LOG_CATEGORY_EXTERN() [2/2]

MOVIESCENE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogMovieSceneECS	,
		Log	,
		All
	)

DECLARE_STATS_GROUP()

DECLARE_STATS_GROUP	(	TEXT("Movie Scene Evaluation")	,
		STATGROUP_MovieSceneEval	,
		STATCAT_Advanced
	)

EmitLegacyOutOfBoundsError()

MOVIESCENE_API void EmitLegacyOutOfBoundsError	(	UObject *	ErrorContext,
		FFrameRate	InFrameRate,
		double	InTime
	)

ENUM_CLASS_FLAGS()

ENUM_CLASS_FLAGS

(

EMovieSceneSequenceFlags

)

GetLegacyConversionFrameRate()

MOVIESCENE_API FFrameRate GetLegacyConversionFrameRate

(

)

UpgradeLegacyMovieSceneTime()

MOVIESCENE_API FFrameNumber UpgradeLegacyMovieSceneTime	(	UObject *	ErrorContext,
		FFrameRate	InFrameRate,
		double	InTime
	)