diff --git a/CMakeLists.txt b/CMakeLists.txt index ff324be..b51f079 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -34,6 +34,8 @@ option(OMATH_ENABLE_FORCE_INLINE option(OMATH_ENABLE_LUA "omath bindings for lua" OFF) +option(OMATH_ENABLE_PHYSX + "PhysX-backed collider implementations" OFF) if(VCPKG_MANIFEST_FEATURES) foreach(omath_feature IN LISTS VCPKG_MANIFEST_FEATURES) if(omath_feature STREQUAL "imgui") @@ -48,6 +50,8 @@ if(VCPKG_MANIFEST_FEATURES) set(OMATH_BUILD_EXAMPLES ON) elseif(omath_feature STREQUAL "lua") set(OMATH_ENABLE_LUA ON) + elseif(omath_feature STREQUAL "physx") + set(OMATH_ENABLE_PHYSX ON) endif() endforeach() @@ -78,6 +82,7 @@ if(${PROJECT_IS_TOP_LEVEL}) message(STATUS "[${PROJECT_NAME}]: Coverage feature status ${OMATH_ENABLE_COVERAGE}") message(STATUS "[${PROJECT_NAME}]: Valgrind feature status ${OMATH_ENABLE_VALGRIND}") message(STATUS "[${PROJECT_NAME}]: Lua feature status ${OMATH_ENABLE_LUA}") + message(STATUS "[${PROJECT_NAME}]: PhysX feature status ${OMATH_ENABLE_PHYSX}") endif() file(GLOB_RECURSE OMATH_SOURCES CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/source/*.cpp") @@ -100,6 +105,13 @@ if (OMATH_ENABLE_LUA) target_include_directories(${PROJECT_NAME} PRIVATE ${SOL2_INCLUDE_DIRS}) endif () +if (OMATH_ENABLE_PHYSX) + target_compile_definitions(${PROJECT_NAME} PUBLIC OMATH_ENABLE_PHYSX) + + find_package(unofficial-omniverse-physx-sdk CONFIG REQUIRED) + target_link_libraries(${PROJECT_NAME} PUBLIC unofficial::omniverse-physx-sdk::sdk) +endif () + add_library(${PROJECT_NAME}::${PROJECT_NAME} ALIAS ${PROJECT_NAME}) target_compile_definitions(${PROJECT_NAME} PUBLIC OMATH_VERSION="${PROJECT_VERSION}") diff --git a/CMakePresets.json b/CMakePresets.json index 8d27ee1..ad09e99 100644 --- a/CMakePresets.json +++ b/CMakePresets.json @@ -145,7 +145,7 @@ "hidden": true, "inherits": ["linux-base", "vcpkg-base"], "cacheVariables": { - "VCPKG_MANIFEST_FEATURES": "tests;imgui;avx2;lua" + "VCPKG_MANIFEST_FEATURES": "tests;imgui;avx2;lua;physx" } }, { diff --git a/include/omath/collision/physx_box_collider.hpp b/include/omath/collision/physx_box_collider.hpp new file mode 100644 index 0000000..08ffc96 --- /dev/null +++ b/include/omath/collision/physx_box_collider.hpp @@ -0,0 +1,59 @@ +// +// Created by orange-cpp +// +#pragma once + +#ifdef OMATH_ENABLE_PHYSX + +#include "collider_interface.hpp" +#include + +namespace omath::collision +{ + /// Axis-aligned box collider backed by PhysX PxBoxGeometry. + /// Half-extents are stored in PhysX convention (positive values along each axis). + class PhysXBoxCollider final : public ColliderInterface> + { + public: + /// @param half_extents Half-widths along X, Y and Z axes (all must be > 0). + /// @param origin World-space centre of the box. + explicit PhysXBoxCollider(const VectorType& half_extents, const VectorType& origin = {}) + : m_geometry(physx::PxVec3(half_extents.x, half_extents.y, half_extents.z)) + , m_origin(origin) + { + } + + /// Support function: returns the world-space point on the box furthest in @p direction. + /// For a box, the furthest point along d is origin + (sign(d.x)*hx, sign(d.y)*hy, sign(d.z)*hz). + [[nodiscard]] + VectorType find_abs_furthest_vertex_position(const VectorType& direction) const override + { + const auto& he = m_geometry.halfExtents; + return { + m_origin.x + (direction.x >= 0.f ? he.x : -he.x), + m_origin.y + (direction.y >= 0.f ? he.y : -he.y), + m_origin.z + (direction.z >= 0.f ? he.z : -he.z), + }; + } + + [[nodiscard]] + const VectorType& get_origin() const override { return m_origin; } + + void set_origin(const VectorType& new_origin) override { m_origin = new_origin; } + + [[nodiscard]] + const physx::PxBoxGeometry& get_geometry() const { return m_geometry; } + + /// Update half-extents at runtime. + void set_half_extents(const VectorType& half_extents) + { + m_geometry = physx::PxBoxGeometry(physx::PxVec3(half_extents.x, half_extents.y, half_extents.z)); + } + + private: + physx::PxBoxGeometry m_geometry; + VectorType m_origin; + }; +} // namespace omath::collision + +#endif // OMATH_ENABLE_PHYSX diff --git a/include/omath/collision/physx_sphere_collider.hpp b/include/omath/collision/physx_sphere_collider.hpp new file mode 100644 index 0000000..afd5b37 --- /dev/null +++ b/include/omath/collision/physx_sphere_collider.hpp @@ -0,0 +1,64 @@ +// +// Created by orange-cpp +// +#pragma once + +#ifdef OMATH_ENABLE_PHYSX + +#include "collider_interface.hpp" +#include +#include + +namespace omath::collision +{ + /// Sphere collider backed by PhysX PxSphereGeometry. + class PhysXSphereCollider final : public ColliderInterface> + { + public: + /// @param radius Sphere radius (must be > 0). + /// @param origin World-space centre of the sphere. + explicit PhysXSphereCollider(float radius, const VectorType& origin = {}) + : m_geometry(radius) + , m_origin(origin) + { + } + + /// Support function: returns the world-space point on the sphere furthest in @p direction. + /// For a sphere that is simply origin + normalize(direction) * radius. + [[nodiscard]] + VectorType find_abs_furthest_vertex_position(const VectorType& direction) const override + { + const float len = std::sqrt(direction.x * direction.x + + direction.y * direction.y + + direction.z * direction.z); + if (len == 0.f) + return m_origin; + + const float inv = m_geometry.radius / len; + return { + m_origin.x + direction.x * inv, + m_origin.y + direction.y * inv, + m_origin.z + direction.z * inv, + }; + } + + [[nodiscard]] + const VectorType& get_origin() const override { return m_origin; } + + void set_origin(const VectorType& new_origin) override { m_origin = new_origin; } + + [[nodiscard]] + const physx::PxSphereGeometry& get_geometry() const { return m_geometry; } + + [[nodiscard]] + float get_radius() const { return m_geometry.radius; } + + void set_radius(float radius) { m_geometry = physx::PxSphereGeometry(radius); } + + private: + physx::PxSphereGeometry m_geometry; + VectorType m_origin; + }; +} // namespace omath::collision + +#endif // OMATH_ENABLE_PHYSX diff --git a/tests/general/unit_test_physx_colliders.cpp b/tests/general/unit_test_physx_colliders.cpp new file mode 100644 index 0000000..5dd9f3d --- /dev/null +++ b/tests/general/unit_test_physx_colliders.cpp @@ -0,0 +1,247 @@ +// +// Created by orange-cpp +// +#ifdef OMATH_ENABLE_PHYSX + +#include +#include +#include +#include + +using namespace omath::collision; +using omath::Vector3; + +// ─── PhysXBoxCollider ──────────────────────────────────────────────────────── + +TEST(PhysXBoxCollider, DefaultOriginIsZero) +{ + PhysXBoxCollider box({1.f, 1.f, 1.f}); + EXPECT_EQ(box.get_origin(), Vector3(0.f, 0.f, 0.f)); +} + +TEST(PhysXBoxCollider, SetAndGetOrigin) +{ + PhysXBoxCollider box({1.f, 1.f, 1.f}, {3.f, 4.f, 5.f}); + EXPECT_EQ(box.get_origin(), Vector3(3.f, 4.f, 5.f)); + + box.set_origin({-1.f, 0.f, 2.f}); + EXPECT_EQ(box.get_origin(), Vector3(-1.f, 0.f, 2.f)); +} + +TEST(PhysXBoxCollider, FurthestPointPositiveDirection) +{ + // Box centred at origin with half-extents (2, 3, 4). + // Direction (+x, +y, +z) → furthest corner is (+2, +3, +4). + PhysXBoxCollider box({2.f, 3.f, 4.f}); + const auto p = box.find_abs_furthest_vertex_position({1.f, 1.f, 1.f}); + EXPECT_FLOAT_EQ(p.x, 2.f); + EXPECT_FLOAT_EQ(p.y, 3.f); + EXPECT_FLOAT_EQ(p.z, 4.f); +} + +TEST(PhysXBoxCollider, FurthestPointNegativeDirection) +{ + // Direction (-x, -y, -z) → furthest corner is (-2, -3, -4). + PhysXBoxCollider box({2.f, 3.f, 4.f}); + const auto p = box.find_abs_furthest_vertex_position({-1.f, -1.f, -1.f}); + EXPECT_FLOAT_EQ(p.x, -2.f); + EXPECT_FLOAT_EQ(p.y, -3.f); + EXPECT_FLOAT_EQ(p.z, -4.f); +} + +TEST(PhysXBoxCollider, FurthestPointMixedDirection) +{ + // Direction (+x, -y, +z) → furthest corner is (+2, -3, +4). + PhysXBoxCollider box({2.f, 3.f, 4.f}); + const auto p = box.find_abs_furthest_vertex_position({1.f, -1.f, 1.f}); + EXPECT_FLOAT_EQ(p.x, 2.f); + EXPECT_FLOAT_EQ(p.y, -3.f); + EXPECT_FLOAT_EQ(p.z, 4.f); +} + +TEST(PhysXBoxCollider, FurthestPointWithNonZeroOrigin) +{ + // Box at (10, 0, 0), half-extents (1, 1, 1). Direction +x → (11, 1, 1). + PhysXBoxCollider box({1.f, 1.f, 1.f}, {10.f, 0.f, 0.f}); + const auto p = box.find_abs_furthest_vertex_position({1.f, 1.f, 1.f}); + EXPECT_FLOAT_EQ(p.x, 11.f); + EXPECT_FLOAT_EQ(p.y, 1.f); + EXPECT_FLOAT_EQ(p.z, 1.f); +} + +TEST(PhysXBoxCollider, SetHalfExtentsUpdatesGeometry) +{ + PhysXBoxCollider box({1.f, 1.f, 1.f}); + box.set_half_extents({5.f, 6.f, 7.f}); + + const auto& he = box.get_geometry().halfExtents; + EXPECT_FLOAT_EQ(he.x, 5.f); + EXPECT_FLOAT_EQ(he.y, 6.f); + EXPECT_FLOAT_EQ(he.z, 7.f); + + // Furthest vertex must reflect the new extents. + const auto p = box.find_abs_furthest_vertex_position({1.f, 1.f, 1.f}); + EXPECT_FLOAT_EQ(p.x, 5.f); + EXPECT_FLOAT_EQ(p.y, 6.f); + EXPECT_FLOAT_EQ(p.z, 7.f); +} + +// ─── PhysXSphereCollider ───────────────────────────────────────────────────── + +TEST(PhysXSphereCollider, DefaultOriginIsZero) +{ + PhysXSphereCollider sphere(1.f); + EXPECT_EQ(sphere.get_origin(), Vector3(0.f, 0.f, 0.f)); +} + +TEST(PhysXSphereCollider, SetAndGetOrigin) +{ + PhysXSphereCollider sphere(1.f, {1.f, 2.f, 3.f}); + EXPECT_EQ(sphere.get_origin(), Vector3(1.f, 2.f, 3.f)); + + sphere.set_origin({-5.f, 0.f, 0.f}); + EXPECT_EQ(sphere.get_origin(), Vector3(-5.f, 0.f, 0.f)); +} + +TEST(PhysXSphereCollider, FurthestPointAlongPureXAxis) +{ + // Direction (1,0,0), radius 3 → furthest point is (3, 0, 0). + PhysXSphereCollider sphere(3.f); + const auto p = sphere.find_abs_furthest_vertex_position({1.f, 0.f, 0.f}); + EXPECT_FLOAT_EQ(p.x, 3.f); + EXPECT_FLOAT_EQ(p.y, 0.f); + EXPECT_FLOAT_EQ(p.z, 0.f); +} + +TEST(PhysXSphereCollider, FurthestPointAlongDiagonal) +{ + // Direction (1,1,0), radius 1 → furthest point at distance 1 from origin. + PhysXSphereCollider sphere(1.f); + const auto p = sphere.find_abs_furthest_vertex_position({1.f, 1.f, 0.f}); + const float dist = std::sqrt(p.x * p.x + p.y * p.y + p.z * p.z); + EXPECT_NEAR(dist, 1.f, 1e-5f); +} + +TEST(PhysXSphereCollider, FurthestPointWithNonZeroOrigin) +{ + // Sphere at (5, 0, 0), radius 2. Direction +x → (7, 0, 0). + PhysXSphereCollider sphere(2.f, {5.f, 0.f, 0.f}); + const auto p = sphere.find_abs_furthest_vertex_position({1.f, 0.f, 0.f}); + EXPECT_FLOAT_EQ(p.x, 7.f); + EXPECT_FLOAT_EQ(p.y, 0.f); + EXPECT_FLOAT_EQ(p.z, 0.f); +} + +TEST(PhysXSphereCollider, ZeroDirectionReturnsOrigin) +{ + PhysXSphereCollider sphere(5.f, {1.f, 2.f, 3.f}); + const auto p = sphere.find_abs_furthest_vertex_position({0.f, 0.f, 0.f}); + EXPECT_EQ(p, sphere.get_origin()); +} + +TEST(PhysXSphereCollider, SetRadiusUpdatesGeometry) +{ + PhysXSphereCollider sphere(1.f); + sphere.set_radius(10.f); + EXPECT_FLOAT_EQ(sphere.get_radius(), 10.f); + + // Furthest point along +x should now be at x = 10. + const auto p = sphere.find_abs_furthest_vertex_position({1.f, 0.f, 0.f}); + EXPECT_FLOAT_EQ(p.x, 10.f); +} + +// ─── GJK: Box vs Box ───────────────────────────────────────────────────────── + +using GjkBox = omath::collision::GjkAlgorithm; +using GjkSphere = omath::collision::GjkAlgorithm; + +TEST(PhysXBoxGjk, CollidingOverlap) +{ + // Two unit boxes: A at origin, B shifted by 0.5 — clearly overlapping. + const PhysXBoxCollider a({1.f, 1.f, 1.f}); + const PhysXBoxCollider b({1.f, 1.f, 1.f}, {0.5f, 0.f, 0.f}); + EXPECT_TRUE(GjkBox::is_collide(a, b)); +} + +TEST(PhysXBoxGjk, CollidingTouching) +{ + // Boxes exactly touching on the +X face: A[-1,1] and B[1,3] along X. + const PhysXBoxCollider a({1.f, 1.f, 1.f}); + const PhysXBoxCollider b({1.f, 1.f, 1.f}, {2.f, 0.f, 0.f}); + EXPECT_TRUE(GjkBox::is_collide(a, b)); +} + +TEST(PhysXBoxGjk, NotCollidingSeparated) +{ + // Boxes separated by a gap: A[-1,1] and B[3,5] along X. + const PhysXBoxCollider a({1.f, 1.f, 1.f}); + const PhysXBoxCollider b({1.f, 1.f, 1.f}, {4.f, 0.f, 0.f}); + EXPECT_FALSE(GjkBox::is_collide(a, b)); +} + +TEST(PhysXBoxGjk, CollidingSameOrigin) +{ + // Same position — fully overlapping. + const PhysXBoxCollider a({1.f, 1.f, 1.f}); + const PhysXBoxCollider b({1.f, 1.f, 1.f}); + EXPECT_TRUE(GjkBox::is_collide(a, b)); +} + +TEST(PhysXBoxGjk, NotCollidingDiagonalSeparation) +{ + // Boxes separated along a diagonal so no axis-aligned faces overlap. + const PhysXBoxCollider a({1.f, 1.f, 1.f}); + const PhysXBoxCollider b({1.f, 1.f, 1.f}, {3.f, 3.f, 3.f}); + EXPECT_FALSE(GjkBox::is_collide(a, b)); +} + +TEST(PhysXBoxGjk, DifferentSizesColliding) +{ + // Large box vs small box inside it. + const PhysXBoxCollider large({5.f, 5.f, 5.f}); + const PhysXBoxCollider small_box({1.f, 1.f, 1.f}, {2.f, 0.f, 0.f}); + EXPECT_TRUE(GjkBox::is_collide(large, small_box)); +} + +// ─── GJK: Sphere vs Sphere ─────────────────────────────────────────────────── + +TEST(PhysXSphereGjk, CollidingOverlap) +{ + // Radii 1 each, centres 1 apart — overlapping. + const PhysXSphereCollider a(1.f); + const PhysXSphereCollider b(1.f, {1.f, 0.f, 0.f}); + EXPECT_TRUE(GjkSphere::is_collide(a, b)); +} + +TEST(PhysXSphereGjk, CollidingSameOrigin) +{ + const PhysXSphereCollider a(1.f); + const PhysXSphereCollider b(1.f); + EXPECT_TRUE(GjkSphere::is_collide(a, b)); +} + +TEST(PhysXSphereGjk, NotCollidingSeparated) +{ + // Radii 1 each, centres 3 apart — gap of 1. + const PhysXSphereCollider a(1.f); + const PhysXSphereCollider b(1.f, {3.f, 0.f, 0.f}); + EXPECT_FALSE(GjkSphere::is_collide(a, b)); +} + +TEST(PhysXSphereGjk, DifferentRadiiColliding) +{ + // r=2 and r=1, centres 2.5 apart — still overlapping. + const PhysXSphereCollider a(2.f); + const PhysXSphereCollider b(1.f, {2.5f, 0.f, 0.f}); + EXPECT_TRUE(GjkSphere::is_collide(a, b)); +} + +TEST(PhysXSphereGjk, DifferentRadiiNotColliding) +{ + // r=1 and r=1, centres 5 apart — separated. + const PhysXSphereCollider a(1.f); + const PhysXSphereCollider b(1.f, {5.f, 0.f, 0.f}); + EXPECT_FALSE(GjkSphere::is_collide(a, b)); +} + +#endif // OMATH_ENABLE_PHYSX diff --git a/vcpkg-configuration.json b/vcpkg-configuration.json index f14bf6b..b726896 100644 --- a/vcpkg-configuration.json +++ b/vcpkg-configuration.json @@ -1,7 +1,7 @@ { "default-registry": { "kind": "git", - "baseline": "b1b19307e2d2ec1eefbdb7ea069de7d4bcd31f01", + "baseline": "efa4634bd526b87559684607d2cbbdeeec0f07d8", "repository": "https://github.com/microsoft/vcpkg" }, "registries": [ diff --git a/vcpkg.json b/vcpkg.json index 52c1856..363c929 100644 --- a/vcpkg.json +++ b/vcpkg.json @@ -52,6 +52,13 @@ "lua", "sol2" ] + }, + "physx": { + "description": "PhysX-backed collider implementations", + "dependencies": [ + "physx" + ], + "supports": "(windows & x64 & !mingw & !uwp) | (linux & x64) | (linux & arm64)" } } }