Open 3D Engine Atom Gem API Reference 24.09.2
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
AtomToolsFramework::AtomToolsApplication Class Reference

Base class for Atom tools to inherit from. More...

#include <AtomToolsApplication.h>

Inherits AzQtComponents::AzQtApplication, AzFramework::Application, AzToolsFramework::AssetDatabase::AssetDatabaseRequestsBus::Handler, AzToolsFramework::EditorPythonConsoleNotificationBus::Handler, and AZ::UserSettingsOwnerRequestBus::Handler.

Inherited by AtomToolsFramework::AtomToolsDocumentApplication.

Public Types

using Base = AzFramework::Application
 

Public Member Functions

 AZ_TYPE_INFO (AtomToolsApplication, "{A0DF25BA-6F74-4F11-9F85-0F99278D5986}")
 
 AZ_DISABLE_COPY_MOVE (AtomToolsApplication)
 
 AtomToolsApplication (const char *targetName, int *argc, char ***argv)
 
 AtomToolsApplication (const char *targetName, int *argc, char ***argv, AZ::ComponentApplicationSettings componentAppSettings)
 
virtual bool LaunchLocalServer ()
 
void CreateReflectionManager () override
 
void Reflect (AZ::ReflectContext *context) override
 
void RegisterCoreComponents () override
 
AZ::ComponentTypeList GetRequiredSystemComponents () const override
 
void CreateStaticModules (AZStd::vector< AZ::Module * > &outModules) override
 
const char * GetCurrentConfigurationName () const override
 
void StartCommon (AZ::Entity *systemEntity) override
 
void Destroy () override
 
void RunMainLoop () override
 

Protected Member Functions

void OnIdle ()
 
bool GetAssetDatabaseLocation (AZStd::string &result) override
 
void QueryApplicationType (AZ::ApplicationTypeQuery &appType) const override
 
void SaveSettings () override
 
void OnTraceMessage (AZStd::string_view message) override
 
void OnErrorMessage (AZStd::string_view message) override
 
void OnExceptionMessage (AZStd::string_view message) override
 
virtual AZStd::vector< AZStd::string > GetCriticalAssetFilters () const
 List of filters for assets that need to be pre-built to run the application.
 
virtual void LoadSettings ()
 
virtual void UnloadSettings ()
 
virtual void ConnectToAssetProcessor ()
 
virtual void CompileCriticalAssets ()
 
virtual void ProcessCommandLine (const AZ::CommandLine &commandLine)
 
void PrintAlways (const AZStd::string &output)
 
void RedirectStdoutToNull ()
 

Static Protected Member Functions

static void PyIdleWaitFrames (uint32_t frames)
 
static void PyExit ()
 
static void PyCrash ()
 
static void PyTestOutput (const AZStd::string &output)
 
static AtomToolsApplication * GetInstance ()
 

Protected Attributes

AzToolsFramework::TraceLogger m_traceLogger
 
AZStd::unique_ptr< AzQtComponents::StyleManager > m_styleManager
 
AZ::UserSettingsProvider m_localUserSettings
 Local user settings are used to store asset browser tree expansion state.
 
bool m_activatedLocalUserSettings = false
 Are local settings loaded.
 
AtomToolsFramework::LocalSocket m_socket
 
AtomToolsFramework::LocalServer m_server
 
AZStd::unique_ptr< AtomToolsFramework::AtomToolsAssetBrowserInteractions > m_assetBrowserInteractions
 
const AZStd::string m_targetName
 
const AZ::Crc32 m_toolId = {}
 
 AZ_PUSH_DISABLE_DLL_EXPORT_MEMBER_WARNING
 
AZ::IO::FileDescriptorRedirector m_stdoutRedirection = AZ::IO::FileDescriptorRedirector(1)
 
 AZ_POP_DISABLE_DLL_EXPORT_MEMBER_WARNING
 

Static Protected Attributes

static AtomToolsApplication * m_instance
 

Detailed Description

Base class for Atom tools to inherit from.

Member Function Documentation

◆ GetCriticalAssetFilters()

virtual AZStd::vector< AZStd::string > AtomToolsFramework::AtomToolsApplication::GetCriticalAssetFilters ( ) const
protectedvirtual

List of filters for assets that need to be pre-built to run the application.

Reimplemented in MaterialEditor::MaterialEditorApplication, and ShaderManagementConsole::ShaderManagementConsoleApplication.

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