Add support for global lights (#2548)

* add support for global lights

* set refresh flag before light is removed

* optimize global lights refresh by following only paths with RF_GLOBAL_LIGHTS flag

* fix global lights refresh flag propagation

* fix global lights refresh flag propagation

* Apply suggestion from @gemini-code-assist[bot]

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* Apply suggestion from @gemini-code-assist[bot]

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* Apply suggestion from @gemini-code-assist[bot]

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* fix

* Update jme3-core/src/main/java/com/jme3/light/SpotLight.java

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Author: riccardobl

jme3-core/src/main/java/com/jme3/light/DirectionalLight.java

@@ -59,16 +59,39 @@ public class DirectionalLight extends Light {
      * Creates a DirectionalLight
      */
     public DirectionalLight() {
+        super();
+    }
+
+    /**
+     * Creates a DirectionalLight
+     * @param global if true, the light affects the entire tree from the root node,
+     * otherwise it only affects the children of the node in which it is attached.     
+     */
+    public DirectionalLight(boolean global) {
+        this();
+        this.global = global;
     }
 
     /**
      * Creates a DirectionalLight with the given direction
      * @param direction the light's direction
      */
     public DirectionalLight(Vector3f direction) {
+        super();
         setDirection(direction);
     }
 
+    /**
+     * Creates a DirectionalLight with the given direction
+     * @param direction the light's direction
+     * @param global if true, the light affects the entire tree from the root node,
+     * otherwise it only affects the children of the node in which it is attached.
+     */
+    public DirectionalLight(Vector3f direction, boolean global) {
+        this(direction);
+        this.global = global;
+    }
+
     /**
      * Creates a DirectionalLight with the given direction and the given color
      * @param direction the light's direction
@@ -79,6 +102,19 @@ public DirectionalLight(Vector3f direction, ColorRGBA color) {
         setDirection(direction);
     }
 
+    /**
+     * Creates a DirectionalLight with the given direction and the given color
+     * @param direction the light's direction
+     * @param color the light's color
+     * @param global if true, the light affects the entire tree from the root node,
+     * otherwise it only affects the children of the node in which it is attached.
+     */
+    public DirectionalLight(Vector3f direction, ColorRGBA color, boolean global) {
+        this(direction, color);
+        this.global = global;
+    }
+
+
     @Override
     public void computeLastDistance(Spatial owner) {
         // directional lights are after ambient lights

jme3-core/src/main/java/com/jme3/light/Light.java

@@ -116,17 +116,39 @@ public int getId(){
      * The light name. 
      */
     protected String name;
+    protected boolean global = false;
 
     boolean frustumCheckNeeded = true;
     boolean intersectsFrustum  = false;
 
     protected Light() {
     }
 
+
+    protected Light(boolean global) {
+        this.global = global;
+    }
+    
+    protected Light(ColorRGBA color, boolean global) {
+        setColor(color);
+        this.global = global;
+    }
+
     protected Light(ColorRGBA color) {
         setColor(color);
     }
 
+
+    /**
+     * Returns true if this light affects the entire tree from the root node,
+     * otherwise returns false, meaning it only affects the children of the node
+     * in which it is attached.
+     * @return true if the light is global, otherwise false.
+     */
+    public boolean isGlobal() {
+        return global;
+    }
+
     /**
      * Returns the color of the light.
      * 
@@ -265,6 +287,7 @@ public void write(JmeExporter ex) throws IOException {
         oc.write(color, "color", null);
         oc.write(enabled, "enabled", true);
         oc.write(name, "name", null);
+        oc.write(global, "global", false);
     }
 
     @Override
@@ -273,6 +296,7 @@ public void read(JmeImporter im) throws IOException {
         color = (ColorRGBA) ic.readSavable("color", null);
         enabled = ic.readBoolean("enabled", true);
         name = ic.readString("name", null);
+        global = ic.readBoolean("global", false);
     }
 
     /**

jme3-core/src/main/java/com/jme3/light/LightList.java

@@ -38,6 +38,7 @@
 import com.jme3.util.SortUtil;
 import java.io.IOException;
 import java.util.*;
+import java.util.function.Predicate;
 
 /**
  * <code>LightList</code> is used internally by {@link Spatial}s to manage
@@ -230,37 +231,53 @@ public void sort(boolean transformChanged) {
      * @param parent the parent's world-space LightList
      */
     public void update(LightList local, LightList parent) {
+        update(local, parent, null);
+    }
+
+
+    /**
+     * Updates a "world-space" light list, using the spatial's local-space
+     * light list, its parent's world-space light list and an optional filter.
+     *
+     * @param local the local-space LightList (not null)
+     * @param parent the parent's world-space LightList
+     * @param filter an optional filter to apply to the lights
+     *               (null means no filtering)
+     */
+    public void update(LightList local, LightList parent, Predicate<Light> filter) {
         // clear the list as it will be reconstructed
         // using the arguments
         clear();
 
         while (list.length <= local.listSize) {
             doubleSize();
         }
-
-        // add the lights from the local list
-        System.arraycopy(local.list, 0, list, 0, local.listSize);
-        for (int i = 0; i < local.listSize; i++) {
-//            list[i] = local.list[i];
-            distToOwner[i] = Float.NEGATIVE_INFINITY;
+        
+        int localListSize = 0;
+        for(int i=0;i<local.listSize;i++){
+            Light l = local.list[i];
+            if (filter != null && !filter.test(l))  continue; 
+            list[localListSize] = l;
+            distToOwner[localListSize] = Float.NEGATIVE_INFINITY;
+            localListSize++;
         }
 
         // if the spatial has a parent node, add the lights
         // from the parent list as well
         if (parent != null) {
-            int sz = local.listSize + parent.listSize;
+            int sz = localListSize + parent.listSize;
             while (list.length <= sz)
                 doubleSize();
 
             for (int i = 0; i < parent.listSize; i++) {
-                int p = i + local.listSize;
+                int p = i + localListSize;
                 list[p] = parent.list[i];
                 distToOwner[p] = Float.NEGATIVE_INFINITY;
             }
 
-            listSize = local.listSize + parent.listSize;
+            listSize = localListSize + parent.listSize;
         } else {
-            listSize = local.listSize;
+            listSize = localListSize;
         }
     }
 
@@ -361,4 +378,17 @@ public void read(JmeImporter im) throws IOException {
 
         Arrays.fill(distToOwner, Float.NEGATIVE_INFINITY);
     }
+
+    @Override
+    public String toString() {
+        StringBuilder sb = new StringBuilder("LightList[");
+        for (int i = 0; i < listSize; i++) {
+            sb.append(list[i]);
+            if (i < listSize - 1) {
+                sb.append(", ");
+            }
+        }
+        sb.append("]");
+        return sb.toString();
+    }
 }

jme3-core/src/main/java/com/jme3/light/PointLight.java

@@ -66,15 +66,38 @@ public class PointLight extends Light {
      * Creates a PointLight
      */
     public PointLight() {
+        super();
+    }
+
+    /**
+     * Creates a PointLight
+     * @param global if true, the light affects the entire tree from the root node,
+     * otherwise it only affects the children of the node in which it is attached.
+     */
+    public PointLight(boolean global) {
+        this();
+        this.global = global;
     }
 
     /**
      * Creates a PointLight at the given position
      * @param position the position in world space
      */
     public PointLight(Vector3f position) {
+        super();
         setPosition(position);
     }
+    
+    /**
+     * Creates a PointLight at the given position
+     * @param position the position in world space
+     * @param global if true, the light affects the entire tree from the root node,
+     * otherwise it only affects the children of the node in which it is attached.
+     */
+    public PointLight(Vector3f position, boolean global) {
+        this(position);
+        this.global = global;
+    }
 
     /**
      * Creates a PointLight at the given position and with the given color
@@ -86,6 +109,18 @@ public PointLight(Vector3f position, ColorRGBA color) {
         setPosition(position);
     }
 
+    /**
+     * Creates a PointLight at the given position and with the given color
+     * @param position the position in world space
+     * @param color the light color
+     * @param global if true, the light affects the entire tree from the root node,
+     * otherwise it only affects the children of the node in which it is attached.
+     */
+    public PointLight(Vector3f position, ColorRGBA color, boolean global) {
+        this(position, color);
+        this.global = global;
+    }
+
     /**
      * Creates a PointLight at the given position, with the given color and the
      * given radius
@@ -97,6 +132,20 @@ public PointLight(Vector3f position, ColorRGBA color, float radius) {
         this(position, color);
         setRadius(radius);
     }
+    
+    /**
+     * Creates a PointLight at the given position, with the given color and the
+     * given radius
+     * @param position the position in world space
+     * @param color the light color
+     * @param radius the light radius
+     * @param global if true, the light affects the entire tree from the root node,
+     * otherwise it only affects the children of the node in which it is attached.
+     */
+    public PointLight(Vector3f position, ColorRGBA color, float radius, boolean global) {
+        this(position, color, radius);
+        this.global = global;
+    }
 
     /**
      * Creates a PointLight at the given position, with the given radius
@@ -107,6 +156,18 @@ public PointLight(Vector3f position, float radius) {
         this(position);
         setRadius(radius);
     }
+    
+    /**
+     * Creates a PointLight at the given position, with the given radius
+     * @param position the position in world space
+     * @param radius the light radius
+     * @param global if true, the light affects the entire tree from the root node,
+     * otherwise it only affects the children of the node in which it is attached.
+     */
+    public PointLight(Vector3f position, float radius, boolean global) {
+        this(position, radius);
+        this.global = global;
+    }
 
     @Override
     public void computeLastDistance(Spatial owner) {