/*
- * 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.
- *
+ * 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.*;
import java.awt.event.WindowEvent;
import java.awt.event.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;
});
}
+ /**
+ * Exit the application.
+ */
public void exit() {
if (getViewPanel() != null) {
getViewPanel().stop();
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) {
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) {
}