Add support for Multiple Monitors in jme-LWJGL3 #2030

jme3-android/src/main/java/com/jme3/system/android/OGLESContext.java

@@ -554,4 +554,18 @@ private Rect getSurfaceFrame() {
         Rect result = holder.getSurfaceFrame();
         return result;
     }
+
+	@Override
+	public Monitors getMonitors()
+	{
+		// TODO Auto-generated method stub
+		return null;
+	}
+
+	@Override
+	public int getPrimaryMonitor()
+	{
+		// TODO Auto-generated method stub
+		return 0;
+	}
 }

jme3-core/src/main/java/com/jme3/system/AppSettings.java

@@ -266,6 +266,7 @@ public final class AppSettings extends HashMap<String, Object> {
     public static final String JOAL = "JOAL";
 
     static {
+        defaults.put("Monitor", 0);
         defaults.put("CenterWindow", true);
         defaults.put("Width", 640);
         defaults.put("Height", 480);
@@ -1479,4 +1480,32 @@ public int getWindowYPosition() {
     public void setWindowYPosition(int pos) {
         putInteger("WindowYPosition", pos);
     }
+
+
+    /**
+     * Gets the monitor number used when creating a window.
+     *
+     * <p>This setting is used only with LWJGL3, it defines which monitor
+     * to use when creating a OpenGL window.
+     *
+     * @return the desired monitor used when creating a OpenGL window
+     * @see #setMonitor(long)
+     */
+    public int getMonitor() {
+        return getInteger("Monitor");
+    }
+
+    /**
+     * Sets the monitor number used when creating a window.  The position
+     * number is the number in the list of monitors GlfwGetMonitors returns.
+     *
+     * <p>This setting is used only with LWJGL3, it defines which monitor
+     * to use when creating a OpenGL window. its default value is -1.
+     *
+     * @param mon the desired monitor used when creating a OpenGL window
+     * 
+     */
+    public void setMonitor(int mon) {
+        putInteger("Monitor", mon);
+    }
 }

jme3-core/src/main/java/com/jme3/system/JmeContext.java

@@ -225,4 +225,22 @@ public enum Type {
      * @throws IllegalStateException for a headless or null context
      */
     public int getWindowYPosition();
+
+    /**
+     * This call will return a list of Monitors that glfwGetMonitors()
+     * returns and information about the monitor, like width, height, 
+     * and refresh rate.
+     * 
+     * @return returns a list of monitors and their information.
+     */
+    public Monitors getMonitors();
+
+    /**
+     * Use this to get the positional number of the primary
+     * monitor from the glfwGetMonitors() function call.
+     * 
+     * @return the position of the value in the arraylist of
+     *         the primary monitor.
+     */    
+    public int getPrimaryMonitor();
 }

jme3-core/src/main/java/com/jme3/system/MonitorInfo.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) 2009-2022 jMonkeyEngine
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ *
+ * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
+ *   may be used to endorse or promote products derived from this software
+ *   without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.jme3.system;
+
+/**
+ * This class holds information about the monitor that was
+ * returned by glfwGetMonitors() calls in the context
+ * class
+ * 
+ * @author Kevin Bales
+ */
+public class MonitorInfo {
+
+   /**
+    * monitorID - monitor id that was return from Lwjgl3.
+    */
+   public long monitorID = 0;
+
+   /**
+    * width - width that was return from Lwjgl3.
+    */
+   public int width = 1080;
+
+   /**
+    * height - height that was return from Lwjgl3.
+    */
+   public int height = 1920;
+
+   /**
+    * rate - refresh rate that was return from Lwjgl3.
+    */
+   public int rate = 60;
+
+   /**
+    * primary - indicates if the monitor is the primary monitor.
+    */
+   public boolean primary = false;
+
+   /**
+    * name - monitor name that was return from Lwjgl3.
+    */
+   public String name = "Generic Monitor";
+
+}

jme3-core/src/main/java/com/jme3/system/Monitors.java

@@ -0,0 +1,119 @@
+/*
+ * Copyright (c) 2009-2022 jMonkeyEngine
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ *
+ * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
+ *   may be used to endorse or promote products derived from this software
+ *   without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.jme3.system;
+
+import java.util.ArrayList;
+
+/**
+ * This class holds all information about all monitors that where
+ * return from the glfwGetMonitors() call.  It stores them into
+ * an <ArrayList>
+ * 
+ * @author Kevin Bales
+ */
+public class Monitors {
+
+   private ArrayList<MonitorInfo> monitors = new ArrayList<MonitorInfo>();
+
+   public int addNewMonitor(long monitorID)
+   {
+      MonitorInfo info = new MonitorInfo();
+      info.monitorID = monitorID;
+      monitors.add(info);
+      return monitors.size() - 1;
+   }
+
+   /**
+    * This function returns the size of the monitor ArrayList
+    * @return the 
+    */
+   public int size()
+   {
+      return monitors.size();
+   }
+
+   /**
+    * Call to get monitor information on a certain monitor.
+    * 
+    * @param pos the position in the arraylist of the monitor
+    *        information that you want to get.
+    * @return  returns the MonitorInfo data for the monitor
+    *          called for.
+    */
+   public MonitorInfo get(int pos)
+   {
+      if (pos < monitors.size())
+         return monitors.get(pos);
+
+      return null;
+   }
+
+   /**
+    * Set information about this monitor stored in monPos position
+    * in the array list.
+    * 
+    * @param monPos  arraylist position of monitor to update
+    * @param width   the current width the monitor is displaying
+    * @param height  the current height the monitor is displaying
+    * @param rate    the current refresh rate the monitor is set to
+    */
+   public void setInfo(int monPos, String name, int width, int height, int rate) {
+      if (monPos < monitors.size() ) {
+         MonitorInfo info = monitors.get(monPos);
+         if (info != null) {
+            info.width = width;
+            info.height = height;
+            info.rate = rate;
+            info.name = name;
+         }
+      }
+   }
+
+   /**
+    * This function will mark a certain monitor as the
+    * primary monitor.
+    *  
+    * @param monPos the position in the arraylist of which
+    *        monitor is the primary monitor
+    */
+   public void setPrimaryMonitor(int monPos) {
+      if (monPos < monitors.size() ) {
+         MonitorInfo info = monitors.get(monPos);
+         if (info != null)
+            info.primary = true;
+      }
+
+   }
+
+
+
+}

jme3-core/src/main/java/com/jme3/system/NullContext.java

@@ -306,4 +306,16 @@ public int getWindowXPosition() {
     public int getWindowYPosition() {
         throw new UnsupportedOperationException("null context");
     }
+
+   @Override
+   public Monitors getMonitors() {
+      // TODO Auto-generated method stub
+      return null;
+   }
+
+   @Override
+   public int getPrimaryMonitor() {
+      // TODO Auto-generated method stub
+      return 0;
+   }
 }

jme3-desktop/src/main/java/com/jme3/system/AWTContext.java

@@ -275,4 +275,16 @@ public int getWindowXPosition() {
     public int getWindowYPosition() {
         throw new UnsupportedOperationException("not implemented yet");
     }
+
+   @Override
+   public Monitors getMonitors() {
+      // TODO Auto-generated method stub
+      return null;
+   }
+
+   @Override
+   public int getPrimaryMonitor() {
+      // TODO Auto-generated method stub
+      return 0;
+   }
 }

jme3-desktop/src/main/java/com/jme3/system/awt/AwtPanelsContext.java

@@ -328,4 +328,16 @@ public int getWindowXPosition() {
     public int getWindowYPosition() {
         return inputSource.getY();
     }
+
+   @Override
+   public Monitors getMonitors() {
+      // TODO Auto-generated method stub
+      return null;
+   }
+
+   @Override
+   public int getPrimaryMonitor() {
+      // TODO Auto-generated method stub
+      return 0;
+   }
 }