1 package net.mograsim.logic.model.model.components.submodels;
3 import java.util.Collections;
4 import java.util.HashMap;
6 import java.util.Map.Entry;
7 import java.util.function.Consumer;
9 import net.haspamelodica.swt.helper.gcs.GCConfig;
10 import net.haspamelodica.swt.helper.gcs.GeneralGC;
11 import net.haspamelodica.swt.helper.gcs.TranslatedGC;
12 import net.haspamelodica.swt.helper.swtobjectwrappers.Rectangle;
13 import net.mograsim.logic.model.LogicUIRenderer;
14 import net.mograsim.logic.model.model.ViewModel;
15 import net.mograsim.logic.model.model.ViewModelModifiable;
16 import net.mograsim.logic.model.model.components.GUIComponent;
17 import net.mograsim.logic.model.model.wires.MovablePin;
18 import net.mograsim.logic.model.model.wires.Pin;
19 import net.mograsim.logic.model.model.wires.PinUsage;
20 import net.mograsim.logic.model.serializing.IdentifierGetter;
21 import net.mograsim.logic.model.serializing.IndirectGUIComponentCreator;
22 import net.mograsim.logic.model.serializing.SubmodelComponentParams;
23 import net.mograsim.logic.model.serializing.SubmodelComponentSerializer;
24 import net.mograsim.logic.model.snippets.Renderer;
25 import net.mograsim.logic.model.util.JsonHandler;
28 * A {@link GUIComponent} consisting of another model. A <code>SubmodelComponent</code> can have so-called "interface pins" connecting the
29 * inner and outer models.
31 public abstract class SubmodelComponent extends GUIComponent
33 public static final String SUBMODEL_INTERFACE_NAME = "_submodelinterface";
35 * A modifiable view of {@link #submodel}.
37 protected final ViewModelModifiable submodelModifiable;
39 * The model this {@link SubmodelComponent} consists of.
41 public final ViewModel submodel;
43 * The list of all submodel interface pins of this {@link SubmodelComponent} on the submodel side.
45 private final Map<String, MovablePin> submodelPins;
47 * An unmodifiable view of {@link #submodelPins}.
49 private final Map<String, MovablePin> submodelMovablePinsUnmodifiable;
51 * An unmodifiable view of {@link #submodelPins} where pins are not movable.
53 private final Map<String, Pin> submodelUnmovablePinsUnmodifiable;
55 * The list of all submodel interface pins of this {@link SubmodelComponent} on the supermodel side.
57 private final Map<String, MovablePin> supermodelPins;
59 * An unmodifiable view of {@link #supermodelPins}.
61 private final Map<String, MovablePin> supermodelMovablePinsUnmodifiable;
63 * An unmodifiable view of {@link #supermodelPins} where pins are not movable.
65 private final Map<String, Pin> supermodelUnmovablePinsUnmodifiable;
67 * A pseudo-component containing all submodel interface pins on the submodel side.
69 private final SubmodelInterface submodelInterface;
72 * The factor by which the submodel is scaled when rendering.
74 private double submodelScale;
76 * If this {@link SubmodelComponent} fills at least this amount of the visible region vertically or horizontally, the submodel starts to
79 private double maxVisibleRegionFillRatioForAlpha0;
81 * If this {@link SubmodelComponent} fills at least this amount of the visible region vertically or horizontally, the submodel is fully
84 private double minVisibleRegionFillRatioForAlpha1;
86 * The renderer used for rendering the submodel.
88 private final LogicUIRenderer renderer;
91 * The {@link Renderer} used to render the symbol of this SubmodelCoponent.
93 private Renderer symbolRenderer;
95 * The {@link Renderer} used to render the outline of this SubmodelCoponent.
97 private Renderer outlineRenderer;
99 // creation and destruction
101 public SubmodelComponent(ViewModelModifiable model, String name)
104 this.submodelModifiable = new ViewModelModifiable();
105 this.submodel = submodelModifiable;
106 this.submodelPins = new HashMap<>();
107 this.submodelMovablePinsUnmodifiable = Collections.unmodifiableMap(submodelPins);
108 this.submodelUnmovablePinsUnmodifiable = Collections.unmodifiableMap(submodelPins);
109 this.supermodelPins = new HashMap<>();
110 this.supermodelMovablePinsUnmodifiable = Collections.unmodifiableMap(supermodelPins);
111 this.supermodelUnmovablePinsUnmodifiable = Collections.unmodifiableMap(supermodelPins);
112 this.submodelInterface = new SubmodelInterface(submodelModifiable, SUBMODEL_INTERFACE_NAME);
114 this.submodelScale = 1;
115 this.maxVisibleRegionFillRatioForAlpha0 = 0.8;
116 this.minVisibleRegionFillRatioForAlpha1 = 0.9;
117 this.renderer = new LogicUIRenderer(submodelModifiable);
119 Consumer<Runnable> redrawHandlerChangedListener = submodelModifiable::setRedrawHandler;
120 model.addRedrawHandlerChangedListener(redrawHandlerChangedListener);
121 model.addComponentRemovedListener(c ->
124 model.removeRedrawHandlerChangedListener(redrawHandlerChangedListener);
126 submodelModifiable.setRedrawHandler(model.getRedrawHandler());
132 * Adds a new submodel interface pin.
134 * @param supermodelPin the submodel interface pin on the supermodel side
136 * @return the submodel interface pin on the submodel side
138 * @author Daniel Kirschten
140 protected Pin addSubmodelInterface(MovablePin supermodelPin)
142 super.addPin(supermodelPin);// do this first to be fail-fast if the supermodel does not belong to this component
144 String name = supermodelPin.name;
145 // TODO if we upgrade to Java 12, replace with switch-expression
146 PinUsage submodelPinUsage;
147 switch (supermodelPin.usage)
150 submodelPinUsage = PinUsage.OUTPUT;
153 submodelPinUsage = PinUsage.INPUT;
156 submodelPinUsage = PinUsage.TRISTATE;
159 throw new IllegalArgumentException("Unknown enum constant: " + supermodelPin.usage);
161 MovablePin submodelPin = new MovablePin(submodelInterface, name, supermodelPin.logicWidth, submodelPinUsage,
162 supermodelPin.getRelX() / submodelScale, supermodelPin.getRelY() / submodelScale);
164 submodelPin.addPinMovedListener(p ->
166 double newRelX = p.getRelX() * submodelScale;
167 double newRelY = p.getRelY() * submodelScale;
168 if (supermodelPin.getRelX() != newRelX || supermodelPin.getRelY() != newRelY)
169 supermodelPin.setRelPos(newRelX, newRelY);
171 supermodelPin.addPinMovedListener(p ->
173 double newRelX = p.getRelX() / submodelScale;
174 double newRelY = p.getRelY() / submodelScale;
175 if (submodelPin.getRelX() != newRelX || submodelPin.getRelY() != newRelY)
176 submodelPin.setRelPos(newRelX, newRelY);
179 submodelInterface.addPin(submodelPin);
181 submodelPins.put(name, submodelPin);
182 supermodelPins.put(name, supermodelPin);
184 // no need to call requestRedraw() because addPin() will request a redraw
189 * Removes a submodel interface pin.
191 * @author Daniel Kirschten
193 protected void removeSubmodelInterface(String name)
195 super.removePin(name);// do this first to be fail-fast if this component doesn't have a pin with the given name
196 Pin submodelPin = submodelPins.remove(name);
197 submodelInterface.removePin(submodelPin.name);
198 supermodelPins.remove(name);
200 // no need to call requestRedraw() because removePin() will request a redraw
204 * Returns a collection of submodel interface pins on the submodel side of this component.
206 * @author Daniel Kirschten
208 public Map<String, Pin> getSubmodelPins()
210 return submodelUnmovablePinsUnmodifiable;
214 * Returns the submodel interface pin with the given name on the submodel side of this component.
216 * @author Daniel Kirschten
218 public Pin getSubmodelPin(String name)
220 return getSubmodelMovablePin(name);
224 * Returns a collection of movable submodel interface pins on the submodel side of this component.
226 * @author Daniel Kirschten
228 protected Map<String, MovablePin> getSubmodelMovablePins()
230 return submodelMovablePinsUnmodifiable;
234 * Returns the movable submodel interface pin with the given name on the submodel side of this component.
236 * @author Daniel Kirschten
238 protected MovablePin getSubmodelMovablePin(String name)
240 return submodelPins.get(name);
244 * Returns a collection of submodel interface pins on the supermodel side of this component.
246 * @author Daniel Kirschten
248 public Map<String, Pin> getSupermodelPins()
250 return supermodelUnmovablePinsUnmodifiable;
254 * Returns the submodel interface pin with the given name on the supermodel side of this component.
256 * @author Daniel Kirschten
258 public Pin getSupermodelPin(String name)
260 return getSupermodelMovablePin(name);
264 * Returns a collection of movable submodel interface pins on the supermodel side of this component.
266 * @author Daniel Kirschten
268 protected Map<String, MovablePin> getSupermodelMovablePins()
270 return supermodelMovablePinsUnmodifiable;
274 * Returns the movable submodel interface pin with the given name on the supermodel side of this component.
276 * @author Daniel Kirschten
278 protected MovablePin getSupermodelMovablePin(String name)
280 return supermodelPins.get(name);
283 // "graphical" operations
286 * Sets the factor by which the submodel is scaled when rendering and calls redrawListeners. Note that the submodel interface pins will
287 * stay at their position relative to the supermodel, which means they will move relative to the submodel.
289 * @author Daniel Kirschten
291 protected void setSubmodelScale(double submodelScale)
293 this.submodelScale = submodelScale;
295 for (Entry<String, MovablePin> e : supermodelPins.entrySet())
296 getSubmodelMovablePin(e.getKey()).setRelPos(e.getValue().getRelX() * submodelScale, e.getValue().getRelY() * submodelScale);
298 model.requestRedraw();// needed if there is no submodel interface pin
302 * Returns the current factor by which the submodel is scaled when rendering.
304 * @author Daniel Kirschten
306 public double getSubmodelScale()
308 return submodelScale;
312 * @see #renderSymbol(GeneralGC, Rectangle)
314 * @author Daniel Kirschten
316 protected void setSymbolRenderer(Renderer symbolRenderer)
318 this.symbolRenderer = symbolRenderer;
319 model.requestRedraw();
323 * @see #renderSymbol(GeneralGC, Rectangle)
325 * @author Daniel Kirschten
327 public Renderer getSymbolRenderer()
329 return symbolRenderer;
333 * @see #renderOutline(GeneralGC, Rectangle)
335 * @author Daniel Kirschten
337 protected void setOutlineRenderer(Renderer outlineRenderer)
339 this.outlineRenderer = outlineRenderer;
340 model.requestRedraw();
344 * @see #renderOutline(GeneralGC, Rectangle)
346 * @author Daniel Kirschten
348 public Renderer getOutlineRenderer()
350 return outlineRenderer;
354 public boolean clicked(double x, double y)
356 double scaledX = (x - getPosX()) / submodelScale;
357 double scaledY = (y - getPosY()) / submodelScale;
358 for (GUIComponent component : submodel.getComponentsByName().values())
359 if (component.getBounds().contains(scaledX, scaledY) && component.clicked(scaledX, scaledY))
365 public void render(GeneralGC gc, Rectangle visibleRegion)
367 GCConfig conf = new GCConfig(gc);
368 TranslatedGC tgc = new TranslatedGC(gc, getPosX(), getPosY(), submodelScale, true);
370 double visibleRegionFillRatio = Math.max(getWidth() / visibleRegion.width, getHeight() / visibleRegion.height);
371 double alphaFactor = map(visibleRegionFillRatio, maxVisibleRegionFillRatioForAlpha0, minVisibleRegionFillRatioForAlpha1, 0, 1);
372 alphaFactor = Math.max(0, Math.min(1, alphaFactor));
373 // we need to take the old alpha into account to support nested submodules better.
374 int oldAlpha = gc.getAlpha();
375 int submodelAlpha = Math.max(0, Math.min(255, (int) (oldAlpha * alphaFactor)));
376 int labelAlpha = Math.max(0, Math.min(255, (int) (oldAlpha * (1 - alphaFactor))));
377 if (submodelAlpha != 0)
379 gc.setAlpha(submodelAlpha);
380 renderer.render(tgc, visibleRegion.translate(getPosX() / submodelScale, getPosY() / submodelScale, 1 / submodelScale));
384 gc.setAlpha(labelAlpha);
385 renderSymbol(gc, visibleRegion);
388 // draw the outline after all other operations to make interface pins look better
389 renderOutline(gc, visibleRegion);
393 * Render the symbol of this {@link SubmodelComponent}, e.g. the things that should be hidden if the submodel is drawn.
395 * @author Daniel Kirschten
397 protected void renderSymbol(GeneralGC gc, Rectangle visibleRegion)
399 if (symbolRenderer != null)
400 symbolRenderer.render(gc, visibleRegion);
404 * Render the outline of this {@link SubmodelComponent}, e.g. the graphical elements that should stay visible if the submodel is drawn.
406 * @author Daniel Kirschten
408 protected void renderOutline(GeneralGC gc, Rectangle visibleRegion)
410 if (outlineRenderer != null)
411 outlineRenderer.render(gc, visibleRegion);
414 private static double map(double val, double valMin, double valMax, double mapMin, double mapMax)
416 return mapMin + (val - valMin) * (mapMax - mapMin) / (valMax - valMin);
422 public SubmodelComponentParams getParamsForSerializing(IdentifierGetter idGetter)
424 return SubmodelComponentSerializer.serialize(this, idGetter);
427 // operations no longer supported
430 protected void addPin(Pin pin)
432 throw new UnsupportedOperationException("Can't add pins to a SubmodelComponent directly, call addSubmodelInterface instead");
436 protected void removePin(String name)
438 throw new UnsupportedOperationException("Can't remove pins of a SubmodelComponent directly, call removeSubmodelInterface instead");
443 IndirectGUIComponentCreator.setComponentSupplier(SubmodelComponent.class.getCanonicalName(),
444 (m, p, n) -> SubmodelComponentSerializer.deserialize(m, JsonHandler.fromJsonTree(p, SubmodelComponentParams.class), n));