UE::MovieScene::FSharedPlaybackState Struct Reference

#include <MovieSceneSharedPlaybackState.h>

Inheritance diagram for UE::MovieScene::FSharedPlaybackState:

Public Member Functions
UE_API	FSharedPlaybackState (UMovieSceneEntitySystemLinker *InLinker=nullptr)
UE_API	FSharedPlaybackState (UMovieSceneSequence &InRootSequence, const FSharedPlaybackStateCreateParams &CreateParams)
UE_API	~FSharedPlaybackState ()
UObject *	GetPlaybackContext () const
UMovieSceneSequence *	GetRootSequence () const
UMovieSceneEntitySystemLinker *	GetLinker () const
TObjectPtr< UMovieSceneCompiledDataManager >	GetCompiledDataManager () const
const FRootInstanceHandle &	GetRootInstanceHandle () const
const FMovieSceneCompiledDataID &	GetRootCompiledDataID () const
const FMovieSceneInstancePreAnimatedState &	GetPreAnimatedState () const
FMovieSceneInstancePreAnimatedState &	GetPreAnimatedState ()
UE_API TSharedPtr< FMovieSceneEntitySystemRunner >	GetRunner () const
UE_API const FMovieSceneSequenceHierarchy *	GetHierarchy () const
UE_API UMovieSceneSequence *	GetSequence (FMovieSceneSequenceIDRef SequenceID) const
UE_API TArrayView< TWeakObjectPtr<> >	FindBoundObjects (const FGuid &ObjectBindingID, FMovieSceneSequenceIDRef SequenceID) const
UE_API void	ClearObjectCaches ()
FPlaybackCapabilities &	GetCapabilities ()
const FPlaybackCapabilities &	GetCapabilities () const
template<typename T >
bool	HasCapability () const
template<typename T >
T *	FindCapability () const
template<typename T , typename ... ArgTypes>
T &	AddCapability (ArgTypes &&... InArgs)
template<typename T >
T &	AddCapabilityRaw (T *InPointer)
template<typename T >
T &	AddCapabilityShared (TSharedRef< T > InSharedRef)
template<typename T , typename ... ArgTypes>
T &	SetOrAddCapability (ArgTypes &&... InArgs)
template<typename T , typename ... ArgTypes>
T &	SetOrAddCapabilityRaw (T *InPointer)
template<typename T , typename ... ArgTypes>
T &	SetOrAddCapabilityShared (TSharedRef< T > InSharedRef)
UE_API void	InvalidateCachedData ()
void	SetDebugBreakOnDestroy ()
Public Member Functions inherited from TSharedFromThis< FSharedPlaybackState >
TSharedRef< FSharedPlaybackState, Mode >	AsShared ()
TSharedRef< FSharedPlaybackState const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FSharedPlaybackState, Mode >	AsWeak ()
TWeakPtr< FSharedPlaybackState const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FSharedPlaybackState >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< FSharedPlaybackState >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

A structure that stores playback state for an entire sequence hierarchy.

Constructor & Destructor Documentation

FSharedPlaybackState() [1/2]

UE::MovieScene::FSharedPlaybackState::FSharedPlaybackState

(

UMovieSceneEntitySystemLinker *

InLinker = nullptr

)

FSharedPlaybackState() [2/2]

UE::MovieScene::FSharedPlaybackState::FSharedPlaybackState	(	UMovieSceneSequence &	InRootSequence,
		const FSharedPlaybackStateCreateParams &	CreateParams
	)

~FSharedPlaybackState()

UE::MovieScene::FSharedPlaybackState::~FSharedPlaybackState

(

)

Member Function Documentation

AddCapability()

template<typename T , typename ... ArgTypes>

T & UE::MovieScene::FSharedPlaybackState::AddCapability ( ArgTypes &&...  InArgs )

inline

Builds the specified capability for the root sequence.

AddCapabilityRaw()

template<typename T >

T & UE::MovieScene::FSharedPlaybackState::AddCapabilityRaw ( T *  InPointer )

inline

Adds the specified capability on the root sequence as a raw pointer.

AddCapabilityShared()

template<typename T >

T & UE::MovieScene::FSharedPlaybackState::AddCapabilityShared ( TSharedRef< T >  InSharedRef )

inline

Adds the specified capability on the root sequence as a shared pointer.

ClearObjectCaches()

void UE::MovieScene::FSharedPlaybackState::ClearObjectCaches

(

)

Clears object caches for the entire sequence hierarchy.

FindBoundObjects()

TArrayView< TWeakObjectPtr<> > UE::MovieScene::FSharedPlaybackState::FindBoundObjects	(	const FGuid &	ObjectBindingID,
		FMovieSceneSequenceIDRef	SequenceID
	)		const

