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.
Public Member Functions | Static Public Attributes | List of all members
AZ::Render::EditorMaterialSystemComponentRequests Class Referenceabstract

#include <EditorMaterialSystemComponentRequestBus.h>

Inherits AZ::EBusTraits.

Public Member Functions

virtual void OpenMaterialEditor (const AZStd::string &sourcePath)=0
 Open document in material editor.
 
virtual void OpenMaterialCanvas (const AZStd::string &sourcePath)=0
 Open document in material canvas.
 
virtual void OpenMaterialInspector (const AZ::EntityId &primaryEntityId, const AzToolsFramework::EntityIdSet &entityIdsToEdit, const AZ::Render::MaterialAssignmentId &materialAssignmentId)=0
 
virtual void RenderMaterialPreview (const AZ::EntityId &entityId, const AZ::Render::MaterialAssignmentId &materialAssignmentId)=0
 Generate a material preview image for a specific entity and material slot with material and property overrides applied.
 
virtual QPixmap GetRenderedMaterialPreview (const AZ::EntityId &entityId, const AZ::Render::MaterialAssignmentId &materialAssignmentId) const =0
 Get the most recently rendered material preview image for the entity and material slot if one is available.
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 

Detailed Description

EditorMaterialSystemComponentRequests provides an interface for interacting with EditorMaterialSystemComponent, performing different operations like opening the material editor, the material instance inspector, and managing material preview images

Member Function Documentation

◆ OpenMaterialInspector()

virtual void AZ::Render::EditorMaterialSystemComponentRequests::OpenMaterialInspector ( const AZ::EntityId &  primaryEntityId,
const AzToolsFramework::EntityIdSet &  entityIdsToEdit,
const AZ::Render::MaterialAssignmentId &  materialAssignmentId 
)
pure virtual

Open the material instance editor to preview and edit material property overrides for the primary entity while applying changes to all entities in the editable set

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