Open 3D Engine AtomLyIntegration Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::Render::MaterialComponentNotifications Class Reference

#include <MaterialComponentBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual void OnMaterialsEdited ()
 This notification is sent whenever material changes are made that need to be reflected in the UI.
 
virtual void OnMaterialSlotLayoutChanged ()
 This notification is forwarded from the consumer whenever material slot layout or default values are changed.
 
virtual void OnMaterialsCreated (const MaterialAssignmentMap &materials)
 This notification is sent once per tick whenever new material instances are created.
 
virtual void OnMaterialsUpdated (const MaterialAssignmentMap &materials)
 
virtual void OnMaterialPropertiesUpdated (const MaterialAssignmentMap &materials)
 This notification is sent once per tick whenever the material component changes any material properties.
 

Detailed Description

MaterialComponentNotificationBus notifications are sent whenever the state of the material component changes in a way that would affect tools or consumers.

Member Function Documentation

◆ OnMaterialsUpdated()

virtual void AZ::Render::MaterialComponentNotifications::OnMaterialsUpdated ( const MaterialAssignmentMap &  materials)
inlinevirtual

This notification is sent whenever the material component has completed adding or removing a batch of instances for the material consumer to apply. The notification is not sent for individual property changes because the material component applies property changes directly to the material instances it manages. The notification should only be sent once per batch of changes, after material assets have been loaded, reloaded, or if a material property change resulted in creating a new, unique instance. Other functions can be invoked through editing or script that might also result in this notification being sent.


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