1. Epic GamesDeveloper
  3. IStreamingManager

IStreamingManager

Pure virtual base class of a streaming manager.

API > API/Runtime > API/Runtime/Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/ContentStreaming.h
Include #include "ContentStreaming.h"

Syntax

struct IStreamingManager

Remarks

Pure virtual base class of a streaming manager.

Variables

  Type Name Description
Protected variable int32 NumWantingResources Number of resources that currently wants to be streamed in.
Protected variable int32 NumWantingResourcesCounter The current counter for NumWantingResources.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function void

AddLevel ( ULevel* Level
)

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

AddViewInformation ( const FVector& ViewOrigin,
float ScreenSize,
float FOVScreenSize,
float BoostFactor,
bool bOverrideLocation,
float Duration,
TWeakObjectPtr< AActor > InActorToBoost
)

 Adds the passed in view information to the static array.
Protected function Static void

AddViewInfoToArray ( TArray< FStreamingViewInfo >& ViewInfos,
const FVector& ViewOrigin,
float ScreenSize,
float FOVScreenSize,
float BoostFactor,
bool bOverrideLocation,
float Duration,
TWeakObjectPtr< AActor > InActorToBoost
)

 Adds the passed in view information to the static array.
Public function void

AddViewLocation ( const FVector& Location,
float BoostFactor,
bool bOverrideLocation,
float Duration
)

 Queue up view locations to the streaming system.
Public function int32

BlockTillAllRequestsFinished ( float TimeLimit,
bool bLogResults
)

 Blocks till all pending requests are fulfilled.
Public function void Cancels the timed Forced resources (i.e used the Kismet action "Stream In Textures").
Public function Virtual bool

Exec ( UWorld* InWorld,
const TCHAR* Cmd,
FOutputDevice& Ar
)

 Allows the streaming manager to process exec commands.
Public function Static FStreamingManagerCollection &

Get ()

  
Public function Static FStreamingManagerCollection * Same as get but could fail if state not allocated or shutdown.
Public function Const int32 Returns the number of view infos.
Public function Virtual Const int32 Returns the number of resources that currently wants to be streamed in.
Public function Virtual Const int32 Returns the current ID for GetNumWantingResources().
Public function Const const FStreamingViewInfo &

GetViewInformation ( int32 ViewIndex
)

 Returns the view info by the specified index.
Public function Static bool Checks if the streaming manager has already been shut down.
Public function Virtual void Called when a spawned actor is destroyed.
Public function void Notifies manager of "level" change.
Public function void

NotifyLevelOffset ( ULevel* Level,
const FVector& Offset
)

 Notifies manager that level primitives were shifted
Public function Virtual void Called when a primitive is detached from an actor or another component.
Public function Virtual void Called when a primitive streaming data needs to be updated.
Public function Virtual void Called when a primitive streaming data needs to be updated in the last stage of the frame.
Public function Virtual void  
Public function Virtual void Propagates a change to the active lighting scenario.
Public function void

RemoveLevel ( ULevel* Level
)

 Removes a ULevel from the streaming manager.
Public function void

RemoveStreamingViews ( ERemoveStreamingViews RemovalType
)

 Removes streaming views from the streaming manager.
Protected function Static void

RemoveViewInfoFromArray ( TArray< FStreamingViewInfo >& ViewInfos,
const FVector& ViewOrigin
)

 Remove view infos with the same location from the given array.
Public function void Don't stream world resources for the next NumFrames.
Protected function void

SetupViewInfos ( float DeltaTime
)

 Sets up the CurrentViewInfos array based on PendingViewInfos, LastingViewInfos and SecondaryLocations.
Public function Static void  
Public function Virtual int32

StreamAllResources ( float TimeLimit
)

 Streams in/out all resources that wants to and blocks until it's done.
Public function Virtual void

Tick ( float DeltaTime,
bool bProcessEverything
)

 Calls UpdateResourceStreaming(), and does per-frame cleaning.
Public function void

UpdateResourceStreaming ( float DeltaTime,
bool bProcessEverything
)

 Updates streaming, taking into account all current view infos.

Classes

  Type Name Description
Protected struct FSecondaryLocation    

Constants

Name Description
bPendingRemoveViews Set when Tick() has been called.
CurrentViewInfos Current collection of views that need to be taken into account for streaming.
LastingViewInfos Views that stick around for a while. Override views are ignored if no movie is playing.
PendingViewInfos Pending views. Emptied every frame.
SecondaryLocations Collection of view locations that will be added at the next call to AddViewInformation.

Deprecated Functions

  Type Name Description
Public function void

AddViewSlaveLocation ( const FVector& Location,
float BoostFactor,
bool bOverrideLocation,
float Duration
)

 This is deprecated to follow inclusive naming rules. Use AddViewLocation() instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page