Version 0.5.6

Author: bitbrain

CHANGELOG.md

@@ -1,3 +1,7 @@
+# Version 0.5.6
+
+* [[#190](https://github.com/bitbrain/braingdx/issues/190)] fix a crash due to box2dlights ray handler not being disposed
+
 # Version 0.5.5
 
 * [[#187](https://github.com/bitbrain/braingdx/issues/187)] do not create frame buffers when no shaders are being used

core/src/main/java/de/bitbrain/braingdx/GameContext2DImpl.java

@@ -209,6 +209,7 @@ public void dispose() {
       renderManager.dispose();
       eventManager.clear();
       physicsManager.dispose();
+      lightingManager.dispose();
    }
 
    @Override

core/src/main/java/de/bitbrain/braingdx/graphics/lighting/LightingManager.java

@@ -19,10 +19,12 @@
 import aurelienribon.tweenengine.TweenCallback;
 import aurelienribon.tweenengine.TweenEquation;
 import box2dLight.*;
+import com.badlogic.gdx.Gdx;
 import com.badlogic.gdx.graphics.Color;
 import com.badlogic.gdx.graphics.OrthographicCamera;
 import com.badlogic.gdx.graphics.g2d.Batch;
 import com.badlogic.gdx.math.Vector2;
+import com.badlogic.gdx.utils.Disposable;
 import de.bitbrain.braingdx.tweens.ColorTween;
 import de.bitbrain.braingdx.tweens.SharedTweenManager;
 
@@ -35,7 +37,7 @@
  * @author Miguel Gonzalez Sanchez
  * @version 1.0.0
  */
-public class LightingManager {
+public class LightingManager implements Disposable {
 
    private static final int DEFAULT_RAYS = 80;
    private final RayHandler handler;
@@ -48,6 +50,8 @@ public class LightingManager {
    private Color ambientLightColor = Color.WHITE.cpy();
    private int rays;
 
+   private boolean disposed = false;
+
    public LightingManager(RayHandler rayHandler, OrthographicCamera camera) {
       this(rayHandler, camera, new LightFactory() {
 
@@ -154,40 +158,52 @@ public ConeLight addConeLight(String id, float x, float y, float distance, float
       return light;
    }
 
-   public boolean removePointLight(String id) {
-      PointLight light = pointLights.remove(id);
-      if (light != null) {
-         light.remove();
-         return true;
-      }
-      return false;
+   public void removePointLight(final String id) {
+      Gdx.app.postRunnable(new Runnable() {
+         @Override
+         public void run() {
+            PointLight light = pointLights.remove(id);
+            if (light != null) {
+               light.remove();
+            }
+         }
+      });
    }
 
-   public boolean removeDirectionalLight(String id) {
-      DirectionalLight light = dirLights.remove(id);
-      if (light != null) {
-         light.remove();
-         return true;
-      }
-      return false;
+   public void removeDirectionalLight(final String id) {
+      Gdx.app.postRunnable(new Runnable() {
+         @Override
+         public void run() {
+            DirectionalLight light = dirLights.remove(id);
+            if (light != null) {
+               light.remove();
+            }
+         }
+      });
    }
 
-   public boolean removeChainLight(String id) {
-      ChainLight light = chainLights.remove(id);
-      if (light != null) {
-         light.remove();
-         return true;
-      }
-      return false;
+   public void removeChainLight(final String id) {
+      Gdx.app.postRunnable(new Runnable() {
+         @Override
+         public void run() {
+            ChainLight light = chainLights.remove(id);
+            if (light != null) {
+               light.remove();
+            }
+         }
+      });
    }
 
-   public boolean removeConeLight(String id) {
-      ConeLight light = coneLights.remove(id);
-      if (light != null) {
-         light.remove();
-         return true;
-      }
-      return false;
+   public void removeConeLight(final String id) {
+      Gdx.app.postRunnable(new Runnable() {
+         @Override
+         public void run() {
+            ConeLight light = coneLights.remove(id);
+            if (light != null) {
+               light.remove();
+            }
+         }
+      });
    }
 
    public void clear() {
@@ -198,11 +214,17 @@ public void clear() {
       handler.removeAll();
    }
 
-   void render(Batch batch, float delta) {
+   void render() {
+      if (disposed) {
+         return;
+      }
       handler.renderOnly();
    }
 
    void beforeRender() {
+      if (disposed) {
+         return;
+      }
       handler.setAmbientLight(ambientLightColor);
       handler.setCombinedMatrix(camera);
       handler.update();
@@ -213,6 +235,14 @@ void resize(int width, int height) {
       handler.resizeFBO(width, height);
    }
 
+   @Override
+   public void dispose() {
+      if (!disposed) {
+         handler.dispose();
+         disposed = true;
+      }
+   }
+
    public static interface LightFactory {
       PointLight newPointLight(RayHandler handler, int rays, Color color, float distance, float x, float y);
 

core/src/main/java/de/bitbrain/braingdx/graphics/lighting/LightingManagerRenderLayer.java

@@ -19,7 +19,7 @@ public void beforeRender() {
 
    @Override
    public void render(Batch batch, float delta) {
-      manager.render(batch, delta);
+      manager.render();
    }
 
    @Override

core/src/test/java/de/bitbrain/braingdx/graphics/lighting/LightingManagerTest.java

@@ -2,6 +2,8 @@
 
 import box2dLight.PointLight;
 import box2dLight.RayHandler;
+import com.badlogic.gdx.Application;
+import com.badlogic.gdx.Gdx;
 import com.badlogic.gdx.graphics.Color;
 import com.badlogic.gdx.graphics.OrthographicCamera;
 import com.badlogic.gdx.math.Vector2;
@@ -11,13 +13,14 @@
 import org.junit.runner.RunWith;
 import org.mockito.InjectMocks;
 import org.mockito.Mock;
+import org.mockito.invocation.InvocationOnMock;
 import org.mockito.runners.MockitoJUnitRunner;
+import org.mockito.stubbing.Answer;
 
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 import static org.mockito.Matchers.*;
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.when;
+import static org.mockito.Mockito.*;
 
 @RunWith(MockitoJUnitRunner.class)
 public class LightingManagerTest {
@@ -26,31 +29,41 @@ public class LightingManagerTest {
    private RayHandler rayHandler;
 
    @Mock
-   private OrthographicCamera camera;
+   private LightFactory lightFactory;
 
    @Mock
-   private LightFactory lightFactory;
+   PointLight pointLightMock;
 
    @InjectMocks
    private LightingManager lightingManager;
 
    @Before
    public void beforeTest() {
-      PointLight pointLightMock = mock(PointLight.class);
       when(lightFactory.newPointLight(any(RayHandler.class), anyInt(), any(Color.class), anyFloat(), anyFloat(), anyFloat())).thenReturn(pointLightMock);
+      Application mockApp = mock(Application.class);
+      Gdx.app = mockApp;
+      doAnswer(new Answer<Void>() {
+         @Override
+         public Void answer(InvocationOnMock invocation) {
+            ((Runnable)invocation.getArguments()[0]).run();
+            return null;
+         }
+      }).when(mockApp).postRunnable(any(Runnable.class));
    }
 
    @Test
    public void testRemoveLight_Point() {
       lightingManager.addPointLight("pointlight", new Vector2(), 0f, Color.WHITE);
-      assertTrue(lightingManager.removePointLight("pointlight"));
+      lightingManager.removePointLight("pointlight");
+      verify(pointLightMock, times(1)).remove();
    }
 
    @Test
    public void testClear() {
       lightingManager.addPointLight("", new Vector2(), 0f, Color.WHITE);
       lightingManager.clear();
-      assertFalse(lightingManager.removePointLight("pointlight"));
+      lightingManager.removePointLight("pointlight");
+      verify(pointLightMock, never()).remove();
    }
 
 }