From 2ced6011e907a42549b16b52c952582fcbf58f63 Mon Sep 17 00:00:00 2001 From: greerdv Date: Fri, 29 Oct 2021 16:35:47 +0100 Subject: [PATCH 1/5] add python test for smoothness of interpolated rigid body motion Signed-off-by: greerdv --- .../Gem/PythonTests/Physics/TestSuite_Main.py | 6 ++ ...ick_InterpolatedRigidBodyMotionIsSmooth.py | 98 +++++++++++++++++++ pytest.ini | 1 + 3 files changed, 105 insertions(+) create mode 100644 AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py diff --git a/AutomatedTesting/Gem/PythonTests/Physics/TestSuite_Main.py b/AutomatedTesting/Gem/PythonTests/Physics/TestSuite_Main.py index b64fbb5656..2dc8e04b1e 100644 --- a/AutomatedTesting/Gem/PythonTests/Physics/TestSuite_Main.py +++ b/AutomatedTesting/Gem/PythonTests/Physics/TestSuite_Main.py @@ -91,4 +91,10 @@ class TestAutomation(TestAutomationBase): @revert_physics_config def test_C15425929_Undo_Redo(self, request, workspace, editor, launcher_platform): from .tests import Physics_UndoRedoWorksOnEntityWithPhysComponents as test_module + self._run_test(request, workspace, editor, test_module) + + @pytest.mark.tick + @pytest.mark.xfail(reason="Test still under development.") + def test_Tick_InterpolatedRigidBodyMotionIsSmooth(self, request, workspace, editor, launcher_platform): + from .tests.tick import Tick_InterpolatedRigidBodyMotionIsSmooth as test_module self._run_test(request, workspace, editor, test_module) \ No newline at end of file diff --git a/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py b/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py new file mode 100644 index 0000000000..67cbdbd6cb --- /dev/null +++ b/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py @@ -0,0 +1,98 @@ +""" +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 + +Test Case Title : Verify that a rigid body with "Interpolate motion" option selected moves smoothly. +""" + + +# fmt: off +class Tests(): + create_entity = ("Created test entity", "Failed to create test entity") + rigid_body_added = ("Added PhysX Rigid Body component", "Failed to add PhysX Rigid Body component") + rigid_body_smooth = ("Rigid body motion passed smoothness threshold", "Failed to meet smoothness threshold for rigid body motion") +# fmt: on + + +def Tick_InterpolatedRigidBodyMotionIsSmooth(): + """ + Summary: + Create entity with Mesh and PhysX Collider components and assign a fbx file in both the components. + Verify that the fbx is properly fitting the mesh. + + Expected Behavior: + 1) The fbx is properly fitting the mesh. + 2) Multiple material slots show up under Materials section in the PhysX Collider component and that + they correspond to the number of surfaces as designed in the mesh. + + Test Steps: + 1) Load the empty level + 2) Create an entity + 3) Add rigid body component + 4) Enter game mode and collect data for the rigid body's z co-ordinate and the time values for a series of frames + 5) Check if the motion of the rigid body was sufficiently smooth + + :return: None + """ + # imports + import os + import azlmbr.legacy.general as general + import azlmbr.math as math + from editor_python_test_tools.editor_entity_utils import EditorEntity as Entity + from editor_python_test_tools.utils import Report + from editor_python_test_tools.utils import TestHelper as helper + from editor_python_test_tools.asset_utils import Asset + import numpy as np + + # constants + COEFFICIENT_OF_DETERMINATION_THRESHOLD = 1 - 1e-4 # curves with values below this are not considered sufficiently smooth + + helper.init_idle() + # 1) Load the empty level + helper.open_level("Physics", "Base") + + # 2) Create an entity + test_entity = Entity.create_editor_entity("test_entity") + Report.result(Tests.create_entity, test_entity.id.IsValid()) + + azlmbr.components.TransformBus( + azlmbr.bus.Event, "SetWorldTranslation", test_entity.id, math.Vector3(0.0, 0.0, 0.0)) + + # 3) Add rigid body component + rigid_body_component = test_entity.add_component("PhysX Rigid Body") + rigid_body_component.set_component_property_value("Configuration|Interpolate motion", True) + azlmbr.physics.RigidBodyRequestBus(azlmbr.bus.Event, "SetLinearDamping", test_entity.id, 0.0) + Report.result(Tests.rigid_body_added, test_entity.has_component("PhysX Rigid Body")) + + # 4) Enter game mode and collect data for the rigid body's z co-ordinate and the time values for a series of frames + t = [] + z = [] + general.enter_game_mode() + general.idle_wait_frames(1) + game_entity_id = general.find_game_entity("test_entity") + for timestep in range(100): + t.append(azlmbr.components.TickRequestBus(azlmbr.bus.Broadcast, "GetTimeAtCurrentTick").GetSeconds()) + z.append(azlmbr.components.TransformBus(azlmbr.bus.Event, "GetWorldZ", game_entity_id)) + general.idle_wait_frames(1) + general.exit_game_mode() + + # 5) Test that the z vs t curve is sufficiently smooth (if the interpolation is not working well, the curve will be less smooth) + # normalize the t and z data + t = np.array(t) - np.mean(t) + z = np.array(z) - np.mean(z) + # fit a polynomial to the z vs t curve + fit = np.poly1d(np.polyfit(t, z, 4)) + residual = fit(t) - z + # calculate the coefficient of determination (a measure of how closely the polynomial curve fits the data) + # if the coefficient is very close to 1, then the curve fits the data very well, suggesting that the rigid body motion is smooth + # if the coefficient is significantly less than 1, then the z values vary more erratically relative to the smooth curve, + # indicating that the motion of the rigid body is not smooth + coefficient_of_determination = (1 - np.sum(residual * residual) / np.sum(z * z)) + Report.result(Tests.rigid_body_smooth, bool(coefficient_of_determination > COEFFICIENT_OF_DETERMINATION_THRESHOLD)) + + +if __name__ == "__main__": + from editor_python_test_tools.utils import Report + Report.start_test(Tick_InterpolatedRigidBodyMotionIsSmooth) diff --git a/pytest.ini b/pytest.ini index 65c93e0eb2..a863f8ca96 100644 --- a/pytest.ini +++ b/pytest.ini @@ -22,4 +22,5 @@ markers = SUITE_smoke: Tiny, quick tests of fundamental operation (tests with no SUITE_awsi: Time consuming AWS integration end-to-end tests # secondary markers which may appear alongisde a suite marker: REQUIRES_gpu: Tests which require a physical GPU + tick: Tests which verify if systems update correctly with system ticks (for example, physics bodies should move smoothly) # custom markers not listed above will cause pytest to emit a typo warning From 128b3d7ec0e1c87553b21665e485736a00d51809 Mon Sep 17 00:00:00 2001 From: greerdv Date: Fri, 29 Oct 2021 16:55:41 +0100 Subject: [PATCH 2/5] fix copy paste error in test description Signed-off-by: greerdv --- .../tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py b/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py index 67cbdbd6cb..c7cc3725c7 100644 --- a/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py +++ b/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py @@ -19,13 +19,11 @@ class Tests(): def Tick_InterpolatedRigidBodyMotionIsSmooth(): """ Summary: - Create entity with Mesh and PhysX Collider components and assign a fbx file in both the components. - Verify that the fbx is properly fitting the mesh. + Create entity with PhysX Rigid Body component and turn on the Interpolate motion setting. + Verify that the position of the rigid body varies smoothly with time. Expected Behavior: - 1) The fbx is properly fitting the mesh. - 2) Multiple material slots show up under Materials section in the PhysX Collider component and that - they correspond to the number of surfaces as designed in the mesh. + 1) The motion of the rigid body under the gravity is a smooth curve, rather than an erratic/jittery movement. Test Steps: 1) Load the empty level From 06ef0372781093dc5e8eb57e90d41237ddb4a1ca Mon Sep 17 00:00:00 2001 From: greerdv Date: Fri, 29 Oct 2021 16:57:42 +0100 Subject: [PATCH 3/5] fix typo Signed-off-by: greerdv --- .../tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py b/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py index c7cc3725c7..1b9310910d 100644 --- a/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py +++ b/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py @@ -23,7 +23,7 @@ def Tick_InterpolatedRigidBodyMotionIsSmooth(): Verify that the position of the rigid body varies smoothly with time. Expected Behavior: - 1) The motion of the rigid body under the gravity is a smooth curve, rather than an erratic/jittery movement. + 1) The motion of the rigid body under gravity is a smooth curve, rather than an erratic/jittery movement. Test Steps: 1) Load the empty level From 53c6a22ac2cc618aa57d417d7aac4c05737568c0 Mon Sep 17 00:00:00 2001 From: greerdv Date: Fri, 29 Oct 2021 17:21:21 +0100 Subject: [PATCH 4/5] add python test for smoothness of character gameplay component motion Signed-off-by: greerdv --- .../Gem/PythonTests/Physics/TestSuite_Main.py | 8 +- ...haracterGameplayComponentMotionIsSmooth.py | 97 +++++++++++++++++++ 2 files changed, 104 insertions(+), 1 deletion(-) create mode 100644 AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_CharacterGameplayComponentMotionIsSmooth.py diff --git a/AutomatedTesting/Gem/PythonTests/Physics/TestSuite_Main.py b/AutomatedTesting/Gem/PythonTests/Physics/TestSuite_Main.py index 2dc8e04b1e..3ef593612b 100644 --- a/AutomatedTesting/Gem/PythonTests/Physics/TestSuite_Main.py +++ b/AutomatedTesting/Gem/PythonTests/Physics/TestSuite_Main.py @@ -97,4 +97,10 @@ class TestAutomation(TestAutomationBase): @pytest.mark.xfail(reason="Test still under development.") def test_Tick_InterpolatedRigidBodyMotionIsSmooth(self, request, workspace, editor, launcher_platform): from .tests.tick import Tick_InterpolatedRigidBodyMotionIsSmooth as test_module - self._run_test(request, workspace, editor, test_module) \ No newline at end of file + self._run_test(request, workspace, editor, test_module) + + @pytest.mark.tick + @pytest.mark.xfail(reason="Test still under development.") + def test_Tick_Tick_CharacterGameplayComponentMotionIsSmooth(self, request, workspace, editor, launcher_platform): + from .tests.tick import Tick_CharacterGameplayComponentMotionIsSmooth as test_module + self._run_test(request, workspace, editor, test_module) diff --git a/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_CharacterGameplayComponentMotionIsSmooth.py b/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_CharacterGameplayComponentMotionIsSmooth.py new file mode 100644 index 0000000000..6425ece640 --- /dev/null +++ b/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_CharacterGameplayComponentMotionIsSmooth.py @@ -0,0 +1,97 @@ +""" +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 + +Test Case Title : Verify that an entity with a character gameplay component moves smoothly. +""" + + +# fmt: off +class Tests(): + create_entity = ("Created test entity", "Failed to create test entity") + character_controller_added = ("Added PhysX Character Controller component", "Failed to add PhysX Character Controller component") + character_gameplay_added = ("Added PhysX Character Gameplay component", "Failed to add PhysX Character Gameplay component") + character_motion_smooth = ("Character motion passed smoothness threshold", "Failed to meet smoothness threshold for character motion") +# fmt: on + + +def Tick_CharacterGameplayComponentMotionIsSmooth(): + """ + Summary: + Create entity with PhysX Character Controller and PhysX Character Gameplay components. + Verify that the motion of the character controller under gravity is smooth. + + Expected Behavior: + 1) The motion of the character controller under gravity is a smooth curve, rather than an erratic/jittery movement. + + Test Steps: + 1) Load the empty level + 2) Create an entity + 3) Add a PhysX Character Controller Component and PhysX Character Gameplay component + 4) Enter game mode and collect data for the character controller's z co-ordinate and the time values for a series of frames + 5) Check if the motion of the character controller was sufficiently smooth + + :return: None + """ + # imports + import os + import azlmbr.legacy.general as general + import azlmbr.math as math + from editor_python_test_tools.editor_entity_utils import EditorEntity as Entity + from editor_python_test_tools.utils import Report + from editor_python_test_tools.utils import TestHelper as helper + from editor_python_test_tools.asset_utils import Asset + import numpy as np + + # constants + COEFFICIENT_OF_DETERMINATION_THRESHOLD = 1 - 1e-4 # curves with values below this are not considered sufficiently smooth + + helper.init_idle() + # 1) Load the empty level + helper.open_level("Physics", "Base") + + # 2) Create an entity + test_entity = Entity.create_editor_entity("test_entity") + Report.result(Tests.create_entity, test_entity.id.IsValid()) + + azlmbr.components.TransformBus( + azlmbr.bus.Event, "SetWorldTranslation", test_entity.id, math.Vector3(0.0, 0.0, 0.0)) + + # 3) Add character controller and character gameplay components + character_controller_component = test_entity.add_component("PhysX Character Controller") + Report.result(Tests.character_controller_added, test_entity.has_component("PhysX Character Controller")) + character_gameplay_component = test_entity.add_component("PhysX Character Gameplay") + Report.result(Tests.character_gameplay_added, test_entity.has_component("PhysX Character Gameplay")) + + # 4) Enter game mode and collect data for the rigid body's z co-ordinate and the time values for a series of frames + t = [] + z = [] + general.enter_game_mode() + general.idle_wait_frames(1) + game_entity_id = general.find_game_entity("test_entity") + for timestep in range(100): + t.append(azlmbr.components.TickRequestBus(azlmbr.bus.Broadcast, "GetTimeAtCurrentTick").GetSeconds()) + z.append(azlmbr.components.TransformBus(azlmbr.bus.Event, "GetWorldZ", game_entity_id)) + general.idle_wait_frames(1) + general.exit_game_mode() + + # 5) Test that the z vs t curve is sufficiently smooth (if the interpolation is not working well, the curve will be less smooth) + # normalize the t and z data + t = np.array(t) - np.mean(t) + z = np.array(z) - np.mean(z) + # fit a polynomial to the z vs t curve + fit = np.poly1d(np.polyfit(t, z, 4)) + residual = fit(t) - z + # calculate the coefficient of determination (a measure of how closely the polynomial curve fits the data) + # if the coefficient is very close to 1, then the curve fits the data very well, suggesting that the rigid body motion is smooth + # if the coefficient is significantly less than 1, then the z values vary more erratically relative to the smooth curve, + # indicating that the motion of the rigid body is not smooth + coefficient_of_determination = (1 - np.sum(residual * residual) / np.sum(z * z)) + Report.result(Tests.character_motion_smooth, bool(coefficient_of_determination > COEFFICIENT_OF_DETERMINATION_THRESHOLD)) + + +if __name__ == "__main__": + from editor_python_test_tools.utils import Report + Report.start_test(Tick_CharacterGameplayComponentMotionIsSmooth) From 9d05168cfceb8aae13a55f68133053afa9234203 Mon Sep 17 00:00:00 2001 From: greerdv Date: Thu, 11 Nov 2021 15:10:46 +0000 Subject: [PATCH 5/5] address feedback from PR Signed-off-by: greerdv --- .../Gem/PythonTests/Physics/TestSuite_Main.py | 6 +++--- .../Tick_CharacterGameplayComponentMotionIsSmooth.py | 10 ++++++---- .../tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py | 10 ++++++---- pytest.ini | 2 +- 4 files changed, 16 insertions(+), 12 deletions(-) diff --git a/AutomatedTesting/Gem/PythonTests/Physics/TestSuite_Main.py b/AutomatedTesting/Gem/PythonTests/Physics/TestSuite_Main.py index 3ef593612b..fb2744deda 100644 --- a/AutomatedTesting/Gem/PythonTests/Physics/TestSuite_Main.py +++ b/AutomatedTesting/Gem/PythonTests/Physics/TestSuite_Main.py @@ -93,14 +93,14 @@ class TestAutomation(TestAutomationBase): from .tests import Physics_UndoRedoWorksOnEntityWithPhysComponents as test_module self._run_test(request, workspace, editor, test_module) - @pytest.mark.tick + @pytest.mark.GROUP_tick @pytest.mark.xfail(reason="Test still under development.") def test_Tick_InterpolatedRigidBodyMotionIsSmooth(self, request, workspace, editor, launcher_platform): from .tests.tick import Tick_InterpolatedRigidBodyMotionIsSmooth as test_module self._run_test(request, workspace, editor, test_module) - @pytest.mark.tick + @pytest.mark.GROUP_tick @pytest.mark.xfail(reason="Test still under development.") - def test_Tick_Tick_CharacterGameplayComponentMotionIsSmooth(self, request, workspace, editor, launcher_platform): + def test_Tick_CharacterGameplayComponentMotionIsSmooth(self, request, workspace, editor, launcher_platform): from .tests.tick import Tick_CharacterGameplayComponentMotionIsSmooth as test_module self._run_test(request, workspace, editor, test_module) diff --git a/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_CharacterGameplayComponentMotionIsSmooth.py b/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_CharacterGameplayComponentMotionIsSmooth.py index 6425ece640..fe718d7247 100644 --- a/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_CharacterGameplayComponentMotionIsSmooth.py +++ b/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_CharacterGameplayComponentMotionIsSmooth.py @@ -13,6 +13,8 @@ class Tests(): create_entity = ("Created test entity", "Failed to create test entity") character_controller_added = ("Added PhysX Character Controller component", "Failed to add PhysX Character Controller component") character_gameplay_added = ("Added PhysX Character Gameplay component", "Failed to add PhysX Character Gameplay component") + enter_game_mode = ("Entered game mode", "Failed to enter game mode") + exit_game_mode = ("Exited game mode", "Failed to exit game mode") character_motion_smooth = ("Character motion passed smoothness threshold", "Failed to meet smoothness threshold for character motion") # fmt: on @@ -50,7 +52,7 @@ def Tick_CharacterGameplayComponentMotionIsSmooth(): helper.init_idle() # 1) Load the empty level - helper.open_level("Physics", "Base") + helper.open_level("", "Base") # 2) Create an entity test_entity = Entity.create_editor_entity("test_entity") @@ -68,14 +70,14 @@ def Tick_CharacterGameplayComponentMotionIsSmooth(): # 4) Enter game mode and collect data for the rigid body's z co-ordinate and the time values for a series of frames t = [] z = [] - general.enter_game_mode() + helper.enter_game_mode(Tests.enter_game_mode) general.idle_wait_frames(1) game_entity_id = general.find_game_entity("test_entity") - for timestep in range(100): + for frame in range(100): t.append(azlmbr.components.TickRequestBus(azlmbr.bus.Broadcast, "GetTimeAtCurrentTick").GetSeconds()) z.append(azlmbr.components.TransformBus(azlmbr.bus.Event, "GetWorldZ", game_entity_id)) general.idle_wait_frames(1) - general.exit_game_mode() + helper.exit_game_mode(Tests.exit_game_mode) # 5) Test that the z vs t curve is sufficiently smooth (if the interpolation is not working well, the curve will be less smooth) # normalize the t and z data diff --git a/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py b/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py index 1b9310910d..19e79355d9 100644 --- a/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py +++ b/AutomatedTesting/Gem/PythonTests/Physics/tests/tick/Tick_InterpolatedRigidBodyMotionIsSmooth.py @@ -12,6 +12,8 @@ Test Case Title : Verify that a rigid body with "Interpolate motion" option sele class Tests(): create_entity = ("Created test entity", "Failed to create test entity") rigid_body_added = ("Added PhysX Rigid Body component", "Failed to add PhysX Rigid Body component") + enter_game_mode = ("Entered game mode", "Failed to enter game mode") + exit_game_mode = ("Exited game mode", "Failed to exit game mode") rigid_body_smooth = ("Rigid body motion passed smoothness threshold", "Failed to meet smoothness threshold for rigid body motion") # fmt: on @@ -49,7 +51,7 @@ def Tick_InterpolatedRigidBodyMotionIsSmooth(): helper.init_idle() # 1) Load the empty level - helper.open_level("Physics", "Base") + helper.open_level("", "Base") # 2) Create an entity test_entity = Entity.create_editor_entity("test_entity") @@ -67,14 +69,14 @@ def Tick_InterpolatedRigidBodyMotionIsSmooth(): # 4) Enter game mode and collect data for the rigid body's z co-ordinate and the time values for a series of frames t = [] z = [] - general.enter_game_mode() + helper.enter_game_mode(Tests.enter_game_mode) general.idle_wait_frames(1) game_entity_id = general.find_game_entity("test_entity") - for timestep in range(100): + for frame in range(100): t.append(azlmbr.components.TickRequestBus(azlmbr.bus.Broadcast, "GetTimeAtCurrentTick").GetSeconds()) z.append(azlmbr.components.TransformBus(azlmbr.bus.Event, "GetWorldZ", game_entity_id)) general.idle_wait_frames(1) - general.exit_game_mode() + helper.exit_game_mode(Tests.exit_game_mode) # 5) Test that the z vs t curve is sufficiently smooth (if the interpolation is not working well, the curve will be less smooth) # normalize the t and z data diff --git a/pytest.ini b/pytest.ini index a863f8ca96..a229b19a4d 100644 --- a/pytest.ini +++ b/pytest.ini @@ -22,5 +22,5 @@ markers = SUITE_smoke: Tiny, quick tests of fundamental operation (tests with no SUITE_awsi: Time consuming AWS integration end-to-end tests # secondary markers which may appear alongisde a suite marker: REQUIRES_gpu: Tests which require a physical GPU - tick: Tests which verify if systems update correctly with system ticks (for example, physics bodies should move smoothly) + GROUP_tick: Tests which verify if systems update correctly with system ticks (for example, physics bodies should move smoothly) # custom markers not listed above will cause pytest to emit a typo warning