Navigation
API > API/Plugins > API/Plugins/ChaosVD
Simple pseudo level streaming system that works with a collection of ChaosVDSceneObjects - This system only updates a desired streaming state (from multiple threads) and issues a sync request in the GT. How these actions are executed depends on the implementations of each ChaosVDSceneObjects derived object
| Name | FChaosVDSceneStreaming |
| Type | class |
| Header File | /Engine/Plugins/ChaosVD/Source/ChaosVD/Public/ChaosVDSceneStreaming.h |
| Include Path | #include "ChaosVDSceneStreaming.h" |
Syntax
class FChaosVDSceneStreaming : public FTSTickerObjectBase
Inheritance Hierarchy
- FTSTickerObjectBase → FChaosVDSceneStreaming
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FChaosVDSceneStreaming() |
ChaosVDSceneStreaming.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FChaosVDSceneStreaming() |
ChaosVDSceneStreaming.h |
Classes
| Name | Remarks |
|---|---|
| TMemStackSetAllocator |
Structs
| Name | Remarks |
|---|---|
| FPendingTrackingOperation | Relevant streaming system data that needs processing |
| FQueryVisitor |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPendingTrackingOperation CreateStreamingTrackingOperation
(
const TSharedRef< FChaosVDBaseSceneObject >& InSceneObject, |
Creates an object tracking operation structure with the necessary data to update the streaming system state for this object | ChaosVDSceneStreaming.h | |
void DeInitialize() |
ChaosVDSceneStreaming.h | ||
void EnqueuePendingTrackingOperation
(
const FPendingTrackingOperation&& Operation |
Adds an object tracking operation to the queue | ChaosVDSceneStreaming.h | |
void EnqueuePendingTrackingOperation
(
const TSharedRef< FChaosVDBaseSceneObject >& InSceneObject, |
Creates the request object tracking operation for the provided object and adds it to the queue | ChaosVDSceneStreaming.h | |
void HandleSettingsChanged
(
UObject* SettingsObject |
Handles any streaming settings changes done by the user and updates the world accordingly | ChaosVDSceneStreaming.h | |
void Initialize() |
ChaosVDSceneStreaming.h | ||
bool IsEnabled() |
Returns true if this system is enabled | ChaosVDSceneStreaming.h | |
bool IsInStreamingRange
(
const FBox& Bounds |
Returns true if the provided bounds are within the current calculated streaming volume | ChaosVDSceneStreaming.h | |
void Reset() |
Resets the streaming system state | ChaosVDSceneStreaming.h | |
void SetScene
(
const TWeakPtr< FChaosVDScene >& InSceneWeakPtr |
Sets a weak ptr to the CVD scene where all the objects managed by this system live | ChaosVDSceneStreaming.h | |
void SetStreamingDataSource
(
IChaosVDStreamingDataSource* InStreamingDataSource |
Sets a ptr to an array with all the objects managed by this streaming system | ChaosVDSceneStreaming.h | |
void SetStreamingEnabled
(
bool bNewEnabled |
Changes the enabled state of this streaming system, and updates the world acordingly | ChaosVDSceneStreaming.h | |
void UpdateStreamingSourceLocation
(
const FVector& NewLocation |
Updates the current location used to calculate what objects should be fully loaded or not | ChaosVDSceneStreaming.h | |
void UpdateStreamingStateForObject
(
const TSharedRef< FChaosVDBaseSceneObject >& InSceneObject |
Sets the correct streaming state for the provided object based on its bounds | ChaosVDSceneStreaming.h |
Overridden from FTSTickerObjectBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool Tick
(
float DeltaTime |
ChaosVDSceneStreaming.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void MakeEverythingVisible() |
ChaosVDSceneStreaming.h | ||
void ProcessPendingOperations() |
ChaosVDSceneStreaming.h | ||
void ReBuildAccelStructureFromSourceDataArray() |
ChaosVDSceneStreaming.h | ||
void RemoveDirtyFlag
(
EChaosVDStreamingDirtyFlags Flag |
ChaosVDSceneStreaming.h | ||
void SetDirtyFlags
(
EChaosVDStreamingDirtyFlags Flag |
ChaosVDSceneStreaming.h | ||
void SetStreamingExtent
(
float NewExtent |
ChaosVDSceneStreaming.h | ||
void UpdateStreamingQueryShape() |
ChaosVDSceneStreaming.h | ||
void UpdateStreamingState() |
ChaosVDSceneStreaming.h |