FStreamingAnimationData Struct Reference

#include <AnimationStreaming.h>

Public Member Functions
	FStreamingAnimationData ()
	~FStreamingAnimationData ()
void	FreeResources ()
bool	Initialize (UAnimStreamable *InStreamableAnim, FAnimationStreamingManager *InAnimationStreamingManager)
bool	UpdateStreamingStatus ()
bool	HasPendingRequests (TArray< uint32 > &IndicesToLoad, TArray< uint32 > &IndicesToFree) const
void	BeginPendingRequests (const TArray< uint32 > &IndicesToLoad, const TArray< uint32 > &IndicesToFree)
bool	BlockTillAllRequestsFinished (float TimeLimit=0.0f)
SIZE_T	GetMemorySize () const

Public Attributes
UAnimStreamable *	StreamableAnim
TArray< FLoadedAnimationChunk >	LoadedChunks
FCriticalSection	LoadedChunksCritcalSection
TArray< uint32 >	LoadedChunkIndices
TArray< uint32 >	RequestedChunks
TArray< uint32 >	LoadFailedChunks
FAnimationStreamingManager *	AnimationStreamingManager

Detailed Description

Contains everything that will be needed by a Streamable Anim that's streaming in data

Constructor & Destructor Documentation

FStreamingAnimationData()

FStreamingAnimationData::FStreamingAnimationData

(

)

~FStreamingAnimationData()

FStreamingAnimationData::~FStreamingAnimationData

(

)

Member Function Documentation

BeginPendingRequests()

void FStreamingAnimationData::BeginPendingRequests	(	const TArray< uint32 > &	IndicesToLoad,
		const TArray< uint32 > &	IndicesToFree
	)

Kicks off any pending requests

BlockTillAllRequestsFinished()

bool FStreamingAnimationData::BlockTillAllRequestsFinished

(

float

TimeLimit = 0.0f

)

Blocks till all pending requests are fulfilled.

Parameters

TimeLimit

Optional time limit for processing, in seconds. Specifying 0 means infinite time limit.

Returns

Return true if there are no requests left in flight, false if the time limit was reached before they were finished.

FreeResources()

void FStreamingAnimationData::FreeResources

(

)

GetMemorySize()

SIZE_T FStreamingAnimationData::GetMemorySize

(

)

const

HasPendingRequests()

bool FStreamingAnimationData::HasPendingRequests	(	TArray< uint32 > &	IndicesToLoad,
		TArray< uint32 > &	IndicesToFree
	)		const

Checks whether the requested chunk indices differ from those loaded

Parameters

IndicesToLoad	List of chunk indices that should be loaded
IndicesToFree	List of chunk indices that should be freed

Returns

Whether any changes to loaded chunks are required

Initialize()

bool FStreamingAnimationData::Initialize	(	UAnimStreamable *	InStreamableAnim,
		FAnimationStreamingManager *	InAnimationStreamingManager
	)

Sets up the streaming wave data and loads the first chunk of animation for instant play

Parameters

Anim	The streamable animation we are managing

UpdateStreamingStatus()

bool FStreamingAnimationData::UpdateStreamingStatus

(

)

Updates the streaming status of the animation and performs finalization when appropriate. The function returns true while there are pending requests in flight and updating needs to continue.

Returns

true if there are requests in flight, false otherwise

Member Data Documentation

AnimationStreamingManager

FAnimationStreamingManager* FStreamingAnimationData::AnimationStreamingManager

Ptr to owning animation streaming manager.

LoadedChunkIndices

TArray<uint32> FStreamingAnimationData::LoadedChunkIndices

Indices of chunks that are currently loaded

LoadedChunks

TArray<FLoadedAnimationChunk> FStreamingAnimationData::LoadedChunks

LoadedChunksCritcalSection

FCriticalSection FStreamingAnimationData::LoadedChunksCritcalSection

mutable

LoadFailedChunks

TArray<uint32> FStreamingAnimationData::LoadFailedChunks

RequestedChunks

TArray<uint32> FStreamingAnimationData::RequestedChunks

StreamableAnim

UAnimStreamable* FStreamingAnimationData::StreamableAnim

AnimStreamable this streaming data is for

---

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

• Engine/Source/Runtime/Engine/Public/Animation/AnimationStreaming.h
• Engine/Source/Runtime/Engine/Private/Animation/AnimationStreaming.cpp