projects
/
sixth-3d.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Improved code readability
[sixth-3d.git]
/
src
/
main
/
java
/
eu
/
svjatoslav
/
sixth
/
e3d
/
gui
/
ViewFrame.java
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
29cf98f
..
6a824c8
100755
(executable)
--- a/
src/main/java/eu/svjatoslav/sixth/e3d/gui/ViewFrame.java
+++ b/
src/main/java/eu/svjatoslav/sixth/e3d/gui/ViewFrame.java
@@
-1,5
+1,5
@@
/*
/*
- * 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;
* This project is released under Creative Commons Zero (CC0) license.
*/
package eu.svjatoslav.sixth.e3d.gui;
@@
-11,6
+11,9
@@
import java.awt.event.ComponentListener;
import java.awt.event.WindowEvent;
import java.awt.event.WindowListener;
import java.awt.event.WindowEvent;
import java.awt.event.WindowListener;
+/**
+ * Java Swing GUI frame that contains canvas for 3D rendering.
+ */
public class ViewFrame extends JFrame implements WindowListener {
private static final long serialVersionUID = -7037635097739548470L;
public class ViewFrame extends JFrame implements WindowListener {
private static final long serialVersionUID = -7037635097739548470L;
@@
-85,6
+88,9
@@
public class ViewFrame extends JFrame implements WindowListener {
});
}
});
}
+ /**
+ * Exit the application.
+ */
public void exit() {
if (getViewPanel() != null) {
getViewPanel().stop();
public void exit() {
if (getViewPanel() != null) {
getViewPanel().stop();
@@
-123,11
+129,22
@@
public class ViewFrame extends JFrame implements WindowListener {
public void windowDeactivated(final WindowEvent e) {
}
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();
}
@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) {
}
@Override
public void windowIconified(final WindowEvent e) {
}