FMovieSceneEvalTemplateBase Struct Reference

#include <MovieSceneEvalTemplateBase.h>

Inheritance diagram for FMovieSceneEvalTemplateBase:

Public Member Functions
	FMovieSceneEvalTemplateBase ()
virtual	~FMovieSceneEvalTemplateBase ()
UScriptStruct &	GetScriptStruct () const
bool	RequiresSetup () const
bool	RequiresTearDown () const
void	OnBeginEvaluation (FPersistentEvaluationData &PersistentData, IMovieScenePlayer &Player) const
void	OnEndEvaluation (FPersistentEvaluationData &PersistentData, IMovieScenePlayer &Player) const
virtual void	SetupOverrides ()

Protected Types
enum	EOverrideMask { RequiresSetupFlag = 0x001 , RequiresTearDownFlag = 0x002 }

Protected Member Functions
virtual void	Setup (FPersistentEvaluationData &PersistentData, IMovieScenePlayer &Player) const
virtual void	TearDown (FPersistentEvaluationData &PersistentData, IMovieScenePlayer &Player) const
virtual UScriptStruct &	GetScriptStructImpl () const
void	EnableOverrides (uint8 OverrideFlag)

Protected Attributes
uint8	OverrideMask

Detailed Description

Base structure used for all movie scene evaluation templates

Member Enumeration Documentation

EOverrideMask

enum FMovieSceneEvalTemplateBase::EOverrideMask

protected

Base class flag mask that should be considered by any implementations of FMovieSceneEvalTemplateBase

Enumerator
RequiresSetupFlag
RequiresTearDownFlag

Constructor & Destructor Documentation

FMovieSceneEvalTemplateBase()

FMovieSceneEvalTemplateBase::FMovieSceneEvalTemplateBase ( )

inline

Default constructor

~FMovieSceneEvalTemplateBase()

virtual FMovieSceneEvalTemplateBase::~FMovieSceneEvalTemplateBase ( )

inlinevirtual

Virtual destruction

Member Function Documentation

EnableOverrides()

void FMovieSceneEvalTemplateBase::EnableOverrides ( uint8  OverrideFlag )

inlineprotected

Enable the overrides referred to by the specified flag mask

GetScriptStruct()

UScriptStruct & FMovieSceneEvalTemplateBase::GetScriptStruct ( ) const

inline

Access the most derived script struct type of this instance for serialization purposes

GetScriptStructImpl()

virtual UScriptStruct & FMovieSceneEvalTemplateBase::GetScriptStructImpl ( ) const

inlineprotectedvirtual

Retrieve the script struct pertaining to the most-derived type of this instance. Must be implemented in all derived classes for serialization to work correctly.

Reimplemented in FTestMovieSceneEvalTemplate, FMovieScenePropertySectionTemplate, and FMovieSceneBoolPropertySectionTemplate.

OnBeginEvaluation()

void FMovieSceneEvalTemplateBase::OnBeginEvaluation ( FPersistentEvaluationData &  PersistentData, IMovieScenePlayer &  Player  ) const

inline

Called before this template is evaluated for the first time, or since OnEndEvaluation has been called

Parameters

PersistentData	Persistent data proxy that may contain data pertaining to this entity
Player	The player that is responsible for playing back this template

OnEndEvaluation()

void FMovieSceneEvalTemplateBase::OnEndEvaluation ( FPersistentEvaluationData &  PersistentData, IMovieScenePlayer &  Player  ) const

inline

Called after this template is no longer being evaluated

Parameters

PersistentData	Persistent data proxy that may contain data pertaining to this entity
Player	The player that is responsible for playing back this template

RequiresSetup()

bool FMovieSceneEvalTemplateBase::RequiresSetup ( ) const

inline

Check whether this entity requires set up when it is first evaluated

RequiresTearDown()

bool FMovieSceneEvalTemplateBase::RequiresTearDown ( ) const

inline

Check whether this entity requires tear up when it no longer being evaluated

Setup()

virtual void FMovieSceneEvalTemplateBase::Setup ( FPersistentEvaluationData &  PersistentData, IMovieScenePlayer &  Player  ) const

inlineprotectedvirtual

Called before this template is evaluated for the first time, or since OnEndEvaluation has been called. Implement in derived classes.

Note

Only called when a derived type sets EnableOverrides(RequiresSetupFlag)

Parameters

PersistentData	Persistent data proxy that may contain data pertaining to this entity
Player	The player that is responsible for playing back this template

Reimplemented in FMovieScenePropertySectionTemplate.

SetupOverrides()

virtual void FMovieSceneEvalTemplateBase::SetupOverrides ( )

inlinevirtual

Called after construction to enable overridden functions required by this type.

Note

Should call EnableOverrides() in derived structs with the appropriate flag mask. This is implemented as a virtual function to ensure consistency between serialized data and code. Overriden function flags are not serialized to allow for future changes without breaking serialized data.

Reimplemented in FMovieSceneBoolPropertySectionTemplate.

TearDown()

virtual void FMovieSceneEvalTemplateBase::TearDown ( FPersistentEvaluationData &  PersistentData, IMovieScenePlayer &  Player  ) const

inlineprotectedvirtual

Called after this template is no longer being evaluated. Implement in derived classes.

Note

Only called when a derived type sets EnableOverrides(RequiresTearDownFlag)

Parameters

PersistentData	Persistent data proxy that may contain data pertaining to this entity
Player	The player that is responsible for playing back this template

Member Data Documentation

OverrideMask

uint8 FMovieSceneEvalTemplateBase::OverrideMask

protected

Mask of overridden properties - not serialized, but setup in SetupOverrides

---

The documentation for this struct was generated from the following file:

• Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneEvalTemplateBase.h