Merge pull request #2605 from aws-lumberyard-dev/Atom/guthadam/updating_atomtoolsappication_comments_and_formatting

AtomToolsApplication minor comments/formatting
2021-07-29 15:23:53 -05:00
parent 1c9e2fd74c 4465b52de5
commit b357cd0000
4 changed files with 49 additions and 55 deletions
@@ -84,7 +84,10 @@ namespace AtomToolsFramework
        void OnExceptionMessage(AZStd::string_view message) override;
        ////////////////////////////////////////////////////////////////////////

+        //! Executable target name generally used as a prefix for logging and other saved files
        virtual AZStd::string GetBuildTargetName() const;
+
+        //! List of filters for assets that need to be pre-built to run the application
        virtual AZStd::vector<AZStd::string> GetCriticalAssetFilters() const;

        virtual void LoadSettings();
@@ -6,47 +6,44 @@
 *
 */

+#include <AzCore/IO/Path/Path.h>
+#include <AzCore/Settings/SettingsRegistryMergeUtils.h>
+#include <AzCore/Utils/Utils.h>
+#include <AzFramework/Asset/AssetSystemComponent.h>
+#include <AzFramework/IO/LocalFileIO.h>
+#include <AzFramework/Network/AssetProcessorConnection.h>
+#include <AzFramework/StringFunc/StringFunc.h>
+#include <AzToolsFramework/API/EditorPythonConsoleBus.h>
+#include <AzToolsFramework/API/EditorPythonRunnerRequestsBus.h>
+#include <AzToolsFramework/Asset/AssetSystemComponent.h>
+#include <AzToolsFramework/AssetBrowser/AssetBrowserComponent.h>
+#include <AzToolsFramework/AssetBrowser/AssetBrowserEntry.h>
+#include <AzToolsFramework/AzToolsFrameworkModule.h>
+#include <AzToolsFramework/SourceControl/PerforceComponent.h>
+#include <AzToolsFramework/SourceControl/SourceControlAPI.h>
+#include <AzToolsFramework/Thumbnails/ThumbnailerComponent.h>
+#include <AzToolsFramework/UI/PropertyEditor/PropertyManagerComponent.h>
+#include <AzToolsFramework/UI/UICore/QTreeViewStateSaver.hxx>
+#include <AzToolsFramework/UI/UICore/QWidgetSavedState.h>
+
 #include <AtomToolsFramework/Util/Util.h>

+#include <Atom/Document/MaterialDocumentSystemRequestBus.h>
 #include <Atom/RPI.Edit/Common/AssetUtils.h>
 #include <Atom/RPI.Public/RPISystemInterface.h>

 #include <Atom/Document/MaterialDocumentModule.h>
-#include <Atom/Document/MaterialDocumentSystemRequestBus.h>
-
 #include <Atom/Viewport/MaterialViewportModule.h>
-
-#include <Atom/Window/MaterialEditorWindowModule.h>
 #include <Atom/Window/MaterialEditorWindowFactoryRequestBus.h>
+#include <Atom/Window/MaterialEditorWindowModule.h>
 #include <Atom/Window/MaterialEditorWindowRequestBus.h>

-#include <AzCore/IO/Path/Path.h>
-#include <AzCore/Utils/Utils.h>
-#include <AzCore/Settings/SettingsRegistryMergeUtils.h>
-#include <AzFramework/StringFunc/StringFunc.h>
-#include <AzFramework/IO/LocalFileIO.h>
-#include <AzFramework/Network/AssetProcessorConnection.h>
-#include <AzFramework/Asset/AssetSystemComponent.h>
-
-#include <AzToolsFramework/AzToolsFrameworkModule.h>
-#include <AzToolsFramework/API/EditorPythonConsoleBus.h>
-#include <AzToolsFramework/API/EditorPythonRunnerRequestsBus.h>
-#include <AzToolsFramework/UI/UICore/QWidgetSavedState.h>
-#include <AzToolsFramework/UI/UICore/QTreeViewStateSaver.hxx>
-#include <AzToolsFramework/AssetBrowser/AssetBrowserEntry.h>
-#include <AzToolsFramework/SourceControl/PerforceComponent.h>
-#include <AzToolsFramework/Asset/AssetSystemComponent.h>
-#include <AzToolsFramework/AssetBrowser/AssetBrowserComponent.h>
-#include <AzToolsFramework/Thumbnails/ThumbnailerComponent.h>
-#include <AzToolsFramework/UI/PropertyEditor/PropertyManagerComponent.h>
-#include <AzToolsFramework/SourceControl/SourceControlAPI.h>
-
-#include <Source/MaterialEditorApplication.h>
+#include <MaterialEditorApplication.h>
 #include <MaterialEditor_Traits_Platform.h>

 AZ_PUSH_DISABLE_WARNING(4251 4800, "-Wunknown-warning-option") // disable warnings spawned by QT
