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.
PassCanvas::PassCanvasApplication Class Reference

The main application class for Pass Canvas, setting up top level systems, document types, and the main window. More...

#include <PassCanvasApplication.h>

Inherits AtomToolsFramework::AtomToolsDocumentApplication, AzToolsFramework::EditorWindowRequestBus::Handler, and AtomToolsFramework::AtomToolsDocumentNotificationBus::Handler.

Public Types

using Base = AtomToolsFramework::AtomToolsDocumentApplication
 
- Public Types inherited from AtomToolsFramework::AtomToolsDocumentApplication
using Base = AtomToolsApplication
 
- Public Types inherited from AtomToolsFramework::AtomToolsApplication
using Base = AzFramework::Application
 

Public Member Functions

 AZ_TYPE_INFO (PassCanvas::PassCanvasApplication, "{792D3C47-F380-44BC-B47D-621D8C526360}")
 
 PassCanvasApplication (int *argc, char ***argv)
 
void Reflect (AZ::ReflectContext *context) override
 
const char * GetCurrentConfigurationName () const override
 
void StartCommon (AZ::Entity *systemEntity) override
 
void Destroy () override
 
- Public Member Functions inherited from AtomToolsFramework::AtomToolsDocumentApplication
 AZ_TYPE_INFO (AtomToolsDocumentApplication, "{AC892170-D353-404A-A3D8-BB039C717295}")
 
 AZ_DISABLE_COPY_MOVE (AtomToolsDocumentApplication)
 
 AtomToolsDocumentApplication (const char *targetName, int *argc, char ***argv)
 
- Public Member Functions inherited from AtomToolsFramework::AtomToolsApplication
 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
 

Additional Inherited Members

- Protected Member Functions inherited from AtomToolsFramework::AtomToolsDocumentApplication
void StartCommon (AZ::Entity *systemEntity) override
 
void Destroy () override
 
void ProcessCommandLine (const AZ::CommandLine &commandLine) override
 
- Protected Member Functions inherited from AtomToolsFramework::AtomToolsApplication
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 void LoadSettings ()
 
virtual void UnloadSettings ()
 
virtual void ConnectToAssetProcessor ()
 
virtual void CompileCriticalAssets ()
 
void PrintAlways (const AZStd::string &output)
 
void RedirectStdoutToNull ()
 
- Static Protected Member Functions inherited from AtomToolsFramework::AtomToolsApplication
static void PyIdleWaitFrames (uint32_t frames)
 
static void PyExit ()
 
static void PyCrash ()
 
static void PyTestOutput (const AZStd::string &output)
 
static AtomToolsApplicationGetInstance ()
 
- Protected Attributes inherited from AtomToolsFramework::AtomToolsDocumentApplication
AZStd::unique_ptr< AtomToolsDocumentSystemm_documentSystem
 
- Protected Attributes inherited from AtomToolsFramework::AtomToolsApplication
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::AtomToolsAssetBrowserInteractionsm_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 inherited from AtomToolsFramework::AtomToolsApplication
static AtomToolsApplicationm_instance
 

Detailed Description

The main application class for Pass Canvas, setting up top level systems, document types, and the main window.


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