Atom Tools: Saving tool settings, made inspector configurable, moved to ATF

Changed material editor inspector into generic, configurable, document inspector and moved to atom tools framework Renamed atom tools framework settings registry utility functions Added more settings registry utility functions to get, set, and save values and objects Added saving tool settings to atom tools application Signed-off-by: Guthrie Adams <guthadam@amazon.com>
2022-02-17 23:09:06 -06:00
parent c0299f0ad7
commit 01786b2966
33 changed files with 538 additions and 447 deletions
@@ -18,6 +18,7 @@
 #include <AtomCore/Instance/Instance.h>
 #include <AtomToolsFramework/Document/AtomToolsDocumentNotificationBus.h>
 #include <AtomToolsFramework/Util/MaterialPropertyUtil.h>
+#include <AtomToolsFramework/Util/Util.h>
 #include <AzCore/RTTI/BehaviorContext.h>
 #include <AzCore/Serialization/EditContext.h>
 #include <AzCore/Serialization/SerializeContext.h>
@@ -64,7 +64,7 @@ namespace MaterialEditor

        m_ui->m_materialTypeComboBox->model()->sort(0, Qt::AscendingOrder); 

-        const AZStd::string defaultMaterialType = AtomToolsFramework::GetSettingOrDefault<AZStd::string>(
+        const AZStd::string defaultMaterialType = AtomToolsFramework::GetSettingsValue<AZStd::string>(
            "/O3DE/Atom/MaterialEditor/CreateMaterialDialog/DefaultMaterialType", "StandardPBR");

        const int index = m_ui->m_materialTypeComboBox->findText(defaultMaterialType.c_str());
@@ -9,6 +9,7 @@
 #include <Atom/RPI.Edit/Material/MaterialSourceData.h>
 #include <Atom/RPI.Edit/Material/MaterialTypeSourceData.h>
 #include <AtomToolsFramework/Document/AtomToolsDocumentSystemRequestBus.h>
+#include <AtomToolsFramework/DynamicProperty/DynamicProperty.h>
 #include <AtomToolsFramework/Util/Util.h>
 #include <AzQtComponents/Components/StyleManager.h>
 #include <AzQtComponents/Components/WindowDecorationWrapper.h>
@@ -17,7 +18,6 @@
 #include <Window/CreateMaterialDialog/CreateMaterialDialog.h>
 #include <Window/MaterialEditorWindow.h>
 #include <Window/MaterialEditorWindowSettings.h>
-#include <Window/MaterialInspector/MaterialInspector.h>
 #include <Window/SettingsDialog/SettingsDialog.h>
 #include <Window/ViewportSettingsInspector/ViewportSettingsInspector.h>

@@ -78,7 +78,20 @@ namespace MaterialEditor
            QDesktopServices::openUrl(QUrl::fromLocalFile(absolutePath.c_str()));
        });

-        AddDockWidget("Inspector", new MaterialInspector(m_toolId), Qt::RightDockWidgetArea, Qt::Vertical);
+        m_materialInspector = new AtomToolsFramework::AtomToolsDocumentInspector(m_toolId, this);
+        m_materialInspector->SetDocumentSettingsPrefix("/O3DE/Atom/MaterialEditor/MaterialInspector");
+        m_materialInspector->SetIndicatorFunction(
+            [](const AzToolsFramework::InstanceDataNode* node)
+            {
+                const auto property = AtomToolsFramework::FindAncestorInstanceDataNodeByType<AtomToolsFramework::DynamicProperty>(node);
+                if (property && !AtomToolsFramework::ArePropertyValuesEqual(property->GetValue(), property->GetConfig().m_parentValue))
+                {
+                    return ":/Icons/changed_property.svg";
+                }
+                return ":/Icons/blank.png";
+            });
+
+        AddDockWidget("Inspector", m_materialInspector, Qt::RightDockWidgetArea, Qt::Vertical);
        AddDockWidget("Viewport Settings", new ViewportSettingsInspector, Qt::LeftDockWidgetArea, Qt::Vertical);
        SetDockWidgetVisible("Viewport Settings", false);

@@ -98,6 +111,12 @@ namespace MaterialEditor
        OnDocumentOpened(AZ::Uuid::CreateNull());
    }

