From 0952b7bd87a5fe7aa73cd6c5201b05dde7d95961 Mon Sep 17 00:00:00 2001 From: hultonha Date: Tue, 27 Apr 2021 11:24:58 +0100 Subject: [PATCH] update Cluster file name to ButtonGroup --- .../AzToolsFramework/ViewportUi/Button.cpp | 1 - .../AzToolsFramework/ViewportUi/Button.h | 1 - .../{Cluster.cpp => ButtonGroup.cpp} | 2 +- .../ViewportUi/{Cluster.h => ButtonGroup.h} | 0 .../ViewportUi/ViewportUiCluster.cpp | 3 +- .../ViewportUi/ViewportUiDisplay.h | 2 +- .../ViewportUi/ViewportUiManager.cpp | 2 +- .../ViewportUi/ViewportUiManager.h | 2 +- .../ViewportUi/ViewportUiSwitcher.cpp | 33 +++++++++----- .../ViewportUi/ViewportUiSwitcher.h | 12 +++++ .../aztoolsframework_files.cmake | 6 +-- .../Tests/Viewport/ClusterTests.cpp | 24 +++++----- .../Tests/Viewport/ViewportUiClusterTests.cpp | 22 +++++----- .../Tests/Viewport/ViewportUiDisplayTests.cpp | 44 +++++++++---------- .../Tests/Viewport/ViewportUiManagerTests.cpp | 8 ++-- 15 files changed, 92 insertions(+), 70 deletions(-) rename Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/{Cluster.cpp => ButtonGroup.cpp} (98%) rename Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/{Cluster.h => ButtonGroup.h} (100%) diff --git a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/Button.cpp b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/Button.cpp index 6218826f35..7ef6d96223 100644 --- a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/Button.cpp +++ b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/Button.cpp @@ -13,7 +13,6 @@ #include "AzToolsFramework_precompiled.h" #include -#include namespace AzToolsFramework::ViewportUi::Internal { diff --git a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/Button.h b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/Button.h index 930885d2b5..cd4d548510 100644 --- a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/Button.h +++ b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/Button.h @@ -12,7 +12,6 @@ #pragma once -#include #include namespace AzToolsFramework::ViewportUi::Internal diff --git a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/Cluster.cpp b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ButtonGroup.cpp similarity index 98% rename from Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/Cluster.cpp rename to Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ButtonGroup.cpp index 5b24d8e75d..6e05ef84b1 100644 --- a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/Cluster.cpp +++ b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ButtonGroup.cpp @@ -11,7 +11,7 @@ */ #include -#include +#include #pragma optimize("", off) #pragma inline_depth(0) diff --git a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/Cluster.h b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ButtonGroup.h similarity index 100% rename from Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/Cluster.h rename to Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ButtonGroup.h diff --git a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiCluster.cpp b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiCluster.cpp index 2fcf316ca1..79744f1dbf 100644 --- a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiCluster.cpp +++ b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiCluster.cpp @@ -9,9 +9,10 @@ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * */ + #include "AzToolsFramework_precompiled.h" -#include +#include #include namespace AzToolsFramework::ViewportUi::Internal diff --git a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiDisplay.h b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiDisplay.h index 9ecde4ffd9..7ef81986c0 100644 --- a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiDisplay.h +++ b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiDisplay.h @@ -13,7 +13,7 @@ #pragma once #include -#include +#include #include #include #include diff --git a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiManager.cpp b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiManager.cpp index c6f3a2b81b..6eb97adb93 100644 --- a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiManager.cpp +++ b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiManager.cpp @@ -14,7 +14,7 @@ #include #include -#include +#include #include #include diff --git a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiManager.h b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiManager.h index 47d36a9d47..1b350bbd64 100644 --- a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiManager.h +++ b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiManager.h @@ -13,7 +13,6 @@ #pragma once #include -#include #include #include @@ -21,6 +20,7 @@ namespace AzToolsFramework::ViewportUi { namespace Internal { + class ButtonGroup; class ViewportUiDisplay; } diff --git a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiSwitcher.cpp b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiSwitcher.cpp index 7b3baf4d37..d39171e0ba 100644 --- a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiSwitcher.cpp +++ b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiSwitcher.cpp @@ -1,4 +1,16 @@ -#include +/* + * All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or + * its licensors. + * + * For complete copyright and license terms please see the LICENSE at the root of this + * distribution (the "License"). All use of this software is governed by the License, + * or, if provided, by the license below or the license accompanying this file. Do not + * remove or modify any license notices. This file is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * + */ + +#include #include namespace AzToolsFramework::ViewportUi::Internal @@ -9,7 +21,8 @@ namespace AzToolsFramework::ViewportUi::Internal setOrientation(Qt::Orientation::Horizontal); setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Preferred); setStyleSheet(QString("QToolBar {background-color: none; border: none; spacing: 3px;}" - "QToolButton {background-color: black; border: outset; border-color: white; border-radius: 7px; border-width: 2px; padding: 7px; color: white;}")); + "QToolButton {background-color: black; border: outset; border-color: white; border-radius: 7px; " + "border-width: 2px; padding: 7px; color: white;}")); // Add am empty active button (is set in the call to SetActiveMode) m_activeButton = new QToolButton(); @@ -51,7 +64,7 @@ namespace AzToolsFramework::ViewportUi::Internal action->setProperty("IconHasHoverEffect", true); // add the action - addAction(action); + addAction(action); // resize to fit new action with minimum extra space resize(minimumSizeHint()); @@ -68,14 +81,12 @@ namespace AzToolsFramework::ViewportUi::Internal } // register the action - m_widgetCallbacks.AddWidget(action, [updateCallback](QPointer object) - { - updateCallback(static_cast(object.data())); - }); + m_widgetCallbacks.AddWidget( + action, [updateCallback](QPointer object) { updateCallback(static_cast(object.data())); }); m_buttonActionMap.insert({button->m_buttonId, action}); } - + void ViewportUiSwitcher::RemoveButton(ButtonId buttonId) { if (auto actionEntry = m_buttonActionMap.find(buttonId); actionEntry != m_buttonActionMap.end()) @@ -124,12 +135,12 @@ namespace AzToolsFramework::ViewportUi::Internal QIcon buttonIcon = QString(((*buttonIt)->m_icon).c_str()); m_activeButton->setIcon(buttonIcon); m_activeButton->setText(buttonName); - } + } // Look up button ID in map then remove it from its current position auto itr = m_buttonActionMap.find(buttonId); QAction* action = itr->second; - removeAction(action); + removeAction(action); if (!initialActiveMode) { @@ -139,7 +150,7 @@ namespace AzToolsFramework::ViewportUi::Internal itr = m_buttonActionMap.find(m_activeButtonId); action = itr->second; addAction(action); - } + } } m_activeButtonId = buttonId; diff --git a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiSwitcher.h b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiSwitcher.h index 9cdbf4b754..92c5408f33 100644 --- a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiSwitcher.h +++ b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportUi/ViewportUiSwitcher.h @@ -1,3 +1,15 @@ +/* + * All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or + * its licensors. + * + * For complete copyright and license terms please see the LICENSE at the root of this + * distribution (the "License"). All use of this software is governed by the License, + * or, if provided, by the license below or the license accompanying this file. Do not + * remove or modify any license notices. This file is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * + */ + #pragma once #include diff --git a/Code/Framework/AzToolsFramework/AzToolsFramework/aztoolsframework_files.cmake b/Code/Framework/AzToolsFramework/AzToolsFramework/aztoolsframework_files.cmake index 86de81d6da..c2a4e54e42 100644 --- a/Code/Framework/AzToolsFramework/AzToolsFramework/aztoolsframework_files.cmake +++ b/Code/Framework/AzToolsFramework/AzToolsFramework/aztoolsframework_files.cmake @@ -487,8 +487,8 @@ set(FILES Viewport/ViewportTypes.cpp ViewportUi/Button.h ViewportUi/Button.cpp - ViewportUi/Cluster.h - ViewportUi/Cluster.cpp + ViewportUi/ButtonGroup.h + ViewportUi/ButtonGroup.cpp ViewportUi/TextField.h ViewportUi/TextField.cpp ViewportUi/ViewportUiDisplay.h @@ -731,7 +731,7 @@ set(FILES # Prevent the following files from being grouped in UNITY builds set(SKIP_UNITY_BUILD_INCLUSION_FILES # The following files are skipped from unity to avoid duplicated symbols related to an ebus - AzToolsFrameworkModule.cpp + AzToolsFrameworkModule.cpp Application/ToolsApplication.cpp UI/PropertyEditor/PropertyEntityIdCtrl.cpp UI/PropertyEditor/PropertyManagerComponent.cpp diff --git a/Code/Framework/AzToolsFramework/Tests/Viewport/ClusterTests.cpp b/Code/Framework/AzToolsFramework/Tests/Viewport/ClusterTests.cpp index e4f1573939..6b9a3b33f2 100644 --- a/Code/Framework/AzToolsFramework/Tests/Viewport/ClusterTests.cpp +++ b/Code/Framework/AzToolsFramework/Tests/Viewport/ClusterTests.cpp @@ -20,35 +20,35 @@ namespace UnitTest { - using Cluster = AzToolsFramework::ViewportUi::Internal::Cluster; + using ButtonGroup = AzToolsFramework::ViewportUi::Internal::ButtonGroup; using ButtonId = AzToolsFramework::ViewportUi::ButtonId; TEST(ClusterTest, AddButtonAddsButtonToClusterAndReturnsId) { - auto cluster = AZStd::make_unique(); - auto buttonId = cluster->AddButton(""); + auto buttonGroup = AZStd::make_unique(); + auto buttonId = buttonGroup->AddButton(""); - auto button = cluster->GetButton(buttonId); + auto button = buttonGroup->GetButton(buttonId); EXPECT_TRUE(button != nullptr); } TEST(ClusterTest, SetHighlightedButtonChangesButtonStateToSelected) { - auto cluster = AZStd::make_unique(); - auto buttonId = cluster->AddButton(""); + auto buttonGroup = AZStd::make_unique(); + auto buttonId = buttonGroup->AddButton(""); // check button is not highlighted by default - auto button = cluster->GetButton(buttonId); + auto button = buttonGroup->GetButton(buttonId); EXPECT_FALSE(button->m_state == AzToolsFramework::ViewportUi::Internal::Button::State::Selected); - cluster->SetHighlightedButton(buttonId); + buttonGroup->SetHighlightedButton(buttonId); EXPECT_TRUE(button->m_state == AzToolsFramework::ViewportUi::Internal::Button::State::Selected); } TEST(ClusterTest, ConnectEventHandlerConnectsHandlerToButtonTriggeredEvent) { - auto cluster = AZStd::make_unique(); - auto buttonId = cluster->AddButton(""); + auto buttonGroup = AZStd::make_unique(); + auto buttonId = buttonGroup->AddButton(""); // create a handler which will be triggered by the cluster bool handlerTriggered = false; @@ -62,8 +62,8 @@ namespace UnitTest } }); - cluster->ConnectEventHandler(handler); - cluster->PressButton(buttonId); + buttonGroup->ConnectEventHandler(handler); + buttonGroup->PressButton(buttonId); EXPECT_TRUE(handlerTriggered); } diff --git a/Code/Framework/AzToolsFramework/Tests/Viewport/ViewportUiClusterTests.cpp b/Code/Framework/AzToolsFramework/Tests/Viewport/ViewportUiClusterTests.cpp index c91909e765..e2b1ac8c41 100644 --- a/Code/Framework/AzToolsFramework/Tests/Viewport/ViewportUiClusterTests.cpp +++ b/Code/Framework/AzToolsFramework/Tests/Viewport/ViewportUiClusterTests.cpp @@ -13,7 +13,7 @@ #include #include #include -#include +#include #include #include #include @@ -23,14 +23,14 @@ namespace UnitTest { using ViewportUiCluster = AzToolsFramework::ViewportUi::Internal::ViewportUiCluster; - using Cluster = AzToolsFramework::ViewportUi::Internal::Cluster; + using ButtonGroup = AzToolsFramework::ViewportUi::Internal::ButtonGroup; using Button = AzToolsFramework::ViewportUi::Internal::Button; using ButtonId = AzToolsFramework::ViewportUi::ButtonId; TEST(ViewportUiCluster, RegisterButtonIncreasesClusterHeight) { - auto clusterInfo = AZStd::make_shared(); - ViewportUiCluster viewportUiCluster(clusterInfo); + auto buttonGroup = AZStd::make_shared(); + ViewportUiCluster viewportUiCluster(buttonGroup); viewportUiCluster.resize(viewportUiCluster.minimumSizeHint()); // need to initialize cluster with a single button or size will be invalid @@ -48,8 +48,8 @@ namespace UnitTest TEST(ViewportUiCluster, RemoveClusterButtonDecreasesClusterHeight) { - auto clusterInfo = AZStd::make_shared(); - ViewportUiCluster viewportUiCluster(clusterInfo); + auto buttonGroup = AZStd::make_shared(); + ViewportUiCluster viewportUiCluster(buttonGroup); viewportUiCluster.resize(viewportUiCluster.minimumSizeHint()); // need to initialize cluster with a single button or size will be invalid @@ -70,8 +70,8 @@ namespace UnitTest TEST(ViewportUiCluster, UpdateChangesActiveButton) { - auto clusterInfo = AZStd::make_shared(); - ViewportUiCluster viewportUiCluster(clusterInfo); + auto buttonGroup = AZStd::make_shared(); + ViewportUiCluster viewportUiCluster(buttonGroup); // register a button to the cluster auto button = AZStd::make_unique