-#include <QObject>
 #include <QMessageBox>
+#include <QObject>
 AZ_POP_DISABLE_WARNING

 namespace MaterialEditor
@@ -54,7 +51,7 @@ namespace MaterialEditor
    //! This function returns the build system target name of "MaterialEditor
    AZStd::string MaterialEditorApplication::GetBuildTargetName() const
    {
-#if !defined (LY_CMAKE_TARGET)
+#if !defined(LY_CMAKE_TARGET)
 #error "LY_CMAKE_TARGET must be defined in order to add this source file to a CMake executable target"
 #endif
        return AZStd::string{ LY_CMAKE_TARGET };
@@ -73,7 +70,6 @@ namespace MaterialEditor

    MaterialEditorApplication::MaterialEditorApplication(int* argc, char*** argv)
        : AtomToolsApplication(argc, argv)
-
    {
        QApplication::setApplicationName("O3DE Material Editor");

@@ -50,9 +50,6 @@ namespace MaterialEditor
        void ProcessCommandLine(const AZ::CommandLine& commandLine) override;
        void StartInternal() override;
        AZStd::string GetBuildTargetName() const override;
-
-        //! List of common asset filters for things that need to be compiled to run the material editor
-            //! Some of these things will not be necessary once we have proper support for queued asset loading and reloading
        AZStd::vector<AZStd::string> GetCriticalAssetFilters() const override;
     };
 } // namespace MaterialEditor
@@ -6,51 +6,48 @@
 *
 */

-#include <AzFramework/StringFunc/StringFunc.h>
+#include <AzCore/IO/Path/Path.h>
+#include <AzCore/Settings/SettingsRegistryMergeUtils.h>
+#include <AzCore/Utils/Utils.h>
 #include <AzFramework/IO/LocalFileIO.h>
 #include <AzFramework/Network/AssetProcessorConnection.h>
-
-#include <AzToolsFramework/AzToolsFrameworkModule.h>
+#include <AzFramework/StringFunc/StringFunc.h>
 #include <AzToolsFramework/API/EditorPythonConsoleBus.h>
 #include <AzToolsFramework/API/EditorPythonRunnerRequestsBus.h>
-#include <AzToolsFramework/UI/UICore/QWidgetSavedState.h>
-#include <AzToolsFramework/UI/UICore/QTreeViewStateSaver.hxx>
-#include <AzToolsFramework/AssetBrowser/AssetBrowserEntry.h>
-#include <AzToolsFramework/SourceControl/PerforceComponent.h>
 #include <AzToolsFramework/Asset/AssetSystemComponent.h>
 #include <AzToolsFramework/AssetBrowser/AssetBrowserComponent.h>
+#include <AzToolsFramework/AssetBrowser/AssetBrowserEntry.h>
+#include <AzToolsFramework/AzToolsFrameworkModule.h>
+#include <AzToolsFramework/SourceControl/PerforceComponent.h>
+#include <AzToolsFramework/SourceControl/SourceControlAPI.h>
 #include <AzToolsFramework/Thumbnails/ThumbnailerComponent.h>
 #include <AzToolsFramework/UI/PropertyEditor/PropertyManagerComponent.h>
-#include <AzToolsFramework/SourceControl/SourceControlAPI.h>
-
-#include <AtomToolsFramework/Util/Util.h>
+#include <AzToolsFramework/UI/UICore/QTreeViewStateSaver.hxx>
+#include <AzToolsFramework/UI/UICore/QWidgetSavedState.h>

 #include <Atom/RPI.Edit/Common/AssetUtils.h>
 #include <Atom/RPI.Public/RPISystemInterface.h>
+#include <AtomToolsFramework/Util/Util.h>