+    void MaterialEditorWindow::OnDocumentOpened(const AZ::Uuid& documentId)
+    {
+        Base::OnDocumentOpened(documentId);
+        m_materialInspector->SetDocumentId(documentId);
+    }
+
    void MaterialEditorWindow::ResizeViewportRenderTarget(uint32_t width, uint32_t height)
    {
        QSize requestedViewportSize = QSize(width, height) / devicePixelRatioF();
@@ -9,6 +9,7 @@
 #pragma once

 #if !defined(Q_MOC_RUN)
+#include <AtomToolsFramework/Document/AtomToolsDocumentInspector.h>
 #include <AtomToolsFramework/Document/AtomToolsDocumentMainWindow.h>

 AZ_PUSH_DISABLE_WARNING(4251 4800, "-Wunknown-warning-option") // disable warnings spawned by QT
@@ -35,10 +36,15 @@ namespace MaterialEditor
        MaterialEditorWindow(const AZ::Crc32& toolId, QWidget* parent = 0);

    protected:
+        // AtomToolsFramework::AtomToolsMainWindowRequestBus::Handler overrides...
        void ResizeViewportRenderTarget(uint32_t width, uint32_t height) override;
        void LockViewportRenderTargetSize(uint32_t width, uint32_t height) override;
        void UnlockViewportRenderTargetSize() override;

+        // AtomToolsFramework::AtomToolsDocumentNotificationBus::Handler overrides...
+        void OnDocumentOpened(const AZ::Uuid& documentId) override;
+
+        // AtomToolsFramework::AtomToolsDocumentMainWindow overrides...
        bool GetCreateDocumentParams(AZStd::string& openPath, AZStd::string& savePath) override;
        bool GetOpenDocumentParams(AZStd::string& openPath) override;
        void OpenSettings() override;
@@ -47,6 +53,7 @@ namespace MaterialEditor

        void closeEvent(QCloseEvent* closeEvent) override;

+        AtomToolsFramework::AtomToolsDocumentInspector* m_materialInspector = {};
        MaterialViewportWidget* m_materialViewport = {};
        MaterialEditorToolBar* m_toolBar = {};
    };
@@ -19,7 +19,6 @@ namespace MaterialEditor
            serializeContext->Class<MaterialEditorWindowSettings, AZ::UserSettings>()
                ->Version(1)
                ->Field("mainWindowState", &MaterialEditorWindowSettings::m_mainWindowState)
-                ->Field("inspectorCollapsedGroups", &MaterialEditorWindowSettings::m_inspectorCollapsedGroups)
                ;

            if (auto editContext = serializeContext->GetEditContext())
@@ -27,6 +27,5 @@ namespace MaterialEditor
        static void Reflect(AZ::ReflectContext* context);

        AZStd::vector<char> m_mainWindowState;
-        AZStd::unordered_set<AZ::u32> m_inspectorCollapsedGroups;
    };
 } // namespace MaterialEditor
