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>
2021-09-16 09:14:37 +01:00
parent a8908a987a
commit 7e85b1512a
19 changed files with 275 additions and 182 deletions
@@ -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);