PhysX Gem Split (#17436)

The PhysX Gem now independently supports both PhysX 4.1 SDK and PhysX 5.1 SDK concurrently. Previously there was only one PhysX Gem, and version 4.1 of the SDK was the default.  To enable 5.1 SDK support required a CMAKE flag (AZ_USE_PHYSX5) to be enabled to activate and (re)build the PhysX gem to use it. And the prebuilt sdk only supported version 4.1 of the SDK.  Now with a separate PhysX5 gem, the custom flag is no longer required and separate gems for the 2 SDK versions will be available at the same time, in both the source and installed sdk builds.  To update any previously generated project that used the PhysX 5.1 SDK, the dependencies to PhysX will need to be updated to PhysX5. For projects that use the ROS2 gem in o3de-extras, there is an updated version that brings in the PhysX5 dependency, so projects will need to specify the ROS2 gem versions 3.1.0 or higher.

Signed-off-by: Steve Pham <[email protected]>

Gems/Atom/Tools/MaterialCanvas/Registry/gem_autoload.materialcanvas.setreg

@@ -248,6 +248,20 @@
                     }
                 }
             },
+            "PhysX5": {
+                "Targets": {
+                    "PhysX5.Editor": {
+                        "AutoLoad": false
+                    }
+                }
+            },
+            "PhysX5Debug": {
+                "Targets": {
+                    "PhysX5Debug.Editor": {
+                        "AutoLoad": false
+                    }
+                }
+            },
             "NvCloth": {
                 "Targets": {
                     "NvCloth.Editor": {

Gems/Atom/Tools/MaterialEditor/Registry/gem_autoload.materialeditor.setreg

@@ -262,6 +262,20 @@
                     }
                 }
             },
+            "PhysX5": {
+                "Targets": {
+                    "PhysX5.Editor": {
+                        "AutoLoad": false
+                    }
+                }
+            },
+            "PhysX5Debug": {
+                "Targets": {
+                    "PhysX5Debug.Editor": {
+                        "AutoLoad": false
+                    }
+                }
+            },
             "NvCloth": {
                 "Targets": {
                     "NvCloth.Editor": {

Gems/Atom/Tools/PassCanvas/Registry/gem_autoload.passcanvas.setreg

@@ -248,6 +248,20 @@
                     }
                 }
             },
+            "PhysX5": {
+                "Targets": {
+                    "PhysX5.Editor": {
+                        "AutoLoad": false
+                    }
+                }
+            },
+            "PhysX5Debug": {
+                "Targets": {
+                    "PhysX5Debug.Editor": {
+                        "AutoLoad": false
+                    }
+                }
+            },
             "NvCloth": {
                 "Targets": {
                     "NvCloth.Editor": {

Gems/Atom/Tools/ShaderManagementConsole/Registry/gem_autoload.shadermanagementconsole.setreg

@@ -248,6 +248,20 @@
                     }
                 }
             },
+            "PhysX5": {
+                "Targets": {
+                    "PhysX5.Editor": {
+                        "AutoLoad": false
+                    }
+                }
+            },
+            "PhysX5Debug": {
+                "Targets": {
+                    "PhysX5Debug.Editor": {
+                        "AutoLoad": false
+                    }
+                }
+            },
             "NvCloth": {
                 "Targets": {
                     "NvCloth.Editor": {

Gems/PhysX/Code/Source/Platform/Android/PhysX_Traits_Platform.h

@@ -1,10 +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
-
-#include <PhysX_Traits_Android.h>

Gems/PhysX/Code/Source/Platform/Linux/PhysX_Traits_Linux.h

@@ -1,11 +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
-
-#define AZ_TRAIT_PHYSX_FORCE_LOAD_MODULES 0
-

Gems/PhysX/Code/Source/Platform/Linux/PhysX_Traits_Platform.h

@@ -1,10 +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
-
-#include <PhysX_Traits_Linux.h>

Gems/PhysX/Code/Source/Platform/Mac/PhysX_Traits_Platform.h

@@ -1,10 +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
-
-#include <PhysX_Traits_Mac.h>

Gems/PhysX/Code/Source/Platform/Windows/PhysX_Traits_Platform.h

@@ -1,10 +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
-
-#include <PhysX_Traits_Windows.h>

Gems/PhysX/Code/Source/Platform/Windows/PhysX_Traits_Windows.h

@@ -1,11 +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
-
-#define AZ_TRAIT_PHYSX_FORCE_LOAD_MODULES 0
-

Gems/PhysX/Code/Source/Platform/iOS/PhysX_Traits_Platform.h

@@ -1,10 +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
-
-#include <PhysX_Traits_iOS.h>

Gems/PhysX/Code/Source/Platform/iOS/PhysX_Traits_iOS.h

@@ -1,11 +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
-
-#define AZ_TRAIT_PHYSX_FORCE_LOAD_MODULES 0
-

Gems/PhysX/Common/CMakeLists.txt

@@ -0,0 +1,11 @@
+#
+# 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
+#
+#
+
+o3de_gem_setup("PhysXCommon")
+
+add_subdirectory(Code)

Gems/PhysX/Common/Code/CMakeLists.txt

@@ -0,0 +1,24 @@
+#
+# 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
+#
+#
+
+add_subdirectory(NumericalMethods)
+
+set(LY_PHYSX_ENABLE_RUNNING_BENCHMARKS OFF CACHE BOOL "Adds a target to allow running of the physx benchmarks.")
+
+if(PAL_TRAIT_BUILD_TESTS_SUPPORTED)
+    ly_add_target(
+        NAME PhysX.Mocks HEADERONLY
+        NAMESPACE Gem
+        OUTPUT_NAME PhysX.Mocks.Gem
+        FILES_CMAKE
+            physx_mocks_files.cmake
+        INCLUDE_DIRECTORIES
+            INTERFACE
+                Mocks
+    )
+endif()

Gems/PhysX/gem.json → Gems/PhysX/Common/gem.json

@@ -1,25 +1,23 @@
 {
-    "gem_name": "PhysX",
+    "gem_name": "PhysXCommon",
     "version": "1.0.0",
-    "display_name": "PhysX",
+    "display_name": "PhysX Common",
     "license": "Apache-2.0 Or MIT",
     "license_url": "https://github.com/o3de/o3de/blob/development/LICENSE.txt",
     "origin": "Open 3D Engine - o3de.org",
     "type": "Code",
-    "summary": "The PhysX Gem provides physics simulation with NVIDIA PhysX including static and dynamic rigid body simulation, force regions, ragdolls, and dynamic PhysX joints.",
+    "summary": "The PhysX Common Gem provides the necessary assets and common libraries to support the PhysX Gems in the catalog.",
     "canonical_tags": [
         "Gem"
     ],
     "user_tags": [
+        "Assets",
         "Physics",
-        "Simulation",
-        "SDK"
+        "Simulation"
     ],
     "icon_path": "preview.png",
     "requirements": "",
     "documentation_url": "https://o3de.org/docs/user-guide/gems/reference/physics/nvidia/physx/",
     "dependencies": [
-        "LmbrCentral",
-        "CommonFeaturesAtom"
     ]
 }