Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FChaosScene

Low level Chaos scene used when building custom simulations that don't exist in the main world physics scene.

Windows

MacOS

Linux

Inheritance Hierarchy

FChaosScene

FPhysScene_Chaos

References

Module	PhysicsCore
Header	/Engine/Source/Runtime/PhysicsCore/Public/Chaos/ChaosScene.h
Include	#include "Chaos/ChaosScene.h"

Syntax

class FChaosScene

Remarks

Low level Chaos scene used when building custom simulations that don't exist in the main world physics scene.

Variables

	Name	Description
FChaosSolversMo...	ChaosModule	Control module for Chaos - cached to avoid constantly hitting the module manager.
float	MDeltaTime
FOnPhysScenePos...	OnPhysScenePostTick
UObject *	Owner
TArray< UObject...	PieModifiedObjects	List of objects that we modified during a PIE run for physics simulation caching.
Chaos::FPhysics...	SceneSolver	Solver representing this scene.
Chaos::ISpatial...	SolverAccelerationStructure

Constructors

	Name	Description
	FChaosScene ( UObject* OwnerPtr )

Destructors

	Name	Description
	~FChaosScene()

Functions

	Name	Description
void	AddActorsToScene_AssumesLocked ( TArray< FPhysicsActorHandle >& InH..., const bool bImmediate )
void	AddPieModifiedObject ( UObject* InObj )
bool	AreAnyTasksPending()
void	BeginDestroy()
void	CopySolverAccelerationStructure()	Copies the acceleration structure out of the solver, does no thread safety checking so ensure calls to this are made at appropriate sync points if required
void	EndFrame()
void	Flush()	Flushes all pending global, task and solver command queues and refreshes the spatial acceleration for the scene.
FGraphEventA...	GetCompletionEvents()
Chaos::FPhys...	GetSolver()	Get the internal Chaos solver object
Chaos::ISpat...	GetSpacialAcceleration()
const Chaos:...	GetSpacialAcceleration()
bool	IsCompletionEventComplete()
float	OnStartFrame ( float InDeltaTime )
void	OnSyncBodies ( Chaos::FPhysicsSolverBase* Sol... )
void	PullPhysicsStateForEachDirtyProxy ( const int32 SyncTimestamp, const RigidLambda& DirtyRigidFunc )
void	RemoveActorFromAccelerationStructure ( FPhysicsActorHandle& Actor )
void	RemoveActorFromAccelerationStructure ( Chaos::TGeometryParticle< Chaos::FR... )
void	SetUpForFrame ( const FVector* NewGrav, float InDeltaSeconds, float InMaxPhysicsDeltaTime, float InMaxSubstepDeltaTime, int32 InMaxSubsteps, bool bSubstepping )
void	StartFrame()
void	UpdateActorInAccelerationStructure ( const FPhysicsActorHandle& Actor )
void	UpdateActorsInAccelerationStructure ( const TArrayView< FPhysicsActorHand... )
void	WaitPhysScenes()

Typedefs

Name	Description
FOnPhysScenePostTick

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss