UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | Friends | List of all members
FMovieSceneEvaluationKey Struct Reference

#include <MovieSceneEvaluationKey.h>

Public Member Functions

 FMovieSceneEvaluationKey ()
 
 FMovieSceneEvaluationKey (FMovieSceneSequenceIDRef InSequenceID, FMovieSceneTrackIdentifier InTrackIdentifier, uint32 InSectionIndex=uint32(-1))
 
bool IsValid () const
 
FMovieSceneEvaluationKey AsSection (uint32 InSectionIdentifier) const
 
FMovieSceneEvaluationKey AsTrack () const
 
bool Serialize (FArchive &Ar)
 

Public Attributes

FMovieSceneSequenceID SequenceID
 
FMovieSceneTrackIdentifier TrackIdentifier
 
uint32 SectionIndex
 

Friends

bool operator== (const FMovieSceneEvaluationKey &A, const FMovieSceneEvaluationKey &B)
 
bool operator< (const FMovieSceneEvaluationKey &A, const FMovieSceneEvaluationKey &B)
 
uint32 GetTypeHash (const FMovieSceneEvaluationKey &In)
 
FArchive & operator<< (FArchive &Ar, FMovieSceneEvaluationKey &Key)
 

Detailed Description

Keyable struct that represents a particular entity within an evaluation template (either a section/template or a track)

Constructor & Destructor Documentation

◆ FMovieSceneEvaluationKey() [1/2]

FMovieSceneEvaluationKey::FMovieSceneEvaluationKey ( )
inline

Default construction to an invalid key

◆ FMovieSceneEvaluationKey() [2/2]

FMovieSceneEvaluationKey::FMovieSceneEvaluationKey ( FMovieSceneSequenceIDRef  InSequenceID,
FMovieSceneTrackIdentifier  InTrackIdentifier,
uint32  InSectionIndex = uint32(-1) 
)
inline

User construction

Member Function Documentation

◆ AsSection()

FMovieSceneEvaluationKey FMovieSceneEvaluationKey::AsSection ( uint32  InSectionIdentifier) const
inline

Derive a new key from this one using the specified section identifier

◆ AsTrack()

FMovieSceneEvaluationKey FMovieSceneEvaluationKey::AsTrack ( ) const
inline

Convert this key into a track key

◆ IsValid()

bool FMovieSceneEvaluationKey::IsValid ( ) const
inline

Check whether this key is valid

◆ Serialize()

bool FMovieSceneEvaluationKey::Serialize ( FArchive &  Ar)
inline

Custom serialized to reduce memory footprint

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FMovieSceneEvaluationKey &  In)
friend

◆ operator<

bool operator< ( const FMovieSceneEvaluationKey &  A,
const FMovieSceneEvaluationKey &  B 
)
friend

◆ operator<<

FArchive & operator<< ( FArchive &  Ar,
FMovieSceneEvaluationKey &  Key 
)
friend

◆ operator==

bool operator== ( const FMovieSceneEvaluationKey &  A,
const FMovieSceneEvaluationKey &  B 
)
friend

Member Data Documentation

◆ SectionIndex

uint32 FMovieSceneEvaluationKey::SectionIndex

Index of the section template within the track this key relates to (or -1 where this key relates to a track)

◆ SequenceID

FMovieSceneSequenceID FMovieSceneEvaluationKey::SequenceID

ID of the sequence that the entity is contained within

◆ TrackIdentifier

FMovieSceneTrackIdentifier FMovieSceneEvaluationKey::TrackIdentifier

ID of the track this key relates to

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