Navigation
Unreal Engine C++ API Reference > Runtime > Chaos > Chaos
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
| Type | Name | Description | |
|---|---|---|---|
 |
FOnMaterialCreated | OnMaterialCreated | |
 |
FOnMaterialDestroyed | OnMaterialDestroyed | |
 |
FOnMaterialMaskCreated | OnMaterialMaskCreated | |
 |
FOnMaterialMaskDestroyed | OnMaterialMaskDestroyed | |
 |
FOnMaterialMaskUpdated | OnMaterialMaskUpdated | |
 |
FOnMaterialUpdated | OnMaterialUpdated | Events |
Constructors
No constructors are accessible with public or protected access.
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
FMaterialHandle | Create () |
Create a new material, returning a stable handle to it - this should be stored and not the actual material pointer |
 |
FMaterialMaskHandle | 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 |
  |
FPhysicalMaterialManager & | Get () |
|
  |
const THandleArray< FChaosPhysicsMaterialMask > & | ||
  |
const THandleArray< FChaosPhysicsMaterial > & | ||
  |
FChaosPhysicsMaterial * | Resolve
(
FChaosMaterialHandle InHandle |
Get the actual material from a handle |
  |
const FChaosPhysicsMaterial * | Resolve
(
FChaosConstMaterialHandle InHandle |
Get the actual material from a handle |
  |
FChaosPhysicsMaterialMask * | Resolve
(
FChaosMaterialMaskHandle InHandle |
|
  |
const FChaosPhysicsMaterialMask * | Resolve
(
FChaosConstMaterialMaskHandle InHandle |
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 |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
  |
const THandleArray< FChaosPhysicsMaterialMask > & | GetMasterMaterialMasks_External is deprecated, please use GetPrimaryMaterialMasks_External instead | |
  |
const THandleArray< FChaosPhysicsMaterial > & | GetMasterMaterials_External is deprecated, please use GetPrimaryMaterials_External instead |