CollisionSpace: add 2 public methods to manage overlap filtering

Author: stephengold

LICENSE

@@ -7,7 +7,7 @@ is Copyright (c) 2011 Khaled Mamou (kmamou at gmail dot com)
 All rights reserved.
 
 The buildSrc, src/main/java/jme3utilities, and src/test software
-are Copyright (c) 2013-2025 Stephen Gold
+are Copyright (c) 2013-2026 Stephen Gold
 All rights reserved.
 
 The src/main/java/vhacd and src/main/java/vhacd4 software

src/main/java/com/jme3/bullet/CollisionSpace.java

@@ -452,6 +452,18 @@ public boolean isForceUpdateAllAabbs() {
         return isForceUpdateAllAabbs(spaceId);
     }
 
+    /**
+     * Test whether the {@code needsCollision()} callback is enabled.
+     *
+     * @return true if it's enabled, otherwise false
+     */
+    public boolean isOverlapFilterEnabled() {
+        long spaceId = nativeId();
+        boolean result = isOverlapFilterEnabled(spaceId);
+
+        return result;
+    }
+
     /**
      * Test whether the "deterministic overlapping pairs" option is enabled in
      * the collision dispatcher (native field: m_deterministicOverlappingPairs).
@@ -668,6 +680,17 @@ public static void setLocalThreadPhysicsSpace(CollisionSpace space) {
         physicsSpaceTL.set(space);
     }
 
+    /**
+     * Alter whether the {@code needsCollision()} callback is enabled.
+     *
+     * @param enable true to enable the callback, or false to skip it
+     * (default=true)
+     */
+    public void setOverlapFilterEnabled(boolean enable) {
+        long spaceId = nativeId();
+        setOverlapFilterEnabled(spaceId, enable);
+    }
+
     /**
      * Alter the flags used in ray tests (native field: m_flags).
      *
@@ -858,6 +881,8 @@ native private long createCollisionSpace(
 
     native private static boolean isForceUpdateAllAabbs(long spaceId);
 
+    native private static boolean isOverlapFilterEnabled(long spaceId);
+
     native private static int pairTest(long spaceId, long aId, long bId,
             PhysicsCollisionListener listener);
 
@@ -874,6 +899,9 @@ native private static void rayTestNativeDp(
     native private static void setDeterministicOverlappingPairs(
             long spaceId, boolean desiredSetting);
 
+    native private static void setOverlapFilterEnabled(
+            long spaceId, boolean enable);
+
     native private static void
             setForceUpdateAllAabbs(long spaceId, boolean desiredSetting);
 

src/main/native/glue/com_jme3_bullet_CollisionSpace.cpp

@@ -299,6 +299,30 @@ JNIEXPORT jboolean JNICALL Java_com_jme3_bullet_CollisionSpace_isForceUpdateAllA
     return pWorld->getForceUpdateAllAabbs();
 }
 
+/*
+ * Class:     com_jme3_bullet_CollisionSpace
+ * Method:    isOverlapFilterEnabled
+ * Signature: (J)Z
+ */
+JNIEXPORT jboolean JNICALL Java_com_jme3_bullet_CollisionSpace_isOverlapFilterEnabled
+  (JNIEnv *pEnv, jclass, jlong spaceId) {
+    jmeCollisionSpace * const
+            pSpace = reinterpret_cast<jmeCollisionSpace *> (spaceId);
+    NULL_CHK(pEnv, pSpace, "The collision space does not exist.", JNI_FALSE);
+    btCollisionWorld * const pWorld = pSpace->getCollisionWorld();
+    NULL_CHK(pEnv, pWorld, "The collision world does not exist.", JNI_FALSE)
+    btOverlappingPairCache * const pPairCache = pWorld->getPairCache();
+    NULL_CHK(pEnv, pPairCache, "The pair cache does not exist.", JNI_FALSE)
+
+    const btOverlapFilterCallback *
+            pOFCallback = pPairCache->getOverlapFilterCallback();
+    if (pOFCallback) {
+        return JNI_TRUE;
+    } else {
+        return JNI_FALSE;
+    }
+}
+
 /*
  * Class:     com_jme3_bullet_CollisionSpace
  * Method:    pairTest
@@ -486,6 +510,30 @@ JNIEXPORT void JNICALL Java_com_jme3_bullet_CollisionSpace_setDeterministicOverl
     dispatchInfo.m_deterministicOverlappingPairs = (bool)desiredSetting;
 }
 
+/*
+ * Class:     com_jme3_bullet_CollisionSpace
+ * Method:    setOverlapFilterEnabled
+ * Signature: (JZ)V
+ */
+JNIEXPORT void JNICALL Java_com_jme3_bullet_CollisionSpace_setOverlapFilterEnabled
+  (JNIEnv *pEnv, jclass, jlong spaceId, jboolean enable) {
+    jmeCollisionSpace * const
+            pSpace = reinterpret_cast<jmeCollisionSpace *> (spaceId);
+    NULL_CHK(pEnv, pSpace, "The collision space does not exist.",);
+    btCollisionWorld * const pWorld = pSpace->getCollisionWorld();
+    NULL_CHK(pEnv, pWorld, "The collision world does not exist.",)
+    btOverlappingPairCache * const pPairCache = pWorld->getPairCache();
+    NULL_CHK(pEnv, pPairCache, "The pair cache does not exist.",)
+
+    btOverlapFilterCallback *
+            pOFCallback = pPairCache->getOverlapFilterCallback();
+    if (pOFCallback) {
+        delete pOFCallback; //dance011
+    }
+    pOFCallback = enable ? new jmeFilterCallback() : NULL;
+    pPairCache->setOverlapFilterCallback(pOFCallback); //dance011
+}
+
 /*
  * Class:     com_jme3_bullet_CollisionSpace
  * Method:    setForceUpdateAllAabbs

src/main/native/glue/com_jme3_bullet_CollisionSpace.h

@@ -1,5 +1,5 @@
 /*
- Copyright (c) 2020-2025 Stephen Gold
+ Copyright (c) 2020-2026 Stephen Gold
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
@@ -2150,6 +2150,7 @@ private static void verifyCollisionSpaceDefaults(CollisionSpace space) {
         Assert.assertEquals(
                 RayTestFlag.SubSimplexRaytest, space.getRayTestFlags());
         Assert.assertTrue(space.isForceUpdateAllAabbs());
+        Assert.assertTrue(space.isOverlapFilterEnabled());
         Assert.assertFalse(space.isUsingDeterministicDispatch());
     }