Updated readability of the code.

[sixth-3d.git] / src / main / java / eu / svjatoslav / sixth / e3d / gui / RenderingContext.java

diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/gui/RenderingContext.java b/src/main/java/eu/svjatoslav/sixth/e3d/gui/RenderingContext.java
index 0d16aa4..c5c42f6 100644 (file)
--- a/src/main/java/eu/svjatoslav/sixth/e3d/gui/RenderingContext.java
+++ b/src/main/java/eu/svjatoslav/sixth/e3d/gui/RenderingContext.java
@@ -1,14 +1,10 @@
 /*
- * Sixth 3D engine. Copyright ©2012-2019, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of version 3 of the GNU Lesser General Public License
- * or later as published by the Free Software Foundation.
- *
+ * Sixth 3D engine. Author: Svjatoslav Agejenko. 
+ * This project is released under Creative Commons Zero (CC0) license.
  */
-
 package eu.svjatoslav.sixth.e3d.gui;
 
+import eu.svjatoslav.sixth.e3d.geometry.Point2D;
 import eu.svjatoslav.sixth.e3d.gui.humaninput.MouseEvent;
 import eu.svjatoslav.sixth.e3d.gui.humaninput.MouseInteractionController;
 
@@ -24,26 +20,42 @@ public class RenderingContext {
     public final byte[] pixels;
     public final int width;
     public final int height;
-    public final int xCenter;
-    public final int yCenter;
+    /**
+     * Center of the screen in screen space (pixels).
+     * This is the point where (0,0) coordinate of the world space is rendered.
+     */
+    public final Point2D centerCoordinate;
+
+    /**
+     * Zoom factor. The bigger the value, the more zoomed in the view is.
+     */
     public final double zoom;
     final BufferedImage bufferedImage;
+    /**
+     * Number of frame that is currently being rendered.
+     * Every frame has its own number.
+     */
     public int frameNumber = 0;
 
     /**
      * UI component that mouse is currently hovering over.
      */
-    private MouseInteractionController currentMouseOverComponent;
+    private MouseInteractionController objectPreviouslyUnderMouseCursor;
 
     public void prepareForNewFrameRendering(){
         mouseEvent = null;
-        objectUnderMouse = null;
+        currentObjectUnderMouseCursor = null;
     }
 
     /**
      * Mouse click event that needs to be processed.
+     * This event is processed only once per frame.
+     * If there are multiple objects under mouse cursor, the top-most object will receive the event.
+     * If there are no objects under mouse cursor, the event will be ignored.
+     * If there is no event, this field will be null.
+     * This field is set to null after the event is processed.
      */
-    private  MouseEvent mouseEvent;
+    private MouseEvent mouseEvent;
 
     public void setMouseEvent(MouseEvent mouseEvent) {
         this.mouseEvent = mouseEvent;
@@ -54,26 +66,23 @@ public class RenderingContext {
     }
 
     /**
-     * Item that user clicked on.
+     * UI component that mouse is currently hovering over.
      */
-    private MouseInteractionController objectUnderMouse;
+    private MouseInteractionController currentObjectUnderMouseCursor;
 
     /**
      * Called when given object was detected under mouse cursor, while processing {@link #mouseEvent}.
      * Because objects are rendered back to front. The last method caller will set the top-most object, if
      * there are multiple objects under mouse cursor.
      */
-    public void setObjectUnderMouse(MouseInteractionController objectUnderMouse) {
-        this.objectUnderMouse = objectUnderMouse;
+    public void setCurrentObjectUnderMouseCursor(MouseInteractionController currentObjectUnderMouseCursor) {
+        this.currentObjectUnderMouseCursor = currentObjectUnderMouseCursor;
     }
 
     public RenderingContext(final int width, final int height) {
         this.width = width;
         this.height = height;
-
-        this.xCenter = width / 2;
-        this.yCenter = height / 2;
-
+        this.centerCoordinate = new Point2D(width / 2d, height / 2d);
         this.zoom = width / 3d;
 
         bufferedImage = new BufferedImage(width, height, bufferedImageType);
@@ -88,30 +97,26 @@ public class RenderingContext {
     }
 
     /**
-     * @return <code>true</code> if view repaint is needed.
+     * @return <code>true</code> if view update is needed as a consequence of this mouse event.
      */
-    public boolean handleDetectedComponentMouseEvents() {
-        if (objectUnderMouse != null) {
-            if (mouseEvent.button == 0) {
-                // mouse over
-                if (currentMouseOverComponent == null) {
-                    currentMouseOverComponent = objectUnderMouse;
-                    return currentMouseOverComponent.mouseEntered();
-                } else if (currentMouseOverComponent != objectUnderMouse) {
-                    boolean viewRepaintNeeded = currentMouseOverComponent.mouseExited();
-                    currentMouseOverComponent = objectUnderMouse;
-                    return viewRepaintNeeded | currentMouseOverComponent.mouseEntered();
-                }
-            } else {
-                // mouse click
-                return objectUnderMouse.mouseClicked();
-            }
-        } else if (currentMouseOverComponent != null) {
-            boolean viewRepaintNeeded = currentMouseOverComponent.mouseExited();
-            currentMouseOverComponent = null;
-            return viewRepaintNeeded;
+    public boolean handlePossibleComponentMouseEvent() {
+        if (mouseEvent == null) return false;
+
+        boolean viewRepaintNeeded = false;
+
+        if (objectPreviouslyUnderMouseCursor != currentObjectUnderMouseCursor) {
+            // Mouse cursor has just entered or left component.
+            viewRepaintNeeded = objectPreviouslyUnderMouseCursor != null && objectPreviouslyUnderMouseCursor.mouseExited();
+            viewRepaintNeeded |= currentObjectUnderMouseCursor != null && currentObjectUnderMouseCursor.mouseEntered();
+            objectPreviouslyUnderMouseCursor = currentObjectUnderMouseCursor;
+        }
+
+        if (mouseEvent.button != 0 && currentObjectUnderMouseCursor != null) {
+            // Mouse button was clicked on some component.
+            viewRepaintNeeded |= currentObjectUnderMouseCursor.mouseClicked(mouseEvent.button);
         }
-        return false;
+
+        return viewRepaintNeeded;
     }
 
 }