Open 3D Engine AzToolsFramework 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 Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
AzToolsFramework::AssetEditor::AssetEditorTab Class Reference

#include <AssetEditorTab.h>

Inherits QWidget, AZ::Data::AssetBus::MultiHandler, AzFramework::AssetCatalogEventBus::Handler, AzToolsFramework::IPropertyEditorNotify, and AZ::SystemTickBus::Handler.

Public Types

using SaveCompleteCallback = AZStd::function< void()>
 

Public Slots

void SaveAsset ()
 
bool SaveAsDialog ()
 
bool SaveAssetToPath (AZStd::string_view assetPath)
 
void ExpandAll ()
 
void CollapseAll ()
 
void OnDocumentPropertyChanged (const AZ::DocumentPropertyEditor::ReflectionAdapter::PropertyChangeInfo &changeInfo)
 

Signals

void OnAssetSavedSignal ()
 
void OnAssetSaveFailedSignal (const AZStd::string &error)
 
void OnAssetRevertedSignal ()
 
void OnAssetRevertFailedSignal (const AZStd::string &error)
 
void OnAssetOpenedSignal (const AZ::Data::Asset< AZ::Data::AssetData > &asset)
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (AssetEditorTab, AZ::SystemAllocator)
 
 AssetEditorTab (QWidget *parent=nullptr)
 
void LoadAsset (AZ::Data::AssetId assetId, AZ::Data::AssetType assetType, const QString &assetName)
 
void CreateAsset (AZ::Data::AssetType assetType, const QString &assetName, const AZ::Uuid &observerToken)
 
const AZ::Data::AssetId & GetAssetId () const
 
void OnAssetReady (AZ::Data::Asset< AZ::Data::AssetData > asset) override
 
void OnAssetReloaded (AZ::Data::Asset< AZ::Data::AssetData > asset) override
 
void OnAssetError (AZ::Data::Asset< AZ::Data::AssetData > asset) override
 
bool IsDirty () const
 
bool WaitingToSave () const
 
const QString & GetAssetName ()
 
bool TrySaveAsset (const AZStd::function< void()> &savedCallback)
 
bool UserRefusedSave ()
 
void ClearUserRefusedSaveFlag ()
 

Protected Member Functions

void AfterPropertyModified (InstanceDataNode *) override
 
void RequestPropertyContextMenu (InstanceDataNode *, const QPoint &) override
 
void BeforePropertyModified (InstanceDataNode *node) override
 
void SetPropertyEditingActive (InstanceDataNode *) override
 
void SetPropertyEditingComplete (InstanceDataNode *) override
 
void SealUndoStack () override
 
void OnCatalogAssetAdded (const AZ::Data::AssetId &assetId) override
 
void OnCatalogAssetRemoved (const AZ::Data::AssetId &assetId, const AZ::Data::AssetInfo &assetInfo) override
 

Detailed Description

Provides ability to create, edit, and save reflected assets.

Member Function Documentation

◆ AfterPropertyModified()

void AzToolsFramework::AssetEditor::AssetEditorTab::AfterPropertyModified ( InstanceDataNode *  )
overrideprotectedvirtual

Implements AzToolsFramework::IPropertyEditorNotify.

◆ BeforePropertyModified()

void AzToolsFramework::AssetEditor::AssetEditorTab::BeforePropertyModified ( InstanceDataNode *  node)
overrideprotectedvirtual

Implements AzToolsFramework::IPropertyEditorNotify.

◆ RequestPropertyContextMenu()

void AzToolsFramework::AssetEditor::AssetEditorTab::RequestPropertyContextMenu ( InstanceDataNode *  ,
const QPoint &   
)
overrideprotectedvirtual

Reimplemented from AzToolsFramework::IPropertyEditorNotify.

◆ SealUndoStack()

void AzToolsFramework::AssetEditor::AssetEditorTab::SealUndoStack ( )
inlineoverrideprotectedvirtual

Implements AzToolsFramework::IPropertyEditorNotify.

◆ SetPropertyEditingActive()

void AzToolsFramework::AssetEditor::AssetEditorTab::SetPropertyEditingActive ( InstanceDataNode *  )
inlineoverrideprotectedvirtual

Implements AzToolsFramework::IPropertyEditorNotify.

◆ SetPropertyEditingComplete()

void AzToolsFramework::AssetEditor::AssetEditorTab::SetPropertyEditingComplete ( InstanceDataNode *  )
inlineoverrideprotectedvirtual

Implements AzToolsFramework::IPropertyEditorNotify.

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