Merge pull request #226 from jMonkeyEngine/pr/223

Obsolete shadowRecv and sceneReceivers code cleanup

jme3-core/src/main/java/com/jme3/renderer/queue/RenderQueue.java

@@ -50,7 +50,6 @@ public class RenderQueue {
     private GeometryList transparentList;
     private GeometryList translucentList;
     private GeometryList skyList;
-    private GeometryList shadowRecv;
 
     /**
      * Creates a new RenderQueue, the default {@link GeometryComparator comparators}
@@ -62,7 +61,6 @@ public class RenderQueue {
         this.transparentList = new GeometryList(new TransparentComparator());
         this.translucentList = new GeometryList(new TransparentComparator());
         this.skyList = new GeometryList(new NullComparator());
-        this.shadowRecv = new GeometryList(new OpaqueComparator());
     }
 
     /**
@@ -259,21 +257,6 @@ public class RenderQueue {
         }
     }
 
-    /**
-     * 
-     * @param shadBucket The shadow mode to retrieve the {@link GeometryList
-     * queue content} for.  Only {@link ShadowMode#Receive Receive} is valid.
-     * @return The cast or receive {@link GeometryList}
-     */
-    public GeometryList getShadowQueueContent(ShadowMode shadBucket) {
-        switch (shadBucket) {
-            case Receive:
-                return shadowRecv;
-            default:
-                throw new IllegalArgumentException("Only Cast or Receive are allowed");
-        }
-    }
-
     private void renderGeometryList(GeometryList list, RenderManager rm, Camera cam, boolean clear) {
         list.setCamera(cam); // select camera for sorting
         list.sort();
@@ -342,6 +325,5 @@ public class RenderQueue {
         transparentList.clear();
         translucentList.clear();
         skyList.clear();
-        shadowRecv.clear();
     }
 }

jme3-core/src/main/java/com/jme3/shadow/AbstractShadowFilter.java

@@ -206,24 +206,18 @@ public abstract class AbstractShadowFilter<T extends AbstractShadowRenderer> ext
     }
 
     /**
-     * returns true if the PssmRenderer flushed the shadow queues
+     * isFlushQueues does nothing and is kept only for backward compatibility
-     *
-     * @return flushQueues
      */
+    @Deprecated
     public boolean isFlushQueues() {
         return shadowRenderer.isFlushQueues();
     }
 
     /**
-     * Set this to false if you want to use several PssmRederers to have
+     * setFlushQueues does nothing now and is kept only for backward compatibility
-     * multiple shadows cast by multiple light sources. Make sure the last
-     * PssmRenderer in the stack DO flush the queues, but not the others
-     *
-     * @param flushQueues
      */
-    public void setFlushQueues(boolean flushQueues) {
+    @Deprecated
-        shadowRenderer.setFlushQueues(flushQueues);
+    public void setFlushQueues(boolean flushQueues) {}
-    }
 
     /**
      * sets the shadow compare mode see {@link CompareMode} for more info

jme3-core/src/main/java/com/jme3/shadow/AbstractShadowRenderer.java

@@ -92,7 +92,6 @@ public abstract class AbstractShadowRenderer implements SceneProcessor, Savable
     protected EdgeFilteringMode edgeFilteringMode = EdgeFilteringMode.Bilinear;
     protected CompareMode shadowCompareMode = CompareMode.Hardware;
     protected Picture[] dispPic;
-    protected boolean flushQueues = true;
     /**
      * true if the fallback material should be used, otherwise false
      */
@@ -105,7 +104,6 @@ public abstract class AbstractShadowRenderer implements SceneProcessor, Savable
      * list of materials for post shadow queue geometries
      */
     protected List<Material> matCache = new ArrayList<Material>();
-    protected GeometryList sceneReceivers;
     protected GeometryList lightReceivers = new GeometryList(new OpaqueComparator());
     protected GeometryList shadowMapOccluders = new GeometryList(new OpaqueComparator());
     private String[] shadowMapStringCache;
