Expose sticky select option to the SettingsRegistry and disable by default (#4149)

* expose sticky select option to the SettingsRegistry

Signed-off-by: hultonha <hultonha@amazon.co.uk>

* update missed callsites after API change to Manipulator Test Framework

Signed-off-by: hultonha <hultonha@amazon.co.uk>

* updates following review feedback

Signed-off-by: hultonha <hultonha@amazon.co.uk>

Code/Framework/AzToolsFramework/AzToolsFramework/Viewport/ViewportMessages.h

@@ -196,6 +196,8 @@ namespace AzToolsFramework
             virtual float ManipulatorLineBoundWidth() const = 0;
             //! Returns the current circle (torus) bound width for manipulators.
             virtual float ManipulatorCircleBoundWidth() const = 0;
+            //! Returns if sticky select is enabled or not.
+            virtual bool StickySelectEnabled() const = 0;
 
         protected:
             ~ViewportSettingsRequests() = default;

Code/Framework/AzToolsFramework/AzToolsFramework/ViewportSelection/EditorTransformComponentSelection.cpp

@@ -77,13 +77,6 @@ namespace AzToolsFramework
         nullptr,
         AZ::ConsoleFunctorFlags::Null,
         "The screen position of the gizmo in normalized (0-1) ndc space");
-    AZ_CVAR(
-        bool,
-        ed_viewportStickySelect,
-        true,
-        nullptr,
-        AZ::ConsoleFunctorFlags::Null,
-        "Sticky select implies a single click will not change selection with an entity already selected");
 
     // strings related to new viewport interaction model (EditorTransformComponentSelection)
     static const char* const TogglePivotTitleRightClick = "Toggle pivot";
@@ -1790,7 +1783,8 @@ namespace AzToolsFramework
 
         CheckDirtyEntityIds();
 
-        const AzFramework::CameraState cameraState = GetCameraState(mouseInteraction.m_mouseInteraction.m_interactionId.m_viewportId);
+        const AzFramework::ViewportId viewportId = mouseInteraction.m_mouseInteraction.m_interactionId.m_viewportId;
+        const AzFramework::CameraState cameraState = GetCameraState(viewportId);
 
         m_cachedEntityIdUnderCursor = m_editorHelpers->HandleMouseInteraction(cameraState, mouseInteraction);
 
@@ -1835,7 +1829,11 @@ namespace AzToolsFramework
             return true;
         }
 
-        if (ed_viewportStickySelect)
+        bool stickySelect = false;
+        ViewportInteraction::ViewportSettingsRequestBus::EventResult(
+            stickySelect, viewportId, &ViewportInteraction::ViewportSettingsRequestBus::Events::StickySelectEnabled);
+
+        if (stickySelect)
         {
             // double click to deselect all
             if (Input::DeselectAll(mouseInteraction))
@@ -1891,7 +1889,7 @@ namespace AzToolsFramework
                 return false;
             }
 
-            if (ed_viewportStickySelect)
+            if (stickySelect)
             {
                 return false;
             }
