import java.util.Arrays;\r
import java.util.List;\r
\r
+import org.eclipse.swt.SWT;\r
+\r
import net.haspamelodica.swt.helper.gcs.GeneralGC;\r
import net.haspamelodica.swt.helper.swtobjectwrappers.Point;\r
import net.haspamelodica.swt.helper.swtobjectwrappers.Rectangle;\r
-import net.mograsim.logic.core.LogicObservable;\r
import net.mograsim.logic.core.LogicObserver;\r
import net.mograsim.logic.core.types.BitVectorFormatter;\r
import net.mograsim.logic.core.wires.Wire.ReadEnd;\r
import net.mograsim.logic.ui.ColorHelper;\r
import net.mograsim.logic.ui.model.ViewModelModifiable;\r
\r
+/**\r
+ * A wire connecting exactly two {@link Pin}s.\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
public class GUIWire\r
{\r
+ /**\r
+ * The model this wire is a part of.\r
+ */\r
private final ViewModelModifiable model;\r
+ /**\r
+ * The logical width of this wire. Is equal to the logical with of {@link #pin1} and {@link #pin2}.\r
+ */\r
public final int logicWidth;\r
+ /**\r
+ * The {@link Pin} on one side of this wire, usually the signal source.\r
+ */\r
private Pin pin1;\r
+ /**\r
+ * The {@link Pin} on one side of this wire, usually the signal target.\r
+ */\r
private Pin pin2;\r
+ /**\r
+ * The user-defined path between {@link #pin1} and {@link #pin2}.<br>\r
+ * Special cases: <code>null</code> means "choose an interpolation as fits", and an empty array means "direct connection without any\r
+ * interpolation".\r
+ */\r
private Point[] path;\r
+ /**\r
+ * The bounds of this wire, excluding line width (and line joins, if the line join is {@link SWT#JOIN_MITER})\r
+ */\r
private final Rectangle bounds;\r
+ /**\r
+ * The effective path of this wire, including automatic interpolation and the position of both {@link Pin}s. Is never null.\r
+ */\r
private double[] effectivePath;\r
\r
private final List<Runnable> redrawListeners;\r
\r
+ /**\r
+ * A LogicObserver calling redrawListeners. Used for logic model bindings.\r
+ */\r
private final LogicObserver logicObs;\r
+ /**\r
+ * A ReadEnd of the logic wire this GUI wire currently is bound to.\r
+ */\r
private ReadEnd end;\r
\r
+ // creation and destruction\r
+\r
+ /**\r
+ * Creates a new {@link GUIWire} with automatic interpolation.\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
public GUIWire(ViewModelModifiable model, WireCrossPoint pin1, WireCrossPoint pin2)\r
{\r
this(model, pin1, pin2, (Point[]) null);\r
}\r
\r
+ /**\r
+ * Creates a new {@link GUIWire} with automatic interpolation.\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
public GUIWire(ViewModelModifiable model, WireCrossPoint pin1, Pin pin2)\r
{\r
this(model, pin1, pin2, (Point[]) null);\r
}\r
\r
+ /**\r
+ * Creates a new {@link GUIWire} with automatic interpolation.\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
public GUIWire(ViewModelModifiable model, Pin pin1, WireCrossPoint pin2)\r
{\r
this(model, pin1, pin2, (Point[]) null);\r
}\r
\r
+ /**\r
+ * Creates a new {@link GUIWire} with automatic interpolation.\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
public GUIWire(ViewModelModifiable model, Pin pin1, Pin pin2)\r
{\r
this(model, pin1, pin2, (Point[]) null);\r
}\r
\r
+ /**\r
+ * Creates a new {@link GUIWire} without automatic interpolation.\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
public GUIWire(ViewModelModifiable model, WireCrossPoint pin1, WireCrossPoint pin2, Point... path)\r
{\r
this(model, pin1.getPin(), pin2.getPin(), path);\r
}\r
\r
+ /**\r
+ * Creates a new {@link GUIWire} without automatic interpolation.\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
public GUIWire(ViewModelModifiable model, WireCrossPoint pin1, Pin pin2, Point... path)\r
{\r
this(model, pin1.getPin(), pin2, path);\r
}\r
\r
+ /**\r
+ * Creates a new {@link GUIWire} without automatic interpolation.\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
public GUIWire(ViewModelModifiable model, Pin pin1, WireCrossPoint pin2, Point... path)\r
{\r
this(model, pin1, pin2.getPin(), path);\r
}\r
\r
+ /**\r
+ * Creates a new {@link GUIWire} without automatic interpolation.\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
public GUIWire(ViewModelModifiable model, Pin pin1, Pin pin2, Point... path)\r
{\r
logicObs = (i) -> callRedrawListeners();\r
\r
redrawListeners = new ArrayList<>();\r
\r
- pin1.addPinMovedListener(p -> pin1Moved());\r
- pin2.addPinMovedListener(p -> pin2Moved());\r
+ pin1.addPinMovedListener(p -> pinMoved());\r
+ pin2.addPinMovedListener(p -> pinMoved());\r
\r
recalculateEffectivePath();\r
\r
model.wireCreated(this);\r
}\r
\r
+ /**\r
+ * Destroys this wire. This method implicitly calls {@link ViewModelModifiable#wireDestroyed(GUIWire) wireDestroyed()} for the model\r
+ * this component is a part of.\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
+ public void destroy()\r
+ {\r
+ model.wireDestroyed(this);\r
+ }\r
+\r
+ // pins\r
+\r
+ /**\r
+ * Returns the {@link Pin} on one side of this wire, usually the signal source.\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
+ public Pin getPin1()\r
+ {\r
+ return pin1;\r
+ }\r
+\r
+ /**\r
+ * Returns the {@link Pin} on one side of this wire, usually the signal target.\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
+ public Pin getPin2()\r
+ {\r
+ return pin2;\r
+ }\r
+\r
+ /**\r
+ * Called when {@link #pin1} or {@link #pin2} were moved.\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
+ private void pinMoved()\r
+ {\r
+ recalculateEffectivePath();\r
+ callRedrawListeners();\r
+ }\r
+\r
+ // "graphical" operations\r
+\r
+ /**\r
+ * Recalculates {@link #effectivePath} "from scratch". Also updates {@link #bounds}.\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
private void recalculateEffectivePath()\r
{\r
Point pos1 = pin1.getPos(), pos2 = pin2.getPos();\r
bounds.height = boundsY2 - boundsY1;\r
}\r
\r
- private void pin1Moved()\r
- {\r
- recalculateEffectivePath();\r
- callRedrawListeners();\r
- }\r
-\r
- private void pin2Moved()\r
- {\r
- recalculateEffectivePath();\r
- callRedrawListeners();\r
- }\r
-\r
- public void destroy()\r
- {\r
- model.wireDestroyed(this);\r
- }\r
-\r
+ /**\r
+ * Returns the bounds of this wire, excluding line width (and line joins, if the line join is {@link SWT#JOIN_MITER})\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
public Rectangle getBounds()\r
{\r
return new Rectangle(bounds.x, bounds.y, bounds.width, bounds.height);\r
}\r
\r
+ /**\r
+ * Render this wire to the given gc, in absoulute coordinates.\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
public void render(GeneralGC gc)\r
{\r
ColorHelper.executeWithDifferentForeground(gc, BitVectorFormatter.formatAsColor(end), () -> gc.drawPolyline(effectivePath));\r
}\r
\r
- public void setLogicModelBinding(ReadEnd end)\r
- {\r
- deregisterLogicObs(this.end);\r
- this.end = end;\r
- registerLogicObs(end);\r
- }\r
-\r
- private void registerLogicObs(LogicObservable observable)\r
- {\r
- if (observable != null)\r
- observable.registerObserver(logicObs);\r
- }\r
-\r
- private void deregisterLogicObs(LogicObservable observable)\r
+ /**\r
+ * The user-defined path between {@link #pin1} and {@link #pin2}. Note that this is not neccessarily equal to the effective path drawn\r
+ * in {@link #render(GeneralGC)}.<br>\r
+ * Special cases: <code>null</code> means "choose an interpolation as fits", and an empty array means "direct connection without any\r
+ * interpolation".\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
+ public Point[] getPath()\r
{\r
- if (observable != null)\r
- observable.deregisterObserver(logicObs);\r
+ return path == null ? null : path.clone();\r
}\r
\r
- public Pin getPin1()\r
- {\r
- return pin1;\r
- }\r
+ // logic model binding\r
\r
- public Pin getPin2()\r
+ /**\r
+ * Binds this {@link GUIWire} to the given {@link ReadEnd}: The color of this {@link GUIWire} will now depend on the state of the given\r
+ * {@link ReadEnd}, and further changes of the given {@link ReadEnd} will result in readrawListeners being called.<br>\r
+ * The argument can be null, in which case the old binding is stopped.\r
+ * \r
+ * @author Daniel Kirschten\r
+ */\r
+ public void setLogicModelBinding(ReadEnd end)\r
{\r
- return pin2;\r
+ if (this.end != null)\r
+ this.end.deregisterObserver(logicObs);\r
+ this.end = end;\r
+ if (end != null)\r
+ end.registerObserver(logicObs);\r
}\r
\r
- public Point[] getPath()\r
- {\r
- return path == null ? null : path.clone();\r
- }\r
+ // listeners\r
\r
// @formatter:off\r
public void addRedrawListener (Runnable listener) {redrawListeners .add (listener);}\r
projects / Mograsim.git / commitdiff