Chaos::FPhysicalMaterialManager Class Reference

#include <PhysicalMaterials.h>

Public Member Functions
CHAOS_API FMaterialHandle	Create ()
CHAOS_API FMaterialMaskHandle	CreateMask ()
CHAOS_API void	Destroy (FMaterialHandle InHandle)
CHAOS_API void	Destroy (FMaterialMaskHandle InHandle)
CHAOS_API FChaosPhysicsMaterial *	Resolve (FChaosMaterialHandle InHandle) const
CHAOS_API const FChaosPhysicsMaterial *	Resolve (FChaosConstMaterialHandle InHandle) const
CHAOS_API FChaosPhysicsMaterialMask *	Resolve (FChaosMaterialMaskHandle InHandle) const
CHAOS_API const FChaosPhysicsMaterialMask *	Resolve (FChaosConstMaterialMaskHandle InHandle) const
CHAOS_API void	UpdateMaterial (FMaterialHandle InHandle)
CHAOS_API void	UpdateMaterialMask (FMaterialMaskHandle InHandle)
CHAOS_API const THandleArray< FChaosPhysicsMaterial > &	GetMasterMaterials_External () const
CHAOS_API const THandleArray< FChaosPhysicsMaterialMask > &	GetMasterMaterialMasks_External () const
CHAOS_API const THandleArray< FChaosPhysicsMaterial > &	GetPrimaryMaterials_External () const
CHAOS_API const THandleArray< FChaosPhysicsMaterialMask > &	GetPrimaryMaterialMasks_External () const

Static Public Member Functions
static CHAOS_API FPhysicalMaterialManager &	Get ()

Public Attributes
FOnMaterialUpdated	OnMaterialUpdated
FOnMaterialCreated	OnMaterialCreated
FOnMaterialDestroyed	OnMaterialDestroyed
FOnMaterialMaskUpdated	OnMaterialMaskUpdated
FOnMaterialMaskCreated	OnMaterialMaskCreated
FOnMaterialMaskDestroyed	OnMaterialMaskDestroyed

Detailed Description

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()

Member Function Documentation

Create()

FMaterialHandle Chaos::FPhysicalMaterialManager::Create

(

)

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

CreateMask()

FMaterialMaskHandle Chaos::FPhysicalMaterialManager::CreateMask

(

)

Destroy() [1/2]

void Chaos::FPhysicalMaterialManager::Destroy

(

FMaterialHandle

InHandle

)

Destroy the material referenced by the provided handle

Destroy() [2/2]

void Chaos::FPhysicalMaterialManager::Destroy

(

FMaterialMaskHandle

InHandle

)

Get()

FPhysicalMaterialManager & Chaos::FPhysicalMaterialManager::Get ( )

static

GetMasterMaterialMasks_External()

const Chaos::THandleArray< FChaosPhysicsMaterialMask > & Chaos::FPhysicalMaterialManager::GetMasterMaterialMasks_External

(

)

const

GetMasterMaterials_External()

const Chaos::THandleArray< FChaosPhysicsMaterial > & Chaos::FPhysicalMaterialManager::GetMasterMaterials_External

(

)

const

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

GetPrimaryMaterialMasks_External()

const Chaos::THandleArray< FChaosPhysicsMaterialMask > & Chaos::FPhysicalMaterialManager::GetPrimaryMaterialMasks_External

(

)

const

GetPrimaryMaterials_External()

const Chaos::THandleArray< FChaosPhysicsMaterial > & Chaos::FPhysicalMaterialManager::GetPrimaryMaterials_External

(

)

const

Resolve() [1/4]

const FChaosPhysicsMaterialMask * Chaos::FPhysicalMaterialManager::Resolve

(

FChaosConstMaterialHandle

InHandle

)

const

Resolve() [2/4]

CHAOS_API const FChaosPhysicsMaterialMask * Chaos::FPhysicalMaterialManager::Resolve

(

FChaosConstMaterialMaskHandle

InHandle

)

const

Resolve() [3/4]

FChaosPhysicsMaterialMask * Chaos::FPhysicalMaterialManager::Resolve

(

FChaosMaterialHandle

InHandle

)

const

Get the actual material from a handle

Resolve() [4/4]

CHAOS_API FChaosPhysicsMaterialMask * Chaos::FPhysicalMaterialManager::Resolve

(

FChaosMaterialMaskHandle

InHandle

)

const

UpdateMaterial()

void Chaos::FPhysicalMaterialManager::UpdateMaterial

(

FMaterialHandle

InHandle

)

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

UpdateMaterialMask()

void Chaos::FPhysicalMaterialManager::UpdateMaterialMask

(

FMaterialMaskHandle

InHandle

)

Member Data Documentation

OnMaterialCreated

FOnMaterialCreated Chaos::FPhysicalMaterialManager::OnMaterialCreated

OnMaterialDestroyed

FOnMaterialDestroyed Chaos::FPhysicalMaterialManager::OnMaterialDestroyed

OnMaterialMaskCreated

FOnMaterialMaskCreated Chaos::FPhysicalMaterialManager::OnMaterialMaskCreated

OnMaterialMaskDestroyed

FOnMaterialMaskDestroyed Chaos::FPhysicalMaterialManager::OnMaterialMaskDestroyed

OnMaterialMaskUpdated

FOnMaterialMaskUpdated Chaos::FPhysicalMaterialManager::OnMaterialMaskUpdated

OnMaterialUpdated

FOnMaterialUpdated Chaos::FPhysicalMaterialManager::OnMaterialUpdated

Events

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/PhysicalMaterials.h
• Engine/Source/Runtime/Experimental/Chaos/Private/Chaos/PhysicalMaterials.cpp