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 > Chaos > Chaos > FPhysicalMaterialManager

Light Theme

Dark Theme

FPhysicalMaterialManager

Global manager for physical materials.

Windows

MacOS

Linux

References

Module	Chaos
Header	/Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/PhysicalMaterials.h
Include	#include "Chaos/PhysicalMaterials.h"

Syntax

class FPhysicalMaterialManager

Remarks

Global manager for physical materials. Materials are created, updated and destroyed only on the game thread and an immutable copy of the materials are stored on each solver. The solvers module binds to the updated event in this manager and enqueues updates to all active solvers when a material is updated.

The material manager provides handles for the objects which should be stored instead of the material pointer. When accessing the internal material always use the handle rather than storing the result of Get()

Variables

	Name	Description
FOnMaterialCrea...	OnMaterialCreated
FOnMaterialDest...	OnMaterialDestroyed
FOnMaterialMask...	OnMaterialMaskCreated
FOnMaterialMask...	OnMaterialMaskDestroyed
FOnMaterialMask...	OnMaterialMaskUpdated
FOnMaterialUpda...	OnMaterialUpdated	Events

Constructors

No constructors are accessible with public or protected access.

Functions

	Name	Description
FMaterialHan...	Create()	Create a new material, returning a stable handle to it - this should be stored and not the actual material pointer
FMaterialMas...	CreateMask()	Create a new material, returning a stable handle to it - this should be stored and not the actual material pointer
void	Destroy ( FMaterialHandle InHandle )	Destroy the material referenced by the provided handle
void	Destroy ( FMaterialMaskHandle InHandle )	Destroy the material referenced by the provided handle
FPhysicalMat...	Get()
const THandl...	GetMasterMaterialMasks()
const THandl...	GetMasterMaterials()	Gets the internal list of master materials representing the current user state of the material data
FChaosPhysic...	Resolve ( FChaosMaterialHandle InHandle )	Get the actual material from a handle
const FChaos...	Resolve ( FChaosConstMaterialHandle InHandle )	Get the actual material from a handle
FChaosPhysic...	Resolve ( FChaosMaterialMaskHandle InHandle )
const FChaos...	Resolve ( FChaosConstMaterialMaskHandle InHan... )	Get the actual material from a handle
void	UpdateMaterial ( FMaterialHandle InHandle )	Signals stakeholders that the stored material for the provided handle has changed
void	UpdateMaterialMask ( FMaterialMaskHandle InHandle )	Signals stakeholders that the stored material for the provided handle has changed

Constants

Name	Description
InitialCapacity	Initial size for the handle-managed array

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

Take our survey

Dismiss