X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Feu%2Fsvjatoslav%2Fsixth%2Fe3d%2Fgui%2Fhumaninput%2FMouseEvent.java;h=459d0d2d2f20351a697c75d790d3c8439a28b6cd;hb=HEAD;hp=8582cc0d44ba83a457414425f8743e9049073a9c;hpb=a40c9c2a3ef372ea0f2c87af644ca2302315baca;p=sixth-3d.git

diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/gui/humaninput/MouseEvent.java b/src/main/java/eu/svjatoslav/sixth/e3d/gui/humaninput/MouseEvent.java
index 8582cc0..459d0d2 100644
--- a/src/main/java/eu/svjatoslav/sixth/e3d/gui/humaninput/MouseEvent.java
+++ b/src/main/java/eu/svjatoslav/sixth/e3d/gui/humaninput/MouseEvent.java
@@ -1,18 +1,29 @@
 /*
- * Sixth 3D engine. Author: Svjatoslav Agejenko. 
+ * Sixth 3D engine. Author: Svjatoslav Agejenko.
  * This project is released under Creative Commons Zero (CC0) license.
  */
 package eu.svjatoslav.sixth.e3d.gui.humaninput;
 
 import eu.svjatoslav.sixth.e3d.geometry.Point2D;
 
+/**
+ * Represents mouse event.
+ */
 public class MouseEvent {
 
+    /**
+     * Mouse coordinate in screen space (pixels) relative to top left corner of the screen
+     * when mouse button was clicked.
+     */
     public Point2D coordinate;
 
     /**
-     * Indicates pressed mouse button. Except 0 that simply means mouse over
-     * given region.
+     * <pre>
+     * 0 - mouse over (no button pressed)
+     * 1 - left mouse button
+     * 2 - middle mouse button
+     * 3 - right mouse button
+     * </pre>
      */
     public int button;