From a2adc39378a8e788f1fbfa82f27b2422347846a7 Mon Sep 17 00:00:00 2001
From: Daniel Kirschten <daniel.kirschten@gmx.de>
Date: Thu, 16 May 2019 13:53:54 +0200
Subject: [PATCH] Added comments for LogicUI

---
 LogicUI/src/era/mi/gui/LogicUI.java | 24 ++++++++++++++++++------
 1 file changed, 18 insertions(+), 6 deletions(-)

diff --git a/LogicUI/src/era/mi/gui/LogicUI.java b/LogicUI/src/era/mi/gui/LogicUI.java
index 74d516fd..faf5ae4f 100644
--- a/LogicUI/src/era/mi/gui/LogicUI.java
+++ b/LogicUI/src/era/mi/gui/LogicUI.java
@@ -22,6 +22,11 @@ import net.haspamelodica.swt.helper.zoomablecanvas.ZoomableCanvas;
 import net.haspamelodica.swt.helper.zoomablecanvas.helper.ZoomableCanvasOverlay;
 import net.haspamelodica.swt.helper.zoomablecanvas.helper.ZoomableCanvasUserInput;
 
+/**
+ * Standalone simulation visualizer.
+ * 
+ * @author Daniel Kirschten
+ */
 public class LogicUI
 {
 	private final Display						display;
@@ -52,7 +57,10 @@ public class LogicUI
 		canvas.addListener(SWT.MouseDown, this::mouseDown);
 	}
 	/**
+	 * Add a component to be drawn.
 	 * Returns the given component for convenience.
+	 * 
+	 * @author Daniel Kirschten
 	 */
 	public <C extends BasicGUIComponent> C addComponent(C component, double x, double y)
 	{
@@ -60,6 +68,12 @@ public class LogicUI
 		componentPositions.put(component, new Point(x, y));
 		return component;
 	}
+	/**
+	 * Add a graphical wire between the given connection points of the given components.
+	 * The given components have to be added and the given connection points have to be connected logically first.
+	 * 
+	 * @author Daniel Kirschten
+	 */
 	public void addWire(BasicGUIComponent component1, int component1ConnectionIndex, BasicGUIComponent component2, int component2ConnectionIndex, Point... path)
 	{
 		wires.add(new GUIWire(canvas::redrawThreadsafe, component1, component1ConnectionIndex, componentPositions.get(component1), component2, component2ConnectionIndex, componentPositions.get(component2), path));
@@ -69,12 +83,6 @@ public class LogicUI
 		TranslatedGC tgc = new TranslatedGC(gc, componentPositions.get(component));
 		component.render(tgc);
 		tgc.setBackground(display.getSystemColor(SWT.COLOR_BLUE));
-//		for(int i = 0; i < component.getConnectedWireArraysCount(); i ++)
-//		{
-//			Point connectionPoint = component.getWireArrayConnectionPoint(i);
-//			if(connectionPoint != null)
-//				tgc.fillOval(connectionPoint.x - 1, connectionPoint.y - 1, 2, 2);
-//		}
 	}
 	private void mouseDown(Event e)
 	{
@@ -91,6 +99,10 @@ public class LogicUI
 		}
 	}
 
+	/**
+	 * Start the simulation timeline, and open the UI shell.
+	 * Returns when the shell is closed.
+	 */
 	public void run()
 	{
 		AtomicBoolean running = new AtomicBoolean(true);
-- 
2.17.1