UE::MovieScene::FInitialValueCache Struct Reference

#include <MovieSceneInitialValueCache.h>

Public Member Functions
void	Reset (FComponentTypeID InitialValueType, TArrayView< const FInitialValueIndex > InitialValueIndices)
template<typename PropertyTraits >
TPropertyValueStorage< PropertyTraits > *	GetStorage (FComponentTypeID InitialValueType)
template<typename PropertyTraits >
TPropertyValueStorage< PropertyTraits > *	GetStorage (const TPropertyComponents< PropertyTraits > &PropertyComponents)
template<typename PropertyTraits >
TPropertyValueStorage< PropertyTraits > *	FindStorage (FComponentTypeID InitialValueType)
template<typename PropertyTraits >
TPropertyValueStorage< PropertyTraits > *	FindStorage (const TPropertyComponents< PropertyTraits > &PropertyComponents)

Static Public Member Functions
static MOVIESCENE_API TEntitySystemLinkerExtensionID< FInitialValueCache >	GetExtensionID ()
static MOVIESCENE_API TSharedPtr< FInitialValueCache >	GetGlobalInitialValues ()

Detailed Description

Container that houses initial values for any properties animated through FEntityManager Each type is stored in its own container, organized by the initial value component ID The cache is stored as a singleton (through GetSharedInitialValues()) and added as an extension to UMovieSceneEntitySystemLinker where it is active.

Member Function Documentation

FindStorage() [1/2]

template<typename PropertyTraits >

TPropertyValueStorage< PropertyTraits > * UE::MovieScene::FInitialValueCache::FindStorage ( const TPropertyComponents< PropertyTraits > &  PropertyComponents )

inline

Retrieve the initial value storage for a given property type.

Parameters

PropertyComponents

The property component definitions for the storage including its traits

Returns

Property storage for the initial values or nullptr if none exists

FindStorage() [2/2]

template<typename PropertyTraits >

TPropertyValueStorage< PropertyTraits > * UE::MovieScene::FInitialValueCache::FindStorage ( FComponentTypeID  InitialValueType )

inline

Retrieve the initial value storage for a given initial value type.

Note

: Care should be taken to ensure that the template parameter matches the traits defined by the TPropertyComponents for the property.

Parameters

InitialValueType

The ComponentTypeID for the initial value

Returns

Property storage for the initial values or nullptr if none exists

GetExtensionID()

TEntitySystemLinkerExtensionID< FInitialValueCache > UE::MovieScene::FInitialValueCache::GetExtensionID ( )

static

Retrieve the extension ID for this structure when added to a UMovieSceneEntitySystemLinker

GetGlobalInitialValues()

TSharedPtr< FInitialValueCache > UE::MovieScene::FInitialValueCache::GetGlobalInitialValues ( )

static

Retrieve a container used for sharing initial values between linkers.

Note

: The instance is not referenced internally, so will be destroyed when all externally owned shared pointers are destroyed.

GetStorage() [1/2]

template<typename PropertyTraits >

TPropertyValueStorage< PropertyTraits > * UE::MovieScene::FInitialValueCache::GetStorage ( const TPropertyComponents< PropertyTraits > &  PropertyComponents )

inline

Retrieve the initial value storage for a given property type, creating it if necessary

Parameters

PropertyComponents

The property component definitions for the storage including its traits

Returns

Property storage for the initial values or nullptr if none exists

GetStorage() [2/2]

template<typename PropertyTraits >

TPropertyValueStorage< PropertyTraits > * UE::MovieScene::FInitialValueCache::GetStorage ( FComponentTypeID  InitialValueType )

inline

Retrieve the initial value storage for a given initial value type, creating it if necessary.

Note

: Care should be taken to ensure that the template parameter matches the traits defined by the TPropertyComponents for the property.

Parameters

InitialValueType

The ComponentTypeID for the initial value

Returns

Property storage for the initial values

Reset()

void UE::MovieScene::FInitialValueCache::Reset ( FComponentTypeID  InitialValueType, TArrayView< const FInitialValueIndex >  InitialValueIndices  )

inline

Reset all the initial values that relate to the specified type and indices

Parameters

InitialValueType	The ComponentTypeID for the initial value that the indices relate to
InitialValueIndices	An array containing all the indices to remove

---

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

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