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

Constructors

No constructors are accessible with public or protected access.

Functions

Name Description

Public function

FMaterialHan ...

 

Create()

Create a new material, returning a stable handle to it - this should be stored and not the actual material pointer

Public function

FMaterialMas ...

 

CreateMask()

Create a new material, returning a stable handle to it - this should be stored and not the actual material pointer

Public function

void

 

Destroy

(
    FMaterialHandle InHandle
)

Destroy the material referenced by the provided handle

Public function

void

 

Destroy

(
    FMaterialMaskHandle InHandle
)

Destroy the material referenced by the provided handle

Public function Static

FPhysicalMat ...

 

Get()

Public function Const

const THandl ...

 

GetMasterMaterialMasks()

Public function Const

const THandl ...

 

GetMasterMaterials()

Gets the internal list of master materials representing the current user state of the material data

Public function Const

FChaosPhysic ...

 

Resolve

(
    FChaosMaterialHandle InHandle
)

Get the actual material from a handle

Public function Const

const FChaos ...

 

Resolve

(
    FChaosConstMaterialHandle InHandle
)

Get the actual material from a handle

Public function Const

FChaosPhysic ...

 

Resolve

(
    FChaosMaterialMaskHandle InHandle
)

Public function Const

const FChaos ...

 

Resolve

(
    FChaosConstMaterialMaskHandle InHan...
)

Get the actual material from a handle

Public function

void

 

UpdateMaterial

(
    FMaterialHandle InHandle
)

Signals stakeholders that the stored material for the provided handle has changed

Public function

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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback