X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Feu%2Fsvjatoslav%2Fsixth%2Fe3d%2Fgui%2FViewFrame.java;h=a7b04456eadf795e6fcde94cb79ad6535c5ac07b;hb=HEAD;hp=3959a3013e96b0b150d9aed6d637c907e014962b;hpb=6213716671ccab6b7256de41838e1f5401ce173c;p=sixth-3d.git

diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/gui/ViewFrame.java b/src/main/java/eu/svjatoslav/sixth/e3d/gui/ViewFrame.java
index 3959a30..a7b0445 100755
--- a/src/main/java/eu/svjatoslav/sixth/e3d/gui/ViewFrame.java
+++ b/src/main/java/eu/svjatoslav/sixth/e3d/gui/ViewFrame.java
@@ -1,12 +1,7 @@
 /*
- * Sixth - System for data storage, computation, exploration and interaction.
- * Copyright ©2012-2016, 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 javax.swing.*;
@@ -16,11 +11,14 @@ import java.awt.event.ComponentListener;
 import java.awt.event.WindowEvent;
 import java.awt.event.WindowListener;
 
-public class ViewFrame extends JFrame implements ViewListener, WindowListener {
+/**
+ * Java Swing GUI frame that contains {@link ViewPanel} with canvas for 3D rendering.
+ */
+public class ViewFrame extends JFrame implements WindowListener {
 
     private static final long serialVersionUID = -7037635097739548470L;
 
-    private final View view;
+    private final ViewPanel viewPanel;
 
     public ViewFrame() {
         setTitle("3D engine");
@@ -32,11 +30,9 @@ public class ViewFrame extends JFrame implements ViewListener, WindowListener {
             }
         });
 
-        view = new View();
-
-        add(getView());
+        viewPanel = new ViewPanel();
 
-        getView().addViewListener(this);
+        add(getViewPanel());
 
         setSize(800, 600);
 
@@ -48,7 +44,7 @@ public class ViewFrame extends JFrame implements ViewListener, WindowListener {
         addWindowListener(this);
     }
 
-    public void addResizeListener() {
+    private void addResizeListener() {
         addComponentListener(new ComponentListener() {
             // This method is called after the component's size changes
             @Override
@@ -86,18 +82,20 @@ public class ViewFrame extends JFrame implements ViewListener, WindowListener {
 
             @Override
             public void componentShown(final ComponentEvent e) {
-                view.repaintDuringNextViewUpdate();
+                viewPanel.repaintDuringNextViewUpdate();
             }
 
         });
     }
 
-    @Override
+    /**
+     * Exit the application.
+     */
     public void exit() {
-        if (getView() != null) {
-            getView().stop();
-            getView().setEnabled(false);
-            getView().setVisible(false);
+        if (getViewPanel() != null) {
+            getViewPanel().stop();
+            getViewPanel().setEnabled(false);
+            getViewPanel().setVisible(false);
         }
         dispose();
     }
@@ -110,13 +108,13 @@ public class ViewFrame extends JFrame implements ViewListener, WindowListener {
     /**
      * @return the view
      */
-    public View getView() {
-        return view;
+    public ViewPanel getViewPanel() {
+        return viewPanel;
     }
 
     @Override
     public void windowActivated(final WindowEvent e) {
-        view.repaintDuringNextViewUpdate();
+        viewPanel.repaintDuringNextViewUpdate();
     }
 
     @Override
@@ -131,18 +129,29 @@ public class ViewFrame extends JFrame implements ViewListener, WindowListener {
     public void windowDeactivated(final WindowEvent e) {
     }
 
+    /**
+     * Repaint the view when the window is deiconified.
+     *
+     * Deiconified means that the window is restored from minimized state.
+     */
     @Override
     public void windowDeiconified(final WindowEvent e) {
-        view.repaintDuringNextViewUpdate();
+        viewPanel.repaintDuringNextViewUpdate();
     }
 
+    /**
+     * Do nothing when the window is iconified.
+     *
+     * Iconified means that the window is minimized.
+     * @param e the event to be processed
+     */
     @Override
     public void windowIconified(final WindowEvent e) {
     }
 
     @Override
     public void windowOpened(final WindowEvent e) {
-        view.repaintDuringNextViewUpdate();
+        viewPanel.repaintDuringNextViewUpdate();
     }
 
 }