Navigation
API > API/Plugins > API/Plugins/DataflowEditor
Dataflow simulation scene holding all the dataflow content components
| Name | FDataflowSimulationScene |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Dataflow/Source/DataflowEditor/Public/Dataflow/DataflowSimulationScene.h |
| Include Path | #include "Dataflow/DataflowSimulationScene.h" |
Syntax
class FDataflowSimulationScene : public FDataflowPreviewSceneBase
Inheritance Hierarchy
- FGCObject → FPreviewScene → FAdvancedPreviewScene → FDataflowPreviewSceneBase → FDataflowSimulationScene
- FTickableObjectBase → FTickableEditorObject → FAdvancedPreviewScene → FDataflowPreviewSceneBase → FDataflowSimulationScene
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDataflowSimulationScene
(
FPreviewScene::ConstructionValues ConstructionValues, |
Dataflow/DataflowSimulationScene.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FDataflowSimulationScene() |
Dataflow/DataflowSimulationScene.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| SimulationTime | float | Simulation time used to drive the cache loading | Dataflow/DataflowSimulationScene.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsRecordingCache | bool | Boolean to check if we are recording the cache or not | Dataflow/DataflowSimulationScene.h | |
| CurrentPreviewLOD | int32 | Preview LOD used in the simulation viewport | Dataflow/DataflowSimulationScene.h | |
| DeltaTime | float | Delta time (1/fps) | Dataflow/DataflowSimulationScene.h | |
| LastTimeStamp | UE::Dataflow::FTimestamp | Last context time stamp for which we regenerated the world | Dataflow/DataflowSimulationScene.h | |
| NumFrames | int32 | Number of cache frames | Dataflow/DataflowSimulationScene.h | |
| OnObjectsReinstancedHandle | FDelegateHandle | Handle for the delegate | Dataflow/DataflowSimulationScene.h | |
| PreviewActor | TObjectPtr< AActor > | Preview actor that will will be used to visualize the result of the simulation graph | Dataflow/DataflowSimulationScene.h | |
| SceneDescription | TObjectPtr< UDataflowSimulationSceneDescription > | Simulation scene description | Dataflow/DataflowSimulationScene.h | |
| SimulationGenerator | TSharedPtr< UE::Dataflow::FDataflowSimulationGenerator > | Simulation generator to record the simulation result | Dataflow/DataflowSimulationScene.h | |
| TimeRange | FVector2f | Cache time range in seconds | Dataflow/DataflowSimulationScene.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddReferencedObjects
(
FReferenceCollector& Collector |
Dataflow/DataflowSimulationScene.h | ||
virtual bool CanRunSimulation() |
Check if the preview scene can run simulation | Dataflow/DataflowSimulationScene.h | |
void CreateSimulationScene() |
Create all the simulation world components and instances | Dataflow/DataflowSimulationScene.h | |
virtual FBox GetBoundingBox() |
Get the bounding box for the selected components or the entire sim scene | Dataflow/DataflowSimulationScene.h | |
float GetDeltaTime() |
Get delta time | Dataflow/DataflowSimulationScene.h | |
const int32 GetFrameRate() |
Get the frame rate | Dataflow/DataflowSimulationScene.h | |
const int32 & GetNumFrames() |
Get the number of frames | Dataflow/DataflowSimulationScene.h | |
TObjectPtr< AActor > GetPreviewActor () |
Preview actor accessors | Dataflow/DataflowSimulationScene.h | |
const TObjectPtr< AActor > GetPreviewActor () |
Dataflow/DataflowSimulationScene.h | ||
int32 GetPreviewLOD() |
Dataflow/DataflowSimulationScene.h | ||
UDataflowSimulationSceneDescription * GetPreviewSceneDescription() |
Get the scene description used in the preview scene widget | Dataflow/DataflowSimulationScene.h | |
const int32 GetSubframeRate() |
Get the subframe rate | Dataflow/DataflowSimulationScene.h | |
const FVector2f & GetTimeRange() |
Get the simulation time range | Dataflow/DataflowSimulationScene.h | |
bool HasRenderableGeometry() |
Check if there is something to render | Dataflow/DataflowSimulationScene.h | |
bool IsSimulationEnabled() |
Gets whether the simulation is running | Dataflow/DataflowSimulationScene.h | |
| Functions that will be triggered when objects will be reinstanced (BP compilation) | Dataflow/DataflowSimulationScene.h | ||
void PauseSimulationScene() |
Pause the simulation | Dataflow/DataflowSimulationScene.h | |
void RebuildSimulationScene
(
const bool bIsSimulationEnabled |
Rebuild the simulation scene | Dataflow/DataflowSimulationScene.h | |
void RecordSimulationCache() |
Record the simulation cache | Dataflow/DataflowSimulationScene.h | |
void ResetSimulationScene() |
Reset all the simulation world components and instances | Dataflow/DataflowSimulationScene.h | |
void SceneDescriptionPropertyChanged
(
const FName& PropertyName |
Update Scene in response to the SceneDescription changing | Dataflow/DataflowSimulationScene.h | |
void SetPreviewLOD
(
int32 InLOD |
LOD for preview actor components | Dataflow/DataflowSimulationScene.h | |
void StartSimulationScene() |
Start the simulation | Dataflow/DataflowSimulationScene.h | |
void StepSimulationScene() |
Step the simulation | Dataflow/DataflowSimulationScene.h | |
virtual void TickDataflowScene
(
const float DeltaSeconds |
Tick data flow scene | Dataflow/DataflowSimulationScene.h |