X-Git-Url: https://mograsim.net/gitweb/?a=blobdiff_plain;f=net.mograsim.logic.ui%2Fsrc%2Fnet%2Fmograsim%2Flogic%2Fui%2Fmodel%2Fwires%2FGUIWire.java;h=7b641ff3484c05bf8e92cb87b73b408775b2381b;hb=a2eef1d1616d03af5b464f347f6176ea9d2cc75e;hp=47f851710a672a84c87ee50ff639fa4c938bb54f;hpb=738ca98b4d80225a3a80b42d3ac690fe0fa3f90f;p=Mograsim.git diff --git a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/wires/GUIWire.java b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/wires/GUIWire.java index 47f85171..7b641ff3 100644 --- a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/wires/GUIWire.java +++ b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/wires/GUIWire.java @@ -4,66 +4,146 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.List; +import org.eclipse.swt.SWT; + import net.haspamelodica.swt.helper.gcs.GeneralGC; import net.haspamelodica.swt.helper.swtobjectwrappers.Point; import net.haspamelodica.swt.helper.swtobjectwrappers.Rectangle; -import net.mograsim.logic.core.LogicObservable; import net.mograsim.logic.core.LogicObserver; +import net.mograsim.logic.core.types.BitVector; import net.mograsim.logic.core.types.BitVectorFormatter; +import net.mograsim.logic.core.wires.Wire; import net.mograsim.logic.core.wires.Wire.ReadEnd; -import net.mograsim.logic.ui.ColorHelper; import net.mograsim.logic.ui.model.ViewModelModifiable; - +import net.mograsim.preferences.ColorDefinition; +import net.mograsim.preferences.ColorManager; + +/** + * A wire connecting exactly two {@link Pin}s. + * + * @author Daniel Kirschten + */ public class GUIWire { + /** + * The model this wire is a part of. + */ private final ViewModelModifiable model; + /** + * The logical width of this wire. Is equal to the logical with of {@link #pin1} and {@link #pin2}. + */ public final int logicWidth; + /** + * The {@link Pin} on one side of this wire, usually the signal source. + */ private Pin pin1; + /** + * The {@link Pin} on one side of this wire, usually the signal target. + */ private Pin pin2; + /** + * The user-defined path between {@link #pin1} and {@link #pin2}.
+ * Special cases: null means "choose an interpolation as fits", and an empty array means "direct connection without any + * interpolation". + */ private Point[] path; + /** + * The bounds of this wire, excluding line width (and line joins, if the line join is {@link SWT#JOIN_MITER}) + */ private final Rectangle bounds; + /** + * The effective path of this wire, including automatic interpolation and the position of both {@link Pin}s. Is never null. + */ private double[] effectivePath; private final List redrawListeners; + /** + * A LogicObserver calling redrawListeners. Used for logic model bindings. + */ private final LogicObserver logicObs; + /** + * A ReadEnd of the logic wire this GUI wire currently is bound to. + */ private ReadEnd end; + // creation and destruction + + /** + * Creates a new {@link GUIWire} with automatic interpolation. + * + * @author Daniel Kirschten + */ public GUIWire(ViewModelModifiable model, WireCrossPoint pin1, WireCrossPoint pin2) { this(model, pin1, pin2, (Point[]) null); } + /** + * Creates a new {@link GUIWire} with automatic interpolation. + * + * @author Daniel Kirschten + */ public GUIWire(ViewModelModifiable model, WireCrossPoint pin1, Pin pin2) { this(model, pin1, pin2, (Point[]) null); } + /** + * Creates a new {@link GUIWire} with automatic interpolation. + * + * @author Daniel Kirschten + */ public GUIWire(ViewModelModifiable model, Pin pin1, WireCrossPoint pin2) { this(model, pin1, pin2, (Point[]) null); } + /** + * Creates a new {@link GUIWire} with automatic interpolation. + * + * @author Daniel Kirschten + */ public GUIWire(ViewModelModifiable model, Pin pin1, Pin pin2) { this(model, pin1, pin2, (Point[]) null); } + /** + * Creates a new {@link GUIWire} without automatic interpolation. + * + * @author Daniel Kirschten + */ public GUIWire(ViewModelModifiable model, WireCrossPoint pin1, WireCrossPoint pin2, Point... path) { this(model, pin1.getPin(), pin2.getPin(), path); } + /** + * Creates a new {@link GUIWire} without automatic interpolation. + * + * @author Daniel Kirschten + */ public GUIWire(ViewModelModifiable model, WireCrossPoint pin1, Pin pin2, Point... path) { this(model, pin1.getPin(), pin2, path); } + /** + * Creates a new {@link GUIWire} without automatic interpolation. + * + * @author Daniel Kirschten + */ public GUIWire(ViewModelModifiable model, Pin pin1, WireCrossPoint pin2, Point... path) { this(model, pin1, pin2.getPin(), path); } + /** + * Creates a new {@link GUIWire} without automatic interpolation. + * + * @author Daniel Kirschten + */ public GUIWire(ViewModelModifiable model, Pin pin1, Pin pin2, Point... path) { logicObs = (i) -> callRedrawListeners(); @@ -80,14 +160,65 @@ public class GUIWire redrawListeners = new ArrayList<>(); - pin1.addPinMovedListener(p -> pin1Moved()); - pin2.addPinMovedListener(p -> pin2Moved()); + pin1.addPinMovedListener(p -> pinMoved()); + pin2.addPinMovedListener(p -> pinMoved()); recalculateEffectivePath(); model.wireCreated(this); } + /** + * Destroys this wire. This method implicitly calls {@link ViewModelModifiable#wireDestroyed(GUIWire) wireDestroyed()} for the model + * this component is a part of. + * + * @author Daniel Kirschten + */ + public void destroy() + { + model.wireDestroyed(this); + } + + // pins + + /** + * Returns the {@link Pin} on one side of this wire, usually the signal source. + * + * @author Daniel Kirschten + */ + public Pin getPin1() + { + return pin1; + } + + /** + * Returns the {@link Pin} on one side of this wire, usually the signal target. + * + * @author Daniel Kirschten + */ + public Pin getPin2() + { + return pin2; + } + + /** + * Called when {@link #pin1} or {@link #pin2} were moved. + * + * @author Daniel Kirschten + */ + private void pinMoved() + { + recalculateEffectivePath(); + callRedrawListeners(); + } + + // "graphical" operations + + /** + * Recalculates {@link #effectivePath} "from scratch". Also updates {@link #bounds}. + * + * @author Daniel Kirschten + */ private void recalculateEffectivePath() { Point pos1 = pin1.getPos(), pos2 = pin2.getPos(); @@ -129,61 +260,93 @@ public class GUIWire bounds.height = boundsY2 - boundsY1; } - private void pin1Moved() + /** + * Returns the bounds of this wire, excluding line width (and line joins, if the line join is {@link SWT#JOIN_MITER}) + * + * @author Daniel Kirschten + */ + public Rectangle getBounds() { - recalculateEffectivePath(); - callRedrawListeners(); + return new Rectangle(bounds.x, bounds.y, bounds.width, bounds.height); } - private void pin2Moved() + /** + * Render this wire to the given gc, in absoulute coordinates. + * + * @author Daniel Kirschten + */ + public void render(GeneralGC gc) { - recalculateEffectivePath(); - callRedrawListeners(); + ColorDefinition wireColor = BitVectorFormatter.formatAsColor(end); + if (wireColor != null) + gc.setForeground(ColorManager.current().toColor(wireColor)); + gc.drawPolyline(effectivePath); } - public void destroy() + /** + * The user-defined path between {@link #pin1} and {@link #pin2}. Note that this is not neccessarily equal to the effective path drawn + * in {@link #render(GeneralGC)}.
+ * Special cases: null means "choose an interpolation as fits", and an empty array means "direct connection without any + * interpolation". + * + * @author Daniel Kirschten + */ + public Point[] getPath() { - model.wireDestroyed(this); + return path == null ? null : path.clone(); } - public Rectangle getBounds() - { - return new Rectangle(bounds.x, bounds.y, bounds.width, bounds.height); - } - - public void render(GeneralGC gc) - { - ColorHelper.executeWithDifferentForeground(gc, BitVectorFormatter.formatAsColor(end), () -> gc.drawPolyline(effectivePath)); - } + // logic model binding + /** + * Binds this {@link GUIWire} to the given {@link ReadEnd}: The color of this {@link GUIWire} will now depend on the state of the given + * {@link ReadEnd}, and further changes of the given {@link ReadEnd} will result in readrawListeners being called.
+ * The argument can be null, in which case the old binding is stopped. + * + * @author Daniel Kirschten + */ public void setLogicModelBinding(ReadEnd end) { - deregisterLogicObs(this.end); + if (this.end != null) + this.end.deregisterObserver(logicObs); this.end = end; - registerLogicObs(end); + if (end != null) + end.registerObserver(logicObs); } - private void registerLogicObs(LogicObservable observable) + /** + * Returns whether this {@link GUIWire} has a logic model binding or not. + * + * @author Daniel Kirschten + */ + public boolean hasLogicModelBinding() { - if (observable != null) - observable.registerObserver(logicObs); + return end != null; } - private void deregisterLogicObs(LogicObservable observable) + /** + * If this {@link GUIWire} has a logic model binding, delegates to {@link Wire#forceValues(BitVector)} for the {@link Wire} + * corresponding to this {@link GUIWire}. + * + * @author Daniel Kirschten + */ + public void forceWireValues(BitVector values) { - if (observable != null) - observable.deregisterObserver(logicObs); + end.getWire().forceValues(values); } - public Pin getPin1() + /** + * If this {@link GUIWire} has a logic model binding, delegates to {@link ReadEnd#getValues()} for the {@link ReadEnd} corresponding to + * this {@link GUIWire}. + * + * @author Daniel Kirschten + */ + public BitVector getWireValues() { - return pin1; + return end.getValues(); } - public Pin getPin2() - { - return pin2; - } + // listeners // @formatter:off public void addRedrawListener (Runnable listener) {redrawListeners .add (listener);} @@ -193,4 +356,9 @@ public class GUIWire private void callRedrawListeners() {redrawListeners.forEach(l -> l.run());} // @formatter:on + @Override + public String toString() + { + return "GUIWire [" + pin1 + "---" + pin2 + ", value=" + (end == null ? "null" : end.getValues()) + "]"; + } } \ No newline at end of file