7a2fcf4b4cbf8bea9f82c4234c1ac9b9e6b9c8bf
[Mograsim.git] / net.mograsim.logic.ui / src / net / mograsim / logic / ui / model / wires / WireCrossPoint.java
1 package net.mograsim.logic.ui.model.wires;
2
3 import com.google.gson.JsonElement;
4 import com.google.gson.JsonPrimitive;
5
6 import net.haspamelodica.swt.helper.gcs.GeneralGC;
7 import net.haspamelodica.swt.helper.swtobjectwrappers.Rectangle;
8 import net.mograsim.logic.core.LogicObserver;
9 import net.mograsim.logic.core.types.BitVectorFormatter;
10 import net.mograsim.logic.core.wires.Wire.ReadEnd;
11 import net.mograsim.logic.ui.model.ViewModelModifiable;
12 import net.mograsim.logic.ui.model.components.GUIComponent;
13 import net.mograsim.logic.ui.serializing.IndirectGUIComponentCreator;
14 import net.mograsim.preferences.ColorDefinition;
15 import net.mograsim.preferences.ColorManager;
16
17 /**
18  * A {@link GUIComponent} with only one pin. Is used to create wires connecting more than two pins. <br>
19  * Example: There are three pins <code>P1</code>, <code>P2</code>, <code>P3</code> that need to be connected. Solution: Create a
20  * WireCrossPoint (<code>WCP</code>) and create the GUIWires <code>P1</code>-<code>WCP</code>, <code>P2</code>-<code>WCP</code>,
21  * <code>P3</code>-<code>WCP</code>.<br>
22  * Cross points are drawn as circles. The pin of cross points is in the center of this circle.
23  * 
24  * @author Daniel Kirschten
25  */
26 public class WireCrossPoint extends GUIComponent
27 {
28         private static final int CIRCLE_RADIUS = 1;
29         private static final int CIRCLE_DIAM = CIRCLE_RADIUS * 2;
30
31         /**
32          * The (single) pin of this cross point.
33          */
34         private final Pin pin;
35
36         /**
37          * A {@link LogicObserver} calling {@link #requestRedraw()}.
38          */
39         private final LogicObserver logicObs;
40         /**
41          * The {@link ReadEnd} currently bound to this cross point.
42          */
43         private ReadEnd end;
44
45         // creation and destruction
46
47         public WireCrossPoint(ViewModelModifiable model, int logicWidth)
48         {
49                 super(model);
50                 logicObs = (i) -> requestRedraw();
51
52                 setSize(CIRCLE_DIAM, CIRCLE_DIAM);
53                 addPin(this.pin = new Pin(this, "", logicWidth, CIRCLE_RADIUS, CIRCLE_RADIUS));
54         }
55
56         // pins
57
58         public Pin getPin()
59         {
60                 return pin;
61         }
62
63         // "graphical" operations
64
65         /**
66          * Moves the center (and therefore the pin) of this {@link WireCrossPoint} to the given location.
67          * 
68          * @author Daniel Kirschten
69          */
70         public void moveCenterTo(double x, double y)
71         {
72                 moveTo(x - CIRCLE_RADIUS, y - CIRCLE_RADIUS);
73         }
74
75         @Override
76         public void render(GeneralGC gc, Rectangle visibleRegion)
77         {
78                 ColorDefinition wireColor = BitVectorFormatter.formatAsColor(end);
79                 if (wireColor != null)
80                         gc.setBackground(ColorManager.current().toColor(wireColor));
81                 gc.fillOval(getPosX(), getPosY(), CIRCLE_DIAM, CIRCLE_DIAM);
82         }
83
84         // logic model binding
85
86         /**
87          * Binds this {@link WireCrossPoint} to the given {@link ReadEnd}: The color of this {@link WireCrossPoint} will now depend on the state
88          * of the given {@link ReadEnd}, and further changes of the given {@link ReadEnd} will result in readrawListeners being called.<br>
89          * The argument can be null, in which case the old binding is stopped.
90          * 
91          * @author Daniel Kirschten
92          */
93         public void setLogicModelBinding(ReadEnd end)
94         {
95                 if (this.end != null)
96                         this.end.deregisterObserver(logicObs);
97                 this.end = end;
98                 if (end != null)
99                         end.registerObserver(logicObs);
100         }
101
102         /**
103          * Returns whether this {@link WireCrossPoint} has a logic model binding or not.
104          */
105         public boolean hasLogicModelBinding()
106         {
107                 return end != null;
108         }
109
110         // serializing
111
112         @Override
113         public JsonElement getParams()
114         {
115                 return new JsonPrimitive(pin.logicWidth);
116         }
117
118         static
119         {
120                 IndirectGUIComponentCreator.setComponentProvider(WireCrossPoint.class.getCanonicalName(),
121                                 (m, p) -> new WireCrossPoint(m, p.getAsInt()));
122         }
123 }