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 | List of all members
AZ::Render::EditorMaterialComponentInspector::MaterialPropertyInspector Class Reference

#include <EditorMaterialComponentInspector.h>

Inherits AtomToolsFramework::InspectorWidget, AzToolsFramework::IPropertyEditorNotify, AZ::EntitySystemBus::Handler, AZ::SystemTickBus::Handler, MaterialComponentNotificationBus::MultiHandler, and EditorMaterialSystemComponentNotificationBus::Handler.

Public Member Functions

 AZ_CLASS_ALLOCATOR (MaterialPropertyInspector, AZ::SystemAllocator)
 
 MaterialPropertyInspector (QWidget *parent=nullptr)
 
bool LoadMaterial (const AZ::EntityId &primaryEntityId, const AzToolsFramework::EntityIdSet &entityIdsToEdit, const AZ::Render::MaterialAssignmentId &materialAssignmentId)
 
void UnloadMaterial ()
 Releases all of the edit data and assets, clearing the inspector of all content.
 
bool IsLoaded () const
 
void Reset () override
 
void Populate ()
 Builds all of the properties and generates the user interface for the inspector.
 
AZStd::string GetRelativePath (const AZStd::string &path) const
 
AZStd::string GetFileName (const AZStd::string &path) const
 
bool IsSourceMaterial (const AZStd::string &path) const
 
bool SaveMaterial (const AZStd::string &path) const
 
void OpenMenu ()
 
const EditorMaterialComponentUtil::MaterialEditData & GetEditData () const
 

Detailed Description

Inspector window for displaying and editing entity material instance properties If multiple entities are selected and pinned to this inspector then their corresponding properties will also be updated

Member Function Documentation

◆ IsLoaded()

bool AZ::Render::EditorMaterialComponentInspector::MaterialPropertyInspector::IsLoaded ( ) const

Returns true if all of the edit data has been loaded, the instance has been created, the primary entity and material slot has not changed the assigned material, and all of the entities share the same material type

◆ LoadMaterial()

bool AZ::Render::EditorMaterialComponentInspector::MaterialPropertyInspector::LoadMaterial ( const AZ::EntityId &  primaryEntityId,
const AzToolsFramework::EntityIdSet &  entityIdsToEdit,
const AZ::Render::MaterialAssignmentId &  materialAssignmentId 
)

Loads the material edit data for the active material on the primary entity ID. The function will fail and return false if the data cannot be loaded or the rest of the entities are not compatible with the primary entity materials.

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