FAnimationStreamingManager Struct Reference

#include <AnimationStreaming.h>

Inheritance diagram for FAnimationStreamingManager:

Public Member Functions
	FAnimationStreamingManager ()
virtual	~FAnimationStreamingManager ()
virtual void	UpdateResourceStreaming (float DeltaTime, bool bProcessEverything=false) override
virtual int32	BlockTillAllRequestsFinished (float TimeLimit=0.0f, bool bLogResults=false) override
virtual void	CancelForcedResources () override
virtual void	NotifyLevelChange () override
virtual void	SetDisregardWorldResourcesForFrames (int32 NumFrames) override
virtual void	AddLevel (class ULevel *Level) override
virtual void	RemoveLevel (class ULevel *Level) override
virtual void	NotifyLevelOffset (class ULevel *Level, const FVector &Offset) override
virtual void	AddStreamingAnim (UAnimStreamable *Anim) override
virtual bool	RemoveStreamingAnim (UAnimStreamable *Anim) override
virtual SIZE_T	GetMemorySizeForAnim (const UAnimStreamable *Anim) override
virtual const FCompressedAnimSequence *	GetLoadedChunk (const UAnimStreamable *Anim, uint32 ChunkIndex, bool bTrackAsRequested) const override
void	OnAsyncFileCallback (FStreamingAnimationData *StreamingAnimData, int32 ChunkIndex, int64 ReadSize, IBulkDataIORequest *ReadRequest, bool bWasCancelled)
Public Member Functions inherited from IStreamingManager
	IStreamingManager ()
virtual	~IStreamingManager ()
virtual ENGINE_API void	Tick (float DeltaTime, bool bProcessEverything=false)
virtual ENGINE_API int32	StreamAllResources (float TimeLimit=0.0f)
void	RemoveStreamingViews (ERemoveStreamingViews RemovalType)
ENGINE_API void	AddViewInformation (const FVector &ViewOrigin, float ScreenSize, float FOVScreenSize, float BoostFactor=1.0f, bool bOverrideLocation=false, float Duration=0.0f, TWeakObjectPtr< AActor > InActorToBoost=NULL, TWeakObjectPtr< UWorld > InWorld=NULL)
ENGINE_API void	AddViewLocation (const FVector &Location, float BoostFactor=1.0f, bool bOverrideLocation=false, float Duration=0.0f)
virtual bool	Exec (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar)
virtual void	NotifyActorDestroyed (AActor *Actor)
virtual void	NotifyPrimitiveDetached (const UPrimitiveComponent *Primitive)
virtual void	NotifyPrimitiveUpdated (const UPrimitiveComponent *Primitive)
virtual void	NotifyPrimitiveUpdated_Concurrent (const UPrimitiveComponent *Primitive)
int32	GetNumViews () const
const FStreamingViewInfo &	GetViewInformation (int32 ViewIndex) const
virtual int32	GetNumWantingResources () const
virtual int32	GetNumWantingResourcesID () const
virtual void	PropagateLightingScenarioChange ()

Protected Attributes
TMap< UAnimStreamable *, FStreamingAnimationData * >	StreamingAnimations
FCriticalSection	CriticalSection
Protected Attributes inherited from IStreamingManager
int32	NumWantingResources
int32	NumWantingResourcesCounter

Additional Inherited Members
Static Public Member Functions inherited from IStreamingManager
static ENGINE_API struct FStreamingManagerCollection &	Get ()
static ENGINE_API struct FStreamingManagerCollection *	Get_Concurrent ()
static ENGINE_API void	Shutdown ()
static ENGINE_API bool	HasShutdown ()
Protected Member Functions inherited from IStreamingManager
void	SetupViewInfos (float DeltaTime)
Static Protected Member Functions inherited from IStreamingManager
static void	AddViewInfoToArray (TArray< FStreamingViewInfo > &ViewInfos, const FVector &ViewOrigin, float ScreenSize, float FOVScreenSize, float BoostFactor, bool bOverrideLocation, float Duration, TWeakObjectPtr< AActor > InActorToBoost, TWeakObjectPtr< UWorld > InWorld)
static void	RemoveViewInfoFromArray (TArray< FStreamingViewInfo > &ViewInfos, const FVector &ViewOrigin)
Static Protected Attributes inherited from IStreamingManager
static ENGINE_API TArray< FStreamingViewInfo >	CurrentViewInfos
static TArray< FStreamingViewInfo >	PendingViewInfos
static TArray< FStreamingViewInfo >	LastingViewInfos
static TArray< FSecondaryLocation >	SecondaryLocations
static bool	bPendingRemoveViews = false