@@ -1,159 +0,0 @@
-/*
- * Copyright (c) Contributors to the Open 3D Engine Project.
- * For complete copyright and license terms please see the LICENSE at the root of this distribution.
- *
- * SPDX-License-Identifier: Apache-2.0 OR MIT
- *
- */
-
-#include <Atom/RPI.Edit/Common/AssetUtils.h>
-#include <AtomToolsFramework/Document/AtomToolsDocumentRequestBus.h>
-#include <AtomToolsFramework/DynamicProperty/DynamicPropertyGroup.h>
-#include <AtomToolsFramework/Inspector/InspectorPropertyGroupWidget.h>
-#include <AtomToolsFramework/Util/MaterialPropertyUtil.h>
-#include <Window/MaterialInspector/MaterialInspector.h>
-
-namespace MaterialEditor
-{
-    MaterialInspector::MaterialInspector(const AZ::Crc32& toolId, QWidget* parent)
-        : AtomToolsFramework::InspectorWidget(parent)
-        , m_toolId(toolId)
-    {
-        m_windowSettings = AZ::UserSettings::CreateFind<MaterialEditorWindowSettings>(
-            AZ::Crc32("MaterialEditorWindowSettings"), AZ::UserSettings::CT_GLOBAL);
-
-        AtomToolsFramework::AtomToolsDocumentNotificationBus::Handler::BusConnect(m_toolId);
-    }
-
-    MaterialInspector::~MaterialInspector()
-    {
-        AtomToolsFramework::AtomToolsDocumentNotificationBus::Handler::BusDisconnect();
-        AtomToolsFramework::InspectorRequestBus::Handler::BusDisconnect();
-    }
-
-    void MaterialInspector::Reset()
-    {
-        m_documentPath.clear();
-        m_documentId = AZ::Uuid::CreateNull();
-        m_activeProperty = {};
-
-        AtomToolsFramework::InspectorRequestBus::Handler::BusDisconnect();
-        AtomToolsFramework::InspectorWidget::Reset();
-    }
-
-    bool MaterialInspector::ShouldGroupAutoExpanded(const AZStd::string& groupName) const
-    {
-        auto stateItr = m_windowSettings->m_inspectorCollapsedGroups.find(GetGroupSaveStateKey(groupName));
-        return stateItr == m_windowSettings->m_inspectorCollapsedGroups.end();
-    }
-
-    void MaterialInspector::OnGroupExpanded(const AZStd::string& groupName)
-    {
-        m_windowSettings->m_inspectorCollapsedGroups.erase(GetGroupSaveStateKey(groupName));
-    }
-
-    void MaterialInspector::OnGroupCollapsed(const AZStd::string& groupName)
-    {
-        m_windowSettings->m_inspectorCollapsedGroups.insert(GetGroupSaveStateKey(groupName));
-    }
-
-    void MaterialInspector::OnDocumentOpened(const AZ::Uuid& documentId)
-    {
-        AddGroupsBegin();
-
-        m_documentId = documentId;
-
-        bool isOpen = false;
-        AtomToolsFramework::AtomToolsDocumentRequestBus::EventResult(
-            isOpen, m_documentId, &AtomToolsFramework::AtomToolsDocumentRequestBus::Events::IsOpen);
-
-        AtomToolsFramework::AtomToolsDocumentRequestBus::EventResult(
-            m_documentPath, m_documentId, &AtomToolsFramework::AtomToolsDocumentRequestBus::Events::GetAbsolutePath);
-
-        if (!m_documentId.IsNull() && isOpen)
-        {
-            // This will automatically expose all document contents to an inspector with a collapsible group per object. In the case of the
-            // material editor, this will be one inspector group per property group.
-            AZStd::vector<AtomToolsFramework::DocumentObjectInfo> objects;
-            AtomToolsFramework::AtomToolsDocumentRequestBus::EventResult(
-                objects, m_documentId, &AtomToolsFramework::AtomToolsDocumentRequestBus::Events::GetObjectInfo);
-
-            for (auto& objectInfo : objects)
-            {
-                // Passing in same main and comparison instance to enable custom value comparison for highlighting modified properties
-                auto propertyGroupWidget = new AtomToolsFramework::InspectorPropertyGroupWidget(
-                    objectInfo.m_objectPtr, objectInfo.m_objectPtr, objectInfo.m_objectType, this, this,
-                    GetGroupSaveStateKey(objectInfo.m_name), {},
-                    [this](const auto node) { return GetInstanceNodePropertyIndicator(node); }, 0);
-
-                AddGroup(objectInfo.m_name, objectInfo.m_displayName, objectInfo.m_description, propertyGroupWidget);
-                SetGroupVisible(objectInfo.m_name, objectInfo.m_visible);
-            }
-
-            AtomToolsFramework::InspectorRequestBus::Handler::BusConnect(m_documentId);
-        }
-
-        AddGroupsEnd();
-    }
-
-    AZ::Crc32 MaterialInspector::GetGroupSaveStateKey(const AZStd::string& groupName) const
-    {
-        return AZ::Crc32(AZStd::string::format("MaterialInspector::PropertyGroup::%s::%s", m_documentPath.c_str(), groupName.c_str()));
-    }
-
-    bool MaterialInspector::IsInstanceNodePropertyModifed(const AzToolsFramework::InstanceDataNode* node) const
-    {
-        const AtomToolsFramework::DynamicProperty* property = AtomToolsFramework::FindDynamicPropertyForInstanceDataNode(node);
-        return property && !AtomToolsFramework::ArePropertyValuesEqual(property->GetValue(), property->GetConfig().m_parentValue);
-    }
-
-    const char* MaterialInspector::GetInstanceNodePropertyIndicator(const AzToolsFramework::InstanceDataNode* node) const
-    {
-        if (IsInstanceNodePropertyModifed(node))
-        {
-            return ":/Icons/changed_property.svg";
-        }
-        return ":/Icons/blank.png";
-    }
-
-    void MaterialInspector::OnDocumentObjectInfoChanged(
-        [[maybe_unused]] const AZ::Uuid& documentId, const AtomToolsFramework::DocumentObjectInfo& objectInfo, bool rebuilt)
-    {
-        SetGroupVisible(objectInfo.m_name, objectInfo.m_visible);
-        if (rebuilt)
-        {
-            RebuildGroup(objectInfo.m_name);
-        }
-        else
-        {
-            RefreshGroup(objectInfo.m_name);
-        }
-    }
-
-    void MaterialInspector::BeforePropertyModified(AzToolsFramework::InstanceDataNode* pNode)
-    {
-        // This function is called before every single property change whether it's a button click or dragging a slider. We only want to
-        // begin tracking undo state for the first change in the sequence, when the user begins to drag the slider.
-        const AtomToolsFramework::DynamicProperty* property = AtomToolsFramework::FindDynamicPropertyForInstanceDataNode(pNode);
-        if (!m_activeProperty && property)
-        {
-            m_activeProperty = property;
-            AtomToolsFramework::AtomToolsDocumentRequestBus::Event(
-                m_documentId, &AtomToolsFramework::AtomToolsDocumentRequestBus::Events::BeginEdit);
-        }
-    }
-
-    void MaterialInspector::SetPropertyEditingComplete(AzToolsFramework::InstanceDataNode* pNode)
-    {
-        // If tracking has started and editing has completed then we can stop tracking undue state for this sequence of changes.
-        const AtomToolsFramework::DynamicProperty* property = AtomToolsFramework::FindDynamicPropertyForInstanceDataNode(pNode);
-        if (m_activeProperty && m_activeProperty == property)
-        {
-            AtomToolsFramework::AtomToolsDocumentRequestBus::Event(
-                m_documentId, &AtomToolsFramework::AtomToolsDocumentRequestBus::Events::EndEdit);
-            m_activeProperty = {};
-        }
-    }
-} // namespace MaterialEditor
-
-#include <Window/MaterialInspector/moc_MaterialInspector.cpp>
@@ -1,71 +0,0 @@
-/*
- * Copyright (c) Contributors to the Open 3D Engine Project.
- * For complete copyright and license terms please see the LICENSE at the root of this distribution.
- *
- * SPDX-License-Identifier: Apache-2.0 OR MIT
- *
- */
-
-#pragma once
-
-#if !defined(Q_MOC_RUN)
-#include <AtomToolsFramework/Document/AtomToolsDocumentNotificationBus.h>
-#include <AtomToolsFramework/DynamicProperty/DynamicPropertyGroup.h>
-#include <AtomToolsFramework/Inspector/InspectorWidget.h>
-#include <AzCore/std/containers/unordered_map.h>
-#include <AzToolsFramework/UI/PropertyEditor/PropertyEditorAPI_Internals.h>
-#include <Window/MaterialEditorWindowSettings.h>
-#endif
-
-namespace MaterialEditor
-{
-    //! Provides controls for viewing and editing document settings.
-    class MaterialInspector
-        : public AtomToolsFramework::InspectorWidget
-        , public AtomToolsFramework::AtomToolsDocumentNotificationBus::Handler
-        , public AzToolsFramework::IPropertyEditorNotify
-    {
-        Q_OBJECT
-    public:
-        AZ_CLASS_ALLOCATOR(MaterialInspector, AZ::SystemAllocator, 0);
-
-        MaterialInspector(const AZ::Crc32& toolId, QWidget* parent = nullptr);
-        ~MaterialInspector() override;
-
-        // AtomToolsFramework::InspectorRequestBus::Handler overrides...
-        void Reset() override;
-
-    protected:
-        bool ShouldGroupAutoExpanded(const AZStd::string& groupName) const override;
-        void OnGroupExpanded(const AZStd::string& groupName) override;
-        void OnGroupCollapsed(const AZStd::string& groupName) override;
-
-    private:
-        AZ::Crc32 GetGroupSaveStateKey(const AZStd::string& groupName) const;
-        bool IsInstanceNodePropertyModifed(const AzToolsFramework::InstanceDataNode* node) const;
-        const char* GetInstanceNodePropertyIndicator(const AzToolsFramework::InstanceDataNode* node) const;
-
-        // AtomToolsDocumentNotificationBus::Handler implementation
-        void OnDocumentOpened(const AZ::Uuid& documentId) override;
-        void OnDocumentObjectInfoChanged(
-            const AZ::Uuid& documentId, const AtomToolsFramework::DocumentObjectInfo& objectInfo, bool rebuilt) override;
-
-        // AzToolsFramework::IPropertyEditorNotify overrides...
-        void BeforePropertyModified(AzToolsFramework::InstanceDataNode* pNode) override;
-        void AfterPropertyModified([[maybe_unused]] AzToolsFramework::InstanceDataNode* pNode) override {}
-        void SetPropertyEditingActive([[maybe_unused]] AzToolsFramework::InstanceDataNode* pNode) override {}
-        void SetPropertyEditingComplete(AzToolsFramework::InstanceDataNode* pNode) override;
-        void SealUndoStack() override {}
-        void RequestPropertyContextMenu([[maybe_unused]] AzToolsFramework::InstanceDataNode* pNode, const QPoint&) override {}
-        void PropertySelectionChanged([[maybe_unused]] AzToolsFramework::InstanceDataNode* pNode, bool) override {}
-
-        const AZ::Crc32 m_toolId = {};
-
-        // Tracking the property that is activiley being edited in the inspector
-        const AtomToolsFramework::DynamicProperty* m_activeProperty = {};
-
-        AZ::Uuid m_documentId = AZ::Uuid::CreateNull();
-        AZStd::string m_documentPath;
-        AZStd::intrusive_ptr<MaterialEditorWindowSettings> m_windowSettings;
-    };
-} // namespace MaterialEditor
@@ -6,19 +6,19 @@
 *
 */

