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

> Unreal Engine API Reference > Runtime > Engine > Physics > Experimental > FPhysScene_Chaos

Light Theme

Dark Theme

FPhysScene_Chaos

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

Windows

MacOS

Linux

Inheritance Hierarchy

FTickableGameObject

FGCObject

FPhysScene_Chaos

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/Physics/Experimental/PhysScene_Chaos.h
Include	#include "Physics/Experimental/PhysScene_Chaos.h"

Syntax

class FPhysScene_Chaos :
public FTickableGameObject,
public FGCObject

Remarks

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

Constructors

	Name	Description
	FPhysScene_Chaos ( AActor* InSolverActor )

Destructors

	Name	Description
	~FPhysScene_Chaos()

Functions

	Name	Description
void	AddObject ( UPrimitiveComponent* Component, FGeometryParticlePhysicsProxy*... )	Called during creation of the physics state for gamethread objects to pass off an object to the physics thread
void	AddObject ( UPrimitiveComponent* Component, FGeometryCollectionPhysicsProxy... )	Called during creation of the physics state for gamethread objects to pass off an object to the physics thread
void	AddObject ( UPrimitiveComponent* Component, FFieldSystemPhysicsProxy* InOb... )	Called during creation of the physics state for gamethread objects to pass off an object to the physics thread
void	AddObject ( UPrimitiveComponent* Component, FStaticMeshPhysicsProxy* InObj... )	Called during creation of the physics state for gamethread objects to pass off an object to the physics thread
void	AddObject ( UPrimitiveComponent* Component, FSkeletalMeshPhysicsProxy* InO... )	Called during creation of the physics state for gamethread objects to pass off an object to the physics thread
void	AddPieModifiedObject ( UObject* InObj )
void	AddToComponentMaps ( UPrimitiveComponent* Component, IPhysicsProxyBase* InObject )
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
Chaos::IDisp...	GetDispatcher()	Get the internal Dispatcher object
IPhysicsProx...	GetOwnedPhysicsProxy ( UPrimitiveComponent* Comp )	Given a component, returns its associated solver object.
OwnerType &#...	GetOwningComponent ( IPhysicsProxyBase* PhysicsProx... )	Given a solver object, returns its associated component.
FPhysicsRepl...	GetPhysicsReplication()
Chaos::FPhys...	GetSolver()	Get the internal Chaos solver object
AActor *	GetSolverActor()	Returns the actor that owns this solver.
Chaos::ISpat...	GetSpacialAcceleration()
const Chaos:...	GetSpacialAcceleration()
void	OnWorldEndPlay()	Callback when a world ends, to mark updated packages dirty.
void	RegisterForCollisionEvents ( UPrimitiveComponent* Component )
void	RemoveActorFromAccelerationStructure ( FPhysicsActorHandle& Actor )
void	RemoveFromComponentMaps ( IPhysicsProxyBase* InObject )
void	RemoveObject ( FGeometryCollectionPhysicsProxy... )	Called during physics state destruction for the game thread to remove objects from the simulation #BG TODO - Doesn't actually remove from the evolution at the moment
void	RemoveObject ( FSkeletalMeshPhysicsProxy* InO... )	Called during physics state destruction for the game thread to remove objects from the simulation #BG TODO - Doesn't actually remove from the evolution at the moment
void	RemoveObject ( FStaticMeshPhysicsProxy* InObj... )	Called during physics state destruction for the game thread to remove objects from the simulation #BG TODO - Doesn't actually remove from the evolution at the moment
void	RemoveObject ( FGeometryParticlePhysicsProxy*... )	Called during physics state destruction for the game thread to remove objects from the simulation #BG TODO - Doesn't actually remove from the evolution at the moment
void	RemoveObject ( FFieldSystemPhysicsProxy* InOb... )	Called during physics state destruction for the game thread to remove objects from the simulation #BG TODO - Doesn't actually remove from the evolution at the moment
void	SetPhysicsReplication ( FPhysicsReplication* InPhysics... )
void	Shutdown()
void	UnRegisterForCollisionEvents ( UPrimitiveComponent* Component )
void	UpdateActorInAccelerationStructure ( const FPhysicsActorHandle& Actor )
void	UpdateActorsInAccelerationStructure ( const TArrayView< FPhysicsActorHand... )

Overridden from FTickableGameObject

		Name	Description
	bool	IsTickableInEditor()	Used to determine whether the object should be ticked in the editor.
	bool	IsTickableWhenPaused()	Used to determine if an object should be ticked when the game is paused.

Overridden from FTickableObjectBase

	Name	Description
TStatId	GetStatId()	Return the stat id to use for this tickable
ETickableTic...	GetTickableTickType()	Begin FTickableGameObject implementation.
bool	IsTickable()	Virtual that can be overloaded by the inheriting class.
void	Tick ( float DeltaTime )	Pure virtual that must be overloaded by the inheriting class.

Overridden from FGCObject

		Name	Description
	void	AddReferencedObjects ( FReferenceCollector& Collector )	FGCObject Interface ///////////////////////////////////////////////////.
	FString	GetReferencerName()	Use this method to report a name for your referencer.

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

Take our survey

Dismiss