Open 3D Engine Atom Gem API Reference  23.05.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 Member Functions | List of all members
MaterialEditor::MaterialDocument Class Reference

MaterialDocument provides an API for modifying and saving material document properties. More...

#include <MaterialDocument.h>

Inherits AtomToolsFramework::AtomToolsDocument, Handler, and Handler.

Public Member Functions

 AZ_RTTI (MaterialDocument,"{90299628-AD02-4FEB-9527-7278FA2817AD}", AtomToolsFramework::AtomToolsDocument)
 
 AZ_CLASS_ALLOCATOR (MaterialDocument, AZ::SystemAllocator)
 
 AZ_DISABLE_COPY_MOVE (MaterialDocument)
 
 MaterialDocument (const AZ::Crc32 &toolId, const AtomToolsFramework::DocumentTypeInfo &documentTypeInfo)
 
AtomToolsFramework::DocumentObjectInfoVector GetObjectInfo () const override
 
bool Open (const AZStd::string &loadPath) override
 
bool Save () override
 
bool SaveAsCopy (const AZStd::string &savePath) override
 
bool SaveAsChild (const AZStd::string &savePath) override
 
bool IsModified () const override
 
bool CanSaveAsChild () const override
 
bool BeginEdit () override
 
bool EndEdit () override
 
AZ::Data::Asset
< AZ::RPI::MaterialAsset > 		GetAsset () const override
 
AZ::Data::Instance
< AZ::RPI::Material > 		GetInstance () const override
 
const AZ::RPI::MaterialSourceData * GetMaterialSourceData () const override
 
const
AZ::RPI::MaterialTypeSourceData * 		GetMaterialTypeSourceData () const override
 
void SetPropertyValue (const AZStd::string &propertyId, const AZStd::any &value) override
 
const AZStd::any & GetPropertyValue (const AZStd::string &propertyId) const override
 
- Public Member Functions inherited from AtomToolsFramework::AtomToolsDocument
 AZ_RTTI (AtomToolsDocument,"{7E6CA0C4-077C-4849-B24C-6796AF3B640B}")
 
 AZ_CLASS_ALLOCATOR (AtomToolsDocument, AZ::SystemAllocator)
 
 AZ_DISABLE_COPY_MOVE (AtomToolsDocument)
 
 AtomToolsDocument (const AZ::Crc32 &toolId, const DocumentTypeInfo &documentTypeInfo)
 
const DocumentTypeInfo & GetDocumentTypeInfo () const override
 
DocumentObjectInfoVector GetObjectInfo () const override
 
const AZ::Uuid & GetId () const override
 
const AZStd::string & GetAbsolutePath () const override
 
bool Open (const AZStd::string &loadPath) override
 
bool Reopen () override
 
bool Save () override
 
bool SaveAsCopy (const AZStd::string &savePath) override
 
bool SaveAsChild (const AZStd::string &savePath) override
 
bool Close () override
 
void Clear () override
 
bool IsOpen () const override
 
bool IsModified () const override
 
bool CanSaveAsChild () const override
 
bool CanUndo () const override
 
bool CanRedo () const override
 
bool Undo () override
 
bool Redo () override
 
bool BeginEdit () override
 
bool EndEdit () override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static
AtomToolsFramework::DocumentTypeInfo 		BuildDocumentTypeInfo ()
 
- Static Public Member Functions inherited from AtomToolsFramework::AtomToolsDocument
static void Reflect (AZ::ReflectContext *context)
 

Additional Inherited Members

- Protected Types inherited from AtomToolsFramework::AtomToolsDocument
using UndoRedoFunction = AZStd::function< void()>
 
using UndoRedoFunctionPair = AZStd::pair< UndoRedoFunction, UndoRedoFunction >
 
using UndoRedoHistory = AZStd::vector< UndoRedoFunctionPair >
 
- Protected Member Functions inherited from AtomToolsFramework::AtomToolsDocument
virtual bool OpenSucceeded ()
 
virtual bool OpenFailed ()
 
virtual bool SaveSucceeded ()
 
virtual bool SaveFailed ()
 
void AddUndoRedoHistory (const UndoRedoFunction &undoCommand, const UndoRedoFunction &redoCommand)
 Add new undo redo command functions at the current position in the undo history.
 
void SourceFileChanged (AZStd::string relativePath, AZStd::string scanFolder, AZ::Uuid sourceUUID) override
 
- Protected Attributes inherited from AtomToolsFramework::AtomToolsDocument
const AZ::Crc32 m_toolId = {}
 
const DocumentTypeInfo m_documentTypeInfo = {}
 
const AZ::Uuid m_id = AZ::Uuid::CreateRandom()
 The unique id of this document, used for all bus notifications and requests.
 
AZStd::string m_absolutePath
 The absolute path to the document source file.
 
AZStd::string m_savePathNormalized
 The normalized, absolute path where the document will be saved.
 
AZStd::unordered_set
< AZStd::string > 		m_sourceDependencies
 
bool m_ignoreSourceFileChangeToSelf = false
 If this flag is true then the next source file change notification for this document will be ignored.
 
UndoRedoHistory m_undoHistory
 
UndoRedoHistory m_undoHistoryBeforeReopen
 
int m_undoHistoryIndex = {}
 
int m_undoHistoryIndexBeforeReopen = {}
 

Detailed Description

MaterialDocument provides an API for modifying and saving material document properties.

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