@@ -385,7 +383,6 @@ public abstract class AbstractShadowRenderer implements SceneProcessor, Savable
 
     @SuppressWarnings("fallthrough")
     public void postQueue(RenderQueue rq) {
-        sceneReceivers = rq.getShadowQueueContent(ShadowMode.Receive);
         lightReceivers.clear();
         skipPostPass = false;
         if ( !checkCulling(viewPort.getCamera()) ) {
@@ -462,7 +459,7 @@ public abstract class AbstractShadowRenderer implements SceneProcessor, Savable
         debug = true;
     }
 
-    abstract GeometryList getReceivers(GeometryList sceneReceivers, GeometryList lightReceivers);
+    abstract void getReceivers(GeometryList lightReceivers);
 
     public void postFrame(FrameBuffer out) {
         if (skipPostPass) {
@@ -472,7 +469,7 @@ public abstract class AbstractShadowRenderer implements SceneProcessor, Savable
             displayShadowMap(renderManager.getRenderer());
         }
         
-        lightReceivers = getReceivers(sceneReceivers, lightReceivers);
+        getReceivers(lightReceivers);
 
         if (lightReceivers.size() != 0) {
             //setting params to recieving geometry list
@@ -498,10 +495,6 @@ public abstract class AbstractShadowRenderer implements SceneProcessor, Savable
             //clearing the params in case there are some other shadow renderers
             clearMatParams();
         }
-
-        if (flushQueues) {
-            sceneReceivers.clear();
-        }
     }
     
     /**
@@ -726,24 +719,16 @@ public abstract class AbstractShadowRenderer implements SceneProcessor, Savable
     }
 
     /**
-     * Returns true if this shadow renderer flushes the shadow queues.
+     *  isFlushQueues does nothing now and is kept only for backward compatibility
-     *
-     * @return flushQueues
      */
-    public boolean isFlushQueues() {
+    @Deprecated
-        return flushQueues;
+    public boolean isFlushQueues() { return false; }
-    }
 
     /**
-     * Set flushQueues to false if you have multiple shadow renderers, in order
+     * setFlushQueues does nothing now and is kept only for backward compatibility
-     * for multiple light sources to cast shadows. Make sure the last shadow
-     * renderer in the stack DOES flush the queues, but not the others.
-     *
-     * @param flushQueues
      */
-    public void setFlushQueues(boolean flushQueues) {
+    @Deprecated
-        this.flushQueues = flushQueues;
+    public void setFlushQueues(boolean flushQueues) {}
-    }
 
     /**
      * De-serialize this instance, for example when loading from a J3O file.
@@ -758,7 +743,6 @@ public abstract class AbstractShadowRenderer implements SceneProcessor, Savable
         shadowIntensity = ic.readFloat("shadowIntensity", 0.7f);
         edgeFilteringMode = ic.readEnum("edgeFilteringMode", EdgeFilteringMode.class, EdgeFilteringMode.Bilinear);
         shadowCompareMode = ic.readEnum("shadowCompareMode", CompareMode.class, CompareMode.Hardware);
-        flushQueues = ic.readBoolean("flushQueues", false);
         init(assetManager, nbShadowMaps, (int) shadowMapSize);
         edgesThickness = ic.readFloat("edgesThickness", 1.0f);
         postshadowMat.setFloat("PCFEdge", edgesThickness);
@@ -777,7 +761,6 @@ public abstract class AbstractShadowRenderer implements SceneProcessor, Savable
         oc.write(shadowIntensity, "shadowIntensity", 0.7f);
         oc.write(edgeFilteringMode, "edgeFilteringMode", EdgeFilteringMode.Bilinear);
         oc.write(shadowCompareMode, "shadowCompareMode", CompareMode.Hardware);
-        oc.write(flushQueues, "flushQueues", false);
         oc.write(edgesThickness, "edgesThickness", 1.0f);
     }
 }

jme3-core/src/main/java/com/jme3/shadow/DirectionalLightShadowRenderer.java

@@ -181,25 +181,23 @@ public class DirectionalLightShadowRenderer extends AbstractShadowRenderer {
         ShadowUtil.updateFrustumPoints(viewPort.getCamera(), splitsArray[shadowMapIndex], splitsArray[shadowMapIndex + 1], 1.0f, points);
 
         //Updating shadow cam with curent split frustra
-        if (sceneReceivers.size()==0) {
+        if (lightReceivers.size()==0) {
             for (Spatial scene : viewPort.getScenes()) {
-              ShadowUtil.getGeometriesInCamFrustum(scene, viewPort.getCamera(), RenderQueue.ShadowMode.Receive, sceneReceivers);
+              ShadowUtil.getGeometriesInCamFrustum(scene, viewPort.getCamera(), RenderQueue.ShadowMode.Receive, lightReceivers);
             }
         }
-        ShadowUtil.updateShadowCamera(viewPort, sceneReceivers, shadowCam, points, shadowMapOccluders, stabilize?shadowMapSize:0);
+        ShadowUtil.updateShadowCamera(viewPort, lightReceivers, shadowCam, points, shadowMapOccluders, stabilize?shadowMapSize:0);
 
         return shadowMapOccluders;
     }
 
     @Override
-    GeometryList getReceivers(GeometryList sceneReceivers, GeometryList lightReceivers) {
+    void getReceivers(GeometryList lightReceivers) {
-        if (sceneReceivers.size()==0) {
+        if (lightReceivers.size()==0) {
             for (Spatial scene : viewPort.getScenes()) {
-                ShadowUtil.getGeometriesInCamFrustum(scene, viewPort.getCamera(), RenderQueue.ShadowMode.Receive, sceneReceivers);
+                ShadowUtil.getGeometriesInCamFrustum(scene, viewPort.getCamera(), RenderQueue.ShadowMode.Receive, lightReceivers);
             }
         }
-        lightReceivers = sceneReceivers;
-        return sceneReceivers;
     }
 
     @Override

jme3-core/src/main/java/com/jme3/shadow/PointLightShadowRenderer.java

@@ -139,12 +139,11 @@ public class PointLightShadowRenderer extends AbstractShadowRenderer {
     }
 
     @Override
-    GeometryList getReceivers(GeometryList sceneReceivers, GeometryList lightReceivers) {
+    void getReceivers(GeometryList lightReceivers) {
         lightReceivers.clear();
         for (Spatial scene : viewPort.getScenes()) {
             ShadowUtil.getLitGeometriesInViewPort(scene, viewPort.getCamera(), shadowCams, RenderQueue.ShadowMode.Receive, lightReceivers);
         }
-        return lightReceivers;
     }
 
     @Override

jme3-core/src/main/java/com/jme3/shadow/SpotLightShadowRenderer.java

@@ -151,14 +151,13 @@ public class SpotLightShadowRenderer extends AbstractShadowRenderer {
     }
 
     @Override
-    GeometryList getReceivers(GeometryList sceneReceivers, GeometryList lightReceivers) {
+    void  getReceivers(GeometryList lightReceivers) {
         lightReceivers.clear();
         Camera[] cameras = new Camera[1];
         cameras[0] = shadowCam;
         for (Spatial scene : viewPort.getScenes()) {
             ShadowUtil.getLitGeometriesInViewPort(scene, viewPort.getCamera(), cameras, RenderQueue.ShadowMode.Receive, lightReceivers);
         }
-        return lightReceivers;
     }
     
     @Override

jme3-examples/src/main/java/jme3test/light/TestPointDirectionalAndSpotLightShadows.java

@@ -149,12 +149,6 @@ public class TestPointDirectionalAndSpotLightShadows extends SimpleApplication {
         
         
         
-        slsr.setFlushQueues(false);
-        plsr.setFlushQueues(false);
-        dlsr.setFlushQueues(true);
-        slsf.setFlushQueues(false);
-        plsf.setFlushQueues(false);
-        dlsf.setFlushQueues(true);
         if (!useFilter)viewPort.addProcessor(slsr);
         if (!useFilter)viewPort.addProcessor(plsr);
         if (!useFilter)viewPort.addProcessor(dlsr);