-#include <Window/SettingsDialog/SettingsWidget.h>
 #include <AtomToolsFramework/Inspector/InspectorPropertyGroupWidget.h>
+#include <Window/SettingsDialog/SettingsWidget.h>

 namespace MaterialEditor
 {
    SettingsWidget::SettingsWidget(QWidget* parent)
        : AtomToolsFramework::InspectorWidget(parent)
    {
+        SetGroupSettingsPrefix("/O3DE/Atom/MaterialEditor/SettingsWidget");
    }

    SettingsWidget::~SettingsWidget()
    {
-        AtomToolsFramework::InspectorRequestBus::Handler::BusDisconnect();
    }

    void SettingsWidget::Populate()
@@ -29,7 +29,6 @@ namespace MaterialEditor

    void SettingsWidget::Reset()
    {
-        AtomToolsFramework::InspectorRequestBus::Handler::BusDisconnect();
        AtomToolsFramework::InspectorWidget::Reset();
    }
 } // namespace MaterialEditor
@@ -32,9 +32,7 @@ namespace MaterialEditor
        m_viewportSettings =
            AZ::UserSettings::CreateFind<MaterialViewportSettings>(AZ::Crc32("MaterialViewportSettings"), AZ::UserSettings::CT_GLOBAL);

-        m_windowSettings = AZ::UserSettings::CreateFind<MaterialEditorWindowSettings>(
-            AZ::Crc32("MaterialEditorWindowSettings"), AZ::UserSettings::CT_GLOBAL);
-
+        SetGroupSettingsPrefix("/O3DE/Atom/MaterialEditor/ViewportSettingsInspector");
        MaterialViewportNotificationBus::Handler::BusConnect();
    }