@@ -1900,7 +1898,7 @@ namespace AzToolsFramework
         // standard toggle selection
         if (Input::IndividualSelect(clickOutcome))
         {
-            if (!ed_viewportStickySelect)
+            if (!stickySelect)
             {
                 ChangeSelectedEntity(entityIdUnderCursor);
             }

Code/Framework/AzToolsFramework/AzToolsFramework/ViewportSelection/EditorTransformComponentSelection.h

@@ -33,8 +33,6 @@
 
 namespace AzToolsFramework
 {
-    AZ_CVAR_EXTERNED(bool, ed_viewportStickySelect);
-
     class EditorVisibleEntityDataCache;
 
     using EntityIdSet = AZStd::unordered_set<AZ::EntityId>; //!< Alias for unordered_set of EntityIds.

Code/Framework/AzToolsFramework/Tests/EditorTransformComponentSelectionTests.cpp

@@ -616,8 +616,6 @@ namespace UnitTest
 
     TEST_F(EditorTransformComponentSelectionViewportPickingManipulatorTestFixture, StickySingleClickWithNoSelectionWillSelectEntity)
     {
-        AzToolsFramework::ed_viewportStickySelect = true;
-
         PositionEntities();
         PositionCamera(m_cameraState);
 
@@ -629,7 +627,11 @@ namespace UnitTest
         const auto entity1ScreenPosition = AzFramework::WorldToScreen(m_entity1WorldTranslation, m_cameraState);
 
         // click the entity in the viewport
-        m_actionDispatcher->CameraState(m_cameraState)->MousePosition(entity1ScreenPosition)->MouseLButtonDown()->MouseLButtonUp();
+        m_actionDispatcher->SetStickySelect(true)
+            ->CameraState(m_cameraState)
+            ->MousePosition(entity1ScreenPosition)
+            ->MouseLButtonDown()
+            ->MouseLButtonUp();
 
         // entity is selected
         auto selectedEntitiesAfter = SelectedEntities();
@@ -639,8 +641,6 @@ namespace UnitTest
 
     TEST_F(EditorTransformComponentSelectionViewportPickingManipulatorTestFixture, UnstickySingleClickWithNoSelectionWillSelectEntity)
     {
-        AzToolsFramework::ed_viewportStickySelect = false;
-
         PositionEntities();
         PositionCamera(m_cameraState);
 
@@ -652,7 +652,11 @@ namespace UnitTest
         const auto entity1ScreenPosition = AzFramework::WorldToScreen(m_entity1WorldTranslation, m_cameraState);
 
         // click the entity in the viewport
-        m_actionDispatcher->CameraState(m_cameraState)->MousePosition(entity1ScreenPosition)->MouseLButtonDown()->MouseLButtonUp();
+        m_actionDispatcher->SetStickySelect(false)
+            ->CameraState(m_cameraState)
+            ->MousePosition(entity1ScreenPosition)
+            ->MouseLButtonDown()
+            ->MouseLButtonUp();
 
         // entity is selected
         auto selectedEntitiesAfter = SelectedEntities();
@@ -664,8 +668,6 @@ namespace UnitTest
         EditorTransformComponentSelectionViewportPickingManipulatorTestFixture,
         StickySingleClickOffEntityWithSelectionWillNotDeselectEntity)
     {
-        AzToolsFramework::ed_viewportStickySelect = true;
-
         PositionEntities();
         PositionCamera(m_cameraState);
 
@@ -678,7 +680,11 @@ namespace UnitTest
         const auto clickOffPositionScreen = AzFramework::WorldToScreen(clickOffPositionWorld, m_cameraState);
 
         // click the empty space in the viewport
-        m_actionDispatcher->CameraState(m_cameraState)->MousePosition(clickOffPositionScreen)->MouseLButtonDown()->MouseLButtonUp();
+        m_actionDispatcher->SetStickySelect(true)
+            ->CameraState(m_cameraState)
+            ->MousePosition(clickOffPositionScreen)
+            ->MouseLButtonDown()
+            ->MouseLButtonUp();
 
         // entity was not deselected
         using ::testing::Eq;
@@ -690,8 +696,6 @@ namespace UnitTest
     TEST_F(
         EditorTransformComponentSelectionViewportPickingManipulatorTestFixture, UnstickySingleClickOffEntityWithSelectionWillDeselectEntity)
     {
-        AzToolsFramework::ed_viewportStickySelect = false;
-
         PositionEntities();
         PositionCamera(m_cameraState);
 
@@ -703,7 +707,11 @@ namespace UnitTest
         const auto clickOffPositionScreen = AzFramework::WorldToScreen(clickOffPositionWorld, m_cameraState);
 
         // click the empty space in the viewport
-        m_actionDispatcher->CameraState(m_cameraState)->MousePosition(clickOffPositionScreen)->MouseLButtonDown()->MouseLButtonUp();
+        m_actionDispatcher->SetStickySelect(false)
+            ->CameraState(m_cameraState)
+            ->MousePosition(clickOffPositionScreen)
+            ->MouseLButtonDown()
+            ->MouseLButtonUp();
 
         // entity was deselected
         auto selectedEntitiesAfter = SelectedEntities();
@@ -714,8 +722,6 @@ namespace UnitTest
         EditorTransformComponentSelectionViewportPickingManipulatorTestFixture,
         StickySingleClickOnNewEntityWithSelectionWillNotChangeSelectedEntity)
     {
-        AzToolsFramework::ed_viewportStickySelect = true;
-
         PositionEntities();
         PositionCamera(m_cameraState);
 
@@ -725,7 +731,11 @@ namespace UnitTest
         const auto entity2ScreenPosition = AzFramework::WorldToScreen(m_entity2WorldTranslation, m_cameraState);
 
         // click the entity in the viewport
-        m_actionDispatcher->CameraState(m_cameraState)->MousePosition(entity2ScreenPosition)->MouseLButtonDown()->MouseLButtonUp();
+        m_actionDispatcher->SetStickySelect(true)
+            ->CameraState(m_cameraState)
+            ->MousePosition(entity2ScreenPosition)
+            ->MouseLButtonDown()
+            ->MouseLButtonUp();
 
         // entity selection was not changed
         using ::testing::Eq;
@@ -738,8 +748,6 @@ namespace UnitTest
         EditorTransformComponentSelectionViewportPickingManipulatorTestFixture,
         UnstickySingleClickOnNewEntityWithSelectionWillChangeSelectedEntity)
     {
-        AzToolsFramework::ed_viewportStickySelect = false;
-
         PositionEntities();
         PositionCamera(m_cameraState);
 
@@ -749,7 +757,11 @@ namespace UnitTest
         const auto entity2ScreenPosition = AzFramework::WorldToScreen(m_entity2WorldTranslation, m_cameraState);
 
         // click the entity in the viewport
-        m_actionDispatcher->CameraState(m_cameraState)->MousePosition(entity2ScreenPosition)->MouseLButtonDown()->MouseLButtonUp();
+        m_actionDispatcher->SetStickySelect(false)
+            ->CameraState(m_cameraState)
+            ->MousePosition(entity2ScreenPosition)
+            ->MouseLButtonDown()
+            ->MouseLButtonUp();
 
         // entity selection was changed
         using ::testing::Eq;
@@ -762,8 +774,6 @@ namespace UnitTest
         EditorTransformComponentSelectionViewportPickingManipulatorTestFixture,
         StickyCtrlSingleClickOnNewEntityWithSelectionWillAppendSelectedEntityToSelection)
     {
-        AzToolsFramework::ed_viewportStickySelect = true;
-
         PositionEntities();
         PositionCamera(m_cameraState);
 
@@ -773,7 +783,7 @@ namespace UnitTest
         const auto entity2ScreenPosition = AzFramework::WorldToScreen(m_entity2WorldTranslation, m_cameraState);
 
         // click the entity in the viewport
-        m_actionDispatcher->CameraState(m_cameraState)
+        m_actionDispatcher->SetStickySelect(true)->CameraState(m_cameraState)
             ->MousePosition(entity2ScreenPosition)
             ->KeyboardModifierDown(AzToolsFramework::ViewportInteraction::KeyboardModifier::Control)
             ->MouseLButtonDown()
@@ -789,8 +799,6 @@ namespace UnitTest
         EditorTransformComponentSelectionViewportPickingManipulatorTestFixture,
         UnstickyCtrlSingleClickOnNewEntityWithSelectionWillAppendSelectedEntityToSelection)
     {
-        AzToolsFramework::ed_viewportStickySelect = false;
-
         PositionEntities();
         PositionCamera(m_cameraState);
 
@@ -800,7 +808,8 @@ namespace UnitTest
         const auto entity2ScreenPosition = AzFramework::WorldToScreen(m_entity2WorldTranslation, m_cameraState);
 
         // click the entity in the viewport
-        m_actionDispatcher->CameraState(m_cameraState)
+        m_actionDispatcher->SetStickySelect(false)
+            ->CameraState(m_cameraState)
             ->MousePosition(entity2ScreenPosition)
             ->KeyboardModifierDown(AzToolsFramework::ViewportInteraction::KeyboardModifier::Control)
             ->MouseLButtonDown()
@@ -816,8 +825,6 @@ namespace UnitTest
         EditorTransformComponentSelectionViewportPickingManipulatorTestFixture,
         StickyCtrlSingleClickOnEntityInSelectionWillRemoveEntityFromSelection)
     {
-        AzToolsFramework::ed_viewportStickySelect = true;
-
         PositionEntities();
         PositionCamera(m_cameraState);
 
@@ -827,7 +834,8 @@ namespace UnitTest
         const auto entity2ScreenPosition = AzFramework::WorldToScreen(m_entity2WorldTranslation, m_cameraState);
 
         // click the entity in the viewport
-        m_actionDispatcher->CameraState(m_cameraState)
+        m_actionDispatcher->SetStickySelect(true)
+            ->CameraState(m_cameraState)
             ->MousePosition(entity2ScreenPosition)
             ->KeyboardModifierDown(AzToolsFramework::ViewportInteraction::KeyboardModifier::Control)
             ->MouseLButtonDown()
@@ -843,8 +851,6 @@ namespace UnitTest
         EditorTransformComponentSelectionViewportPickingManipulatorTestFixture,
         UnstickyCtrlSingleClickOnEntityInSelectionWillRemoveEntityFromSelection)
     {
-        AzToolsFramework::ed_viewportStickySelect = false;
-
         PositionEntities();
         PositionCamera(m_cameraState);
 
@@ -854,7 +860,8 @@ namespace UnitTest
         const auto entity2ScreenPosition = AzFramework::WorldToScreen(m_entity2WorldTranslation, m_cameraState);
 
         // click the entity in the viewport
-        m_actionDispatcher->CameraState(m_cameraState)
+        m_actionDispatcher->SetStickySelect(false)
+            ->CameraState(m_cameraState)
             ->MousePosition(entity2ScreenPosition)
             ->KeyboardModifierDown(AzToolsFramework::ViewportInteraction::KeyboardModifier::Control)
             ->MouseLButtonDown()
@@ -868,8 +875,6 @@ namespace UnitTest
 
     TEST_F(EditorTransformComponentSelectionViewportPickingManipulatorTestFixture, BoxSelectWithNoInitialSelectionAddsEntitiesToSelection)
     {
-        AzToolsFramework::ed_viewportStickySelect = true;
-
         PositionEntities();
         PositionCamera(m_cameraState);
 
@@ -882,7 +887,8 @@ namespace UnitTest
         const auto endingPositionWorldBoxSelect = AzFramework::WorldToScreen(AZ::Vector3(5.0f, 16.5f, 9.5f), m_cameraState);
 
         // perform a box select in the viewport
-        m_actionDispatcher->CameraState(m_cameraState)
+        m_actionDispatcher->SetStickySelect(true)
+            ->CameraState(m_cameraState)
             ->MousePosition(beginningPositionWorldBoxSelect)
             ->MouseLButtonDown()
             ->MousePosition(endingPositionWorldBoxSelect)
@@ -896,8 +902,6 @@ namespace UnitTest
 
     TEST_F(EditorTransformComponentSelectionViewportPickingManipulatorTestFixture, BoxSelectWithSelectionAppendsEntitiesToSelection)
     {
-        AzToolsFramework::ed_viewportStickySelect = true;
-
         PositionEntities();
         PositionCamera(m_cameraState);
 
@@ -914,7 +918,8 @@ namespace UnitTest
         const auto endingPositionWorldBoxSelect2 = AzFramework::WorldToScreen(AZ::Vector3(5.0f, 16.5f, 9.5f), m_cameraState);
 
         // perform a box select in the viewport (going left and right)
-        m_actionDispatcher->CameraState(m_cameraState)
+        m_actionDispatcher->SetStickySelect(true)
+            ->CameraState(m_cameraState)
             ->MousePosition(beginningPositionWorldBoxSelect1)
             ->MouseLButtonDown()
             ->MousePosition(endingPositionWorldBoxSelect1)
@@ -933,8 +938,6 @@ namespace UnitTest
         EditorTransformComponentSelectionViewportPickingManipulatorTestFixture,
         BoxSelectHoldingCtrlWithSelectionRemovesEntitiesFromSelection)
     {
-        AzToolsFramework::ed_viewportStickySelect = true;
-
         PositionEntities();
         PositionCamera(m_cameraState);
 
@@ -949,7 +952,8 @@ namespace UnitTest
         const auto endingPositionWorldBoxSelect = AzFramework::WorldToScreen(AZ::Vector3(5.0f, 16.5f, 9.5f), m_cameraState);
 
         // perform a box select in the viewport
-        m_actionDispatcher->CameraState(m_cameraState)
+        m_actionDispatcher->SetStickySelect(true)
+            ->CameraState(m_cameraState)
             ->MousePosition(beginningPositionWorldBoxSelect)
             ->KeyboardModifierDown(AzToolsFramework::ViewportInteraction::KeyboardModifier::Control)
             ->MouseLButtonDown()
@@ -963,8 +967,6 @@ namespace UnitTest
 
     TEST_F(EditorTransformComponentSelectionViewportPickingManipulatorTestFixture, StickyDoubleClickWithSelectionWillDeselectEntities)
     {
-        AzToolsFramework::ed_viewportStickySelect = true;
-
         PositionEntities();
         PositionCamera(m_cameraState);
 
@@ -980,7 +982,10 @@ namespace UnitTest
         const auto clickOffPositionScreen = AzFramework::WorldToScreen(clickOffPositionWorld, m_cameraState);
 
         // double click to deselect entities
-        m_actionDispatcher->CameraState(m_cameraState)->MousePosition(clickOffPositionScreen)->MouseLButtonDoubleClick();
+        m_actionDispatcher->SetStickySelect(true)
+            ->CameraState(m_cameraState)
+            ->MousePosition(clickOffPositionScreen)
+            ->MouseLButtonDoubleClick();
 
         // no entities are selected
         auto selectedEntitiesAfter = SelectedEntities();
@@ -989,8 +994,6 @@ namespace UnitTest
 
     TEST_F(EditorTransformComponentSelectionViewportPickingManipulatorTestFixture, UnstickyUndoOperationForChangeInSelectionIsAtomic)
     {
-        AzToolsFramework::ed_viewportStickySelect = false;
-
         PositionEntities();
         PositionCamera(m_cameraState);
 
@@ -1000,7 +1003,11 @@ namespace UnitTest
         const auto entity2ScreenPosition = AzFramework::WorldToScreen(m_entity2WorldTranslation, m_cameraState);
 
         // single click select entity2
-        m_actionDispatcher->CameraState(m_cameraState)->MousePosition(entity2ScreenPosition)->MouseLButtonDown()->MouseLButtonUp();
+        m_actionDispatcher->SetStickySelect(false)
+            ->CameraState(m_cameraState)
+            ->MousePosition(entity2ScreenPosition)
+            ->MouseLButtonDown()
+            ->MouseLButtonUp();
 
         // undo action
         AzToolsFramework::ToolsApplicationRequestBus::Broadcast(&AzToolsFramework::ToolsApplicationRequestBus::Events::UndoPressed);