Refactoring.

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

diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/gui/ViewUpdateListener.java b/src/main/java/eu/svjatoslav/sixth/e3d/gui/ViewUpdateListener.java
index e31bd2e..41a51f9 100644 (file)
--- a/src/main/java/eu/svjatoslav/sixth/e3d/gui/ViewUpdateListener.java
+++ b/src/main/java/eu/svjatoslav/sixth/e3d/gui/ViewUpdateListener.java
@@ -1,10 +1,10 @@
 /*
- * Sixth - System for data storage, computation, exploration and interaction.
- * Copyright ©2012-2016, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
- * 
+ * Sixth 3D engine. Copyright ©2012-2018, 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.
+ *
  */
 
 package eu.svjatoslav.sixth.e3d.gui;
@@ -12,10 +12,11 @@ package eu.svjatoslav.sixth.e3d.gui;
 public interface ViewUpdateListener {
 
     /**
-     * @return <code>true</code> if underlying view shall be re-rendered. If at
-     * least one of the view update listeners returns <code>true</code>,
-     * view is re-rendered.
+     * Notifies that it is about time to render next frame. Update listener can determine if frame repaint is actually
+     * needed from its perspective. Frame will be rendered if at least one listener says yes.
+     *
+     * @return <code>true</code> if underlying view shall be re-rendered. If at least one of the view update listeners
+     * returns <code>true</code>, view is re-rendered.
      */
-    boolean beforeViewUpdate(ViewContext viewContext,
-                             final int millisecondsSinceLastFrame);
+    boolean beforeViewUpdate(ViewContext viewContext, final int millisecondsSinceLastFrame);
 }