@@ -43,7 +41,6 @@ namespace MaterialEditor
        m_lightingPreset.reset();
        m_modelPreset.reset();
        MaterialViewportNotificationBus::Handler::BusDisconnect();
-        AtomToolsFramework::InspectorRequestBus::Handler::BusDisconnect();
    }

    void ViewportSettingsInspector::Populate()
@@ -144,7 +141,7 @@ namespace MaterialEditor
            });

        const int itemSize = aznumeric_cast<int>(
-            AtomToolsFramework::GetSettingOrDefault<AZ::u64>("/O3DE/Atom/MaterialEditor/AssetGridDialog/ModelItemSize", 180));
+            AtomToolsFramework::GetSettingsValue<AZ::u64>("/O3DE/Atom/MaterialEditor/AssetGridDialog/ModelItemSize", 180));

        AtomToolsFramework::AssetGridDialog dialog(
            "Model Preset Browser", selectableAssets, selectedAsset, QSize(itemSize, itemSize), QApplication::activeWindow());
@@ -270,7 +267,7 @@ namespace MaterialEditor
            });

        const int itemSize = aznumeric_cast<int>(
-            AtomToolsFramework::GetSettingOrDefault<AZ::u64>("/O3DE/Atom/MaterialEditor/AssetGridDialog/LightingItemSize", 180));
+            AtomToolsFramework::GetSettingsValue<AZ::u64>("/O3DE/Atom/MaterialEditor/AssetGridDialog/LightingItemSize", 180));

        AtomToolsFramework::AssetGridDialog dialog(
            "Lighting Preset Browser", selectableAssets, selectedAsset, QSize(itemSize, itemSize), QApplication::activeWindow());