Detailed Description

Streaming manager dealing with animation.

Constructor & Destructor Documentation

FAnimationStreamingManager()

FAnimationStreamingManager::FAnimationStreamingManager

(

)

Constructor, initializing all members

~FAnimationStreamingManager()

FAnimationStreamingManager::~FAnimationStreamingManager ( )

virtual

Member Function Documentation

AddLevel()

void FAnimationStreamingManager::AddLevel ( class ULevel *  Level )

overridevirtual

Adds a ULevel that has already prepared StreamingData to the streaming manager.

Implements IStreamingManager.

AddStreamingAnim()

void FAnimationStreamingManager::AddStreamingAnim ( UAnimStreamable *  Anim )

overridevirtual

Adds a new Streamable Anim to the streaming manager.

Implements IAnimationStreamingManager.

BlockTillAllRequestsFinished()

int32 FAnimationStreamingManager::BlockTillAllRequestsFinished ( float  TimeLimit = 0.0f, bool  bLogResults = false  )

overridevirtual

Blocks till all pending requests are fulfilled.

Parameters

TimeLimit	Optional time limit for processing, in seconds. Specifying 0 means infinite time limit.
bLogResults	Whether to dump the results to the log.

Returns

Number of streaming requests still in flight, if the time limit was reached before they were finished.

Implements IStreamingManager.

CancelForcedResources()

void FAnimationStreamingManager::CancelForcedResources ( )

overridevirtual

Cancels the timed Forced resources (i.e used the Kismet action "Stream In Textures").

Implements IStreamingManager.

GetLoadedChunk()

const FCompressedAnimSequence * FAnimationStreamingManager::GetLoadedChunk ( const UAnimStreamable *  Anim, uint32  ChunkIndex, bool  bRequestNextChunk  ) const

overridevirtual

Gets a pointer to a chunk of animation data

Parameters

Anim	AnimStreamable we want a chunk from
ChunkIndex	Index of the chunk we want

Returns

Either the desired chunk or NULL if it's not loaded

Implements IAnimationStreamingManager.

GetMemorySizeForAnim()

SIZE_T FAnimationStreamingManager::GetMemorySizeForAnim ( const UAnimStreamable *  Anim )

overridevirtual

Returns the memory a Streamable Anim is currently using

Implements IAnimationStreamingManager.

NotifyLevelChange()

void FAnimationStreamingManager::NotifyLevelChange ( )

overridevirtual

Notifies manager of "level" change.

Implements IStreamingManager.

NotifyLevelOffset()

void FAnimationStreamingManager::NotifyLevelOffset ( class ULevel *  Level, const FVector &  Offset  )

overridevirtual

Notifies manager that level primitives were shifted

Implements IStreamingManager.

OnAsyncFileCallback()

void FAnimationStreamingManager::OnAsyncFileCallback	(	FStreamingAnimationData *	StreamingAnimData,
		int32	ChunkIndex,
		int64	ReadSize,
		IBulkDataIORequest *	ReadRequest,
		bool	bWasCancelled
	)

Called when an async callback is made on an async loading animation chunk request.

RemoveLevel()

void FAnimationStreamingManager::RemoveLevel ( class ULevel *  Level )

overridevirtual

Removes a ULevel from the streaming manager.

Implements IStreamingManager.

RemoveStreamingAnim()

bool FAnimationStreamingManager::RemoveStreamingAnim ( UAnimStreamable *  Anim )

overridevirtual

Removes a Streamable Anim from the streaming manager.

Implements IAnimationStreamingManager.

SetDisregardWorldResourcesForFrames()

void FAnimationStreamingManager::SetDisregardWorldResourcesForFrames ( int32  NumFrames )

overridevirtual

Don't stream world resources for the next NumFrames.

Implements IStreamingManager.

UpdateResourceStreaming()

void FAnimationStreamingManager::UpdateResourceStreaming ( float  DeltaTime, bool  bProcessEverything = false  )

overridevirtual

Updates streaming, taking into account all current view infos. Can be called multiple times per frame.

Parameters

DeltaTime	Time since last call in seconds
bProcessEverything	[opt] If true, process all resources with no throttling limits

Implements IStreamingManager.

Member Data Documentation

CriticalSection

FCriticalSection FAnimationStreamingManager::CriticalSection

mutableprotected

Critical section to protect usage of shared gamethread/workerthread members

StreamingAnimations

TMap<UAnimStreamable*, FStreamingAnimationData*> FAnimationStreamingManager::StreamingAnimations

protected

Sound Waves being managed.

---

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