Finds the bound objects for the given object binding in the given (sub)sequence

FindCapability()

template<typename T >

T * UE::MovieScene::FSharedPlaybackState::FindCapability ( ) const

inline

Finds the specified capability on the root sequence.

GetCapabilities() [1/2]

FPlaybackCapabilities & UE::MovieScene::FSharedPlaybackState::GetCapabilities ( )

inline

Gets the capabilities container.

GetCapabilities() [2/2]

const FPlaybackCapabilities & UE::MovieScene::FSharedPlaybackState::GetCapabilities ( ) const

inline

Gets the capabilities container.

GetCompiledDataManager()

TObjectPtr< UMovieSceneCompiledDataManager > UE::MovieScene::FSharedPlaybackState::GetCompiledDataManager ( ) const

inline

Gets the compiled data manager that contains the data for the root sequence

GetHierarchy()

const FMovieSceneSequenceHierarchy * UE::MovieScene::FSharedPlaybackState::GetHierarchy

(

)

const

Gets the hierarchy (if any) for this root sequence

GetLinker()

UMovieSceneEntitySystemLinker * UE::MovieScene::FSharedPlaybackState::GetLinker ( ) const

inline

Gets the linker evaluating this root sequence

GetPlaybackContext()

UObject * UE::MovieScene::FSharedPlaybackState::GetPlaybackContext ( ) const

inline

Gets the playback context

GetPreAnimatedState() [1/2]

FMovieSceneInstancePreAnimatedState & UE::MovieScene::FSharedPlaybackState::GetPreAnimatedState ( )

inline

Gets the pre-animated state utility for the sequence hierarchy

GetPreAnimatedState() [2/2]

const FMovieSceneInstancePreAnimatedState & UE::MovieScene::FSharedPlaybackState::GetPreAnimatedState ( ) const

inline

Gets the pre-animated state utility for the sequence hierarchy

GetRootCompiledDataID()

const FMovieSceneCompiledDataID & UE::MovieScene::FSharedPlaybackState::GetRootCompiledDataID ( ) const

inline

Gets the compiled data ID for the root sequence

GetRootInstanceHandle()

const FRootInstanceHandle & UE::MovieScene::FSharedPlaybackState::GetRootInstanceHandle ( ) const

inline

Gets the handle of the root sequence

GetRootSequence()

UMovieSceneSequence * UE::MovieScene::FSharedPlaybackState::GetRootSequence ( ) const

inline

Gets the root sequence

GetRunner()

TSharedPtr< FMovieSceneEntitySystemRunner > UE::MovieScene::FSharedPlaybackState::GetRunner

(

)

const

Gets the runner evaluating this root sequence

GetSequence()

UMovieSceneSequence * UE::MovieScene::FSharedPlaybackState::GetSequence

(

FMovieSceneSequenceIDRef

SequenceID

)

const

Gets a sub-sequence given an ID

HasCapability()

template<typename T >

bool UE::MovieScene::FSharedPlaybackState::HasCapability ( ) const

inline

Returns whether the root sequence has the specified capability.

InvalidateCachedData()

void UE::MovieScene::FSharedPlaybackState::InvalidateCachedData

(

)

SetDebugBreakOnDestroy()

void UE::MovieScene::FSharedPlaybackState::SetDebugBreakOnDestroy ( )

inline

SetOrAddCapability()

template<typename T , typename ... ArgTypes>

T & UE::MovieScene::FSharedPlaybackState::SetOrAddCapability ( ArgTypes &&...  InArgs )

inline

Adds the specified capability on the root sequence. If the capability already exists, it must be stored inline, and its value will be replaced by the new object. If the template parameter is a sub-class of the playback capability, the previously stored playback capability must not only have been stored inline, but must have been of the same sub-class (or a sub-class with the exact same size and alignment).

SetOrAddCapabilityRaw()

template<typename T , typename ... ArgTypes>

T & UE::MovieScene::FSharedPlaybackState::SetOrAddCapabilityRaw ( T *  InPointer )

inline

Adds the specified capability on the root sequence as a raw pointer. If the capability already exists, it must be stored as a raw pointer and its value will be replaced by the new pointer.

SetOrAddCapabilityShared()

template<typename T , typename ... ArgTypes>

T & UE::MovieScene::FSharedPlaybackState::SetOrAddCapabilityShared ( TSharedRef< T >  InSharedRef )

inline

Adds the specified capability on the root sequence as a shared pointer. If the capability already exists, it must be stored as a shared pointer and its value will be replaced by the new pointer.

---

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

• Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneSharedPlaybackState.h
• Engine/Source/Runtime/MovieScene/Private/EntitySystem/MovieSceneSharedPlaybackState.cpp