@@ -338,7 +335,6 @@ namespace MaterialEditor
                m_viewportSettings->m_displayMapperOperationType = viewportRequests->GetDisplayMapperOperationType();
            });

-        AtomToolsFramework::InspectorRequestBus::Handler::BusDisconnect();
        AtomToolsFramework::InspectorWidget::Reset();
    }

@@ -433,23 +429,6 @@ namespace MaterialEditor
    {
        return AZ::Crc32(AZStd::string::format("ViewportSettingsInspector::PropertyGroup::%s", groupName.c_str()));
    }
-
-    bool ViewportSettingsInspector::ShouldGroupAutoExpanded(const AZStd::string& groupName) const
-    {
-        auto stateItr = m_windowSettings->m_inspectorCollapsedGroups.find(GetGroupSaveStateKey(groupName));
-        return stateItr == m_windowSettings->m_inspectorCollapsedGroups.end();
-    }
-
-    void ViewportSettingsInspector::OnGroupExpanded(const AZStd::string& groupName)
-    {
-        m_windowSettings->m_inspectorCollapsedGroups.erase(GetGroupSaveStateKey(groupName));
-    }
-
-    void ViewportSettingsInspector::OnGroupCollapsed(const AZStd::string& groupName)
-    {
-        m_windowSettings->m_inspectorCollapsedGroups.insert(GetGroupSaveStateKey(groupName));
-    }
-
 } // namespace MaterialEditor

 #include <Window/ViewportSettingsInspector/moc_ViewportSettingsInspector.cpp>
@@ -16,7 +16,6 @@
 #include <AzToolsFramework/UI/PropertyEditor/PropertyEditorAPI_Internals.h>
 #include <Viewport/MaterialViewportNotificationBus.h>
 #include <Viewport/MaterialViewportSettings.h>
-#include <Window/MaterialEditorWindowSettings.h>
 #endif

 namespace MaterialEditor
@@ -75,13 +74,9 @@ namespace MaterialEditor
        AZStd::string GetDefaultUniqueSaveFilePath(const AZStd::string& baseName) const;

        AZ::Crc32 GetGroupSaveStateKey(const AZStd::string& groupName) const;
-        bool ShouldGroupAutoExpanded(const AZStd::string& groupName) const override;
-        void OnGroupExpanded(const AZStd::string& groupName) override;
-        void OnGroupCollapsed(const AZStd::string& groupName) override;

        AZ::Render::ModelPresetPtr m_modelPreset;
        AZ::Render::LightingPresetPtr m_lightingPreset;
        AZStd::intrusive_ptr<MaterialViewportSettings> m_viewportSettings;
-        AZStd::intrusive_ptr<MaterialEditorWindowSettings> m_windowSettings;
    };
 } // namespace MaterialEditor