-#include <Source/ShaderManagementConsoleApplication.h>
+#include <ShaderManagementConsoleApplication.h>
 #include <ShaderManagementConsole_Traits_Platform.h>

 #include <Atom/Document/ShaderManagementConsoleDocumentModule.h>
 #include <Atom/Document/ShaderManagementConsoleDocumentSystemRequestBus.h>
-
 #include <Atom/Window/ShaderManagementConsoleWindowModule.h>
 #include <Atom/Window/ShaderManagementConsoleWindowRequestBus.h>
-#include <AzCore/IO/Path/Path.h>
-#include <AzCore/Settings/SettingsRegistryMergeUtils.h>
-#include <AzCore/Utils/Utils.h>

 AZ_PUSH_DISABLE_WARNING(4251 4800, "-Wunknown-warning-option") // disable warnings spawned by QT
 #include <QFileInfo>
-#include <QObject>
 #include <QMessageBox>
+#include <QObject>
 AZ_POP_DISABLE_WARNING

 namespace ShaderManagementConsole
 {
    AZStd::string ShaderManagementConsoleApplication::GetBuildTargetName() const
    {
-#if !defined (LY_CMAKE_TARGET)
+#if !defined(LY_CMAKE_TARGET)
 #error "LY_CMAKE_TARGET must be defined in order to add this source file to a CMake executable target"
 #endif
        return AZStd::string_view{ LY_CMAKE_TARGET };
@@ -94,7 +91,8 @@ namespace ShaderManagementConsole
    void ShaderManagementConsoleApplication::Destroy()
    {
        // before modules are unloaded, destroy UI to free up any assets it cached
-        ShaderManagementConsole::ShaderManagementConsoleWindowRequestBus::Broadcast(&ShaderManagementConsole::ShaderManagementConsoleWindowRequestBus::Handler::DestroyShaderManagementConsoleWindow);
+        ShaderManagementConsole::ShaderManagementConsoleWindowRequestBus::Broadcast(
+            &ShaderManagementConsole::ShaderManagementConsoleWindowRequestBus::Handler::DestroyShaderManagementConsoleWindow);

        ShaderManagementConsoleWindowNotificationBus::Handler::BusDisconnect();

@@ -116,9 +114,7 @@ namespace ShaderManagementConsole
            const AZStd::string runPythonScriptPath = m_commandLine.GetSwitchValue(runPythonScriptSwitchName, runPythonScriptIndex);
            AZStd::vector<AZStd::string_view> runPythonArgs;
            AzToolsFramework::EditorPythonRunnerRequestBus::Broadcast(
-                &AzToolsFramework::EditorPythonRunnerRequestBus::Events::ExecuteByFilenameWithArgs,
-                runPythonScriptPath,
-                runPythonArgs);
+                &AzToolsFramework::EditorPythonRunnerRequestBus::Events::ExecuteByFilenameWithArgs, runPythonScriptPath, runPythonArgs);
        }

        // Process command line options for opening one or more documents on startup
@@ -126,7 +122,8 @@ namespace ShaderManagementConsole
        for (size_t openDocumentIndex = 0; openDocumentIndex < openDocumentCount; ++openDocumentIndex)
        {
            const AZStd::string openDocumentPath = m_commandLine.GetMiscValue(openDocumentIndex);
-            ShaderManagementConsoleDocumentSystemRequestBus::Broadcast(&ShaderManagementConsoleDocumentSystemRequestBus::Events::OpenDocument, openDocumentPath);
+            ShaderManagementConsoleDocumentSystemRequestBus::Broadcast(
+                &ShaderManagementConsoleDocumentSystemRequestBus::Events::OpenDocument, openDocumentPath);
        }
    }

@@ -136,6 +133,7 @@ namespace ShaderManagementConsole

        ShaderManagementConsoleWindowNotificationBus::Handler::BusConnect();

-        ShaderManagementConsole::ShaderManagementConsoleWindowRequestBus::Broadcast(&ShaderManagementConsole::ShaderManagementConsoleWindowRequestBus::Handler::CreateShaderManagementConsoleWindow);
+        ShaderManagementConsole::ShaderManagementConsoleWindowRequestBus::Broadcast(
+            &ShaderManagementConsole::ShaderManagementConsoleWindowRequestBus::Handler::CreateShaderManagementConsoleWindow);
    }
 } // namespace ShaderManagementConsole