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.snippets.Renderer;
23 * A {@link GUIComponent} consisting of another model. A <code>SubmodelComponent</code> can have so-called "interface pins" connecting the
24 * inner and outer models.
26 //TODO override getParams
27 public abstract class SubmodelComponent extends GUIComponent
29 public static final String SUBMODEL_INTERFACE_NAME = "_submodelinterface";
31 * A modifiable view of {@link #submodel}.
33 protected final ViewModelModifiable submodelModifiable;
35 * The model this {@link SubmodelComponent} consists of.
37 public final ViewModel submodel;
39 * The list of all submodel interface pins of this {@link SubmodelComponent} on the submodel side.
41 private final Map<String, MovablePin> submodelPins;
43 * An unmodifiable view of {@link #submodelPins}.
45 private final Map<String, MovablePin> submodelMovablePinsUnmodifiable;
47 * An unmodifiable view of {@link #submodelPins} where pins are not movable.
49 private final Map<String, Pin> submodelUnmovablePinsUnmodifiable;
51 * The list of all submodel interface pins of this {@link SubmodelComponent} on the supermodel side.
53 private final Map<String, MovablePin> supermodelPins;
55 * An unmodifiable view of {@link #supermodelPins}.
57 private final Map<String, MovablePin> supermodelMovablePinsUnmodifiable;
59 * An unmodifiable view of {@link #supermodelPins} where pins are not movable.
61 private final Map<String, Pin> supermodelUnmovablePinsUnmodifiable;
63 * A pseudo-component containing all submodel interface pins on the submodel side.
65 private final SubmodelInterface submodelInterface;
68 * The factor by which the submodel is scaled when rendering.
70 private double submodelScale;
72 * If this {@link SubmodelComponent} fills at least this amount of the visible region vertically or horizontally, the submodel starts to
75 private double maxVisibleRegionFillRatioForAlpha0;
77 * If this {@link SubmodelComponent} fills at least this amount of the visible region vertically or horizontally, the submodel is fully
80 private double minVisibleRegionFillRatioForAlpha1;
82 * The renderer used for rendering the submodel.
84 private final LogicUIRenderer renderer;
87 * The {@link Renderer} used to render the symbol of this SubmodelCoponent.
89 private Renderer symbolRenderer;
91 * The {@link Renderer} used to render the outline of this SubmodelCoponent.
93 private Renderer outlineRenderer;
95 // creation and destruction
97 public SubmodelComponent(ViewModelModifiable model, String name)
100 this.submodelModifiable = new ViewModelModifiable();
101 this.submodel = submodelModifiable;
102 this.submodelPins = new HashMap<>();
103 this.submodelMovablePinsUnmodifiable = Collections.unmodifiableMap(submodelPins);
104 this.submodelUnmovablePinsUnmodifiable = Collections.unmodifiableMap(submodelPins);
105 this.supermodelPins = new HashMap<>();
106 this.supermodelMovablePinsUnmodifiable = Collections.unmodifiableMap(supermodelPins);
107 this.supermodelUnmovablePinsUnmodifiable = Collections.unmodifiableMap(supermodelPins);
108 this.submodelInterface = new SubmodelInterface(submodelModifiable, SUBMODEL_INTERFACE_NAME);
110 this.submodelScale = 1;
111 this.maxVisibleRegionFillRatioForAlpha0 = 0.8;
112 this.minVisibleRegionFillRatioForAlpha1 = 0.9;
113 this.renderer = new LogicUIRenderer(submodelModifiable);
115 Consumer<Runnable> redrawHandlerChangedListener = submodelModifiable::setRedrawHandler;
116 model.addRedrawHandlerChangedListener(redrawHandlerChangedListener);
117 model.addComponentRemovedListener(c ->
120 model.removeRedrawHandlerChangedListener(redrawHandlerChangedListener);
122 submodelModifiable.setRedrawHandler(model.getRedrawHandler());
128 * Adds a new submodel interface pin.
130 * @param supermodelPin the submodel interface pin on the supermodel side
132 * @return the submodel interface pin on the submodel side
134 * @author Daniel Kirschten
136 protected Pin addSubmodelInterface(MovablePin supermodelPin)
138 super.addPin(supermodelPin);// do this first to be fail-fast if the supermodel does not belong to this component
140 String name = supermodelPin.name;
141 // TODO if we upgrade to Java 12, replace with switch-expression
142 PinUsage submodelPinUsage;
143 switch (supermodelPin.usage)
146 submodelPinUsage = PinUsage.OUTPUT;
149 submodelPinUsage = PinUsage.INPUT;
152 submodelPinUsage = PinUsage.TRISTATE;
155 throw new IllegalArgumentException("Unknown enum constant: " + supermodelPin.usage);
157 MovablePin submodelPin = new MovablePin(submodelInterface, name, supermodelPin.logicWidth, submodelPinUsage,
158 supermodelPin.getRelX() / submodelScale, supermodelPin.getRelY() / submodelScale);
160 submodelPin.addPinMovedListener(p ->
162 double newRelX = p.getRelX() * submodelScale;
163 double newRelY = p.getRelY() * submodelScale;
164 if (supermodelPin.getRelX() != newRelX || supermodelPin.getRelY() != newRelY)
165 supermodelPin.setRelPos(newRelX, newRelY);
167 supermodelPin.addPinMovedListener(p ->
169 double newRelX = p.getRelX() / submodelScale;
170 double newRelY = p.getRelY() / submodelScale;
171 if (submodelPin.getRelX() != newRelX || submodelPin.getRelY() != newRelY)
172 submodelPin.setRelPos(newRelX, newRelY);
175 submodelInterface.addPin(submodelPin);
177 submodelPins.put(name, submodelPin);
178 supermodelPins.put(name, supermodelPin);
180 // no need to call requestRedraw() because addPin() will request a redraw
185 * Removes a submodel interface pin.
187 * @author Daniel Kirschten
189 protected void removeSubmodelInterface(String name)
191 super.removePin(name);// do this first to be fail-fast if this component doesn't have a pin with the given name
192 Pin submodelPin = submodelPins.remove(name);
193 submodelInterface.removePin(submodelPin.name);
194 supermodelPins.remove(name);
196 // no need to call requestRedraw() because removePin() will request a redraw
200 * Returns a collection of submodel interface pins on the submodel side of this component.
202 * @author Daniel Kirschten
204 public Map<String, Pin> getSubmodelPins()
206 return submodelUnmovablePinsUnmodifiable;
210 * Returns the submodel interface pin with the given name on the submodel side of this component.
212 * @author Daniel Kirschten
214 public Pin getSubmodelPin(String name)
216 return getSubmodelMovablePin(name);
220 * Returns a collection of movable submodel interface pins on the submodel side of this component.
222 * @author Daniel Kirschten
224 protected Map<String, MovablePin> getSubmodelMovablePins()
226 return submodelMovablePinsUnmodifiable;
230 * Returns the movable submodel interface pin with the given name on the submodel side of this component.
232 * @author Daniel Kirschten
234 protected MovablePin getSubmodelMovablePin(String name)
236 return submodelPins.get(name);
240 * Returns a collection of submodel interface pins on the supermodel side of this component.
242 * @author Daniel Kirschten
244 public Map<String, Pin> getSupermodelPins()
246 return supermodelUnmovablePinsUnmodifiable;
250 * Returns the submodel interface pin with the given name on the supermodel side of this component.
252 * @author Daniel Kirschten
254 public Pin getSupermodelPin(String name)
256 return getSupermodelMovablePin(name);
260 * Returns a collection of movable submodel interface pins on the supermodel side of this component.
262 * @author Daniel Kirschten
264 protected Map<String, MovablePin> getSupermodelMovablePins()
266 return supermodelMovablePinsUnmodifiable;
270 * Returns the movable submodel interface pin with the given name on the supermodel side of this component.
272 * @author Daniel Kirschten
274 protected MovablePin getSupermodelMovablePin(String name)
276 return supermodelPins.get(name);
279 // "graphical" operations
282 * Sets the factor by which the submodel is scaled when rendering and calls redrawListeners. Note that the submodel interface pins will
283 * stay at their position relative to the supermodel, which means they will move relative to the submodel.
285 * @author Daniel Kirschten
287 protected void setSubmodelScale(double submodelScale)
289 this.submodelScale = submodelScale;
291 for (Entry<String, MovablePin> e : supermodelPins.entrySet())
292 getSubmodelMovablePin(e.getKey()).setRelPos(e.getValue().getRelX() * submodelScale, e.getValue().getRelY() * submodelScale);
294 model.requestRedraw();// needed if there is no submodel interface pin
298 * Returns the current factor by which the submodel is scaled when rendering.
300 * @author Daniel Kirschten
302 public double getSubmodelScale()
304 return submodelScale;
308 * @see #renderSymbol(GeneralGC, Rectangle)
310 * @author Daniel Kirschten
312 protected void setSymbolRenderer(Renderer symbolRenderer)
314 this.symbolRenderer = symbolRenderer;
315 model.requestRedraw();
319 * @see #renderSymbol(GeneralGC, Rectangle)
321 * @author Daniel Kirschten
323 public Renderer getSymbolRenderer()
325 return symbolRenderer;
329 * @see #renderOutline(GeneralGC, Rectangle)
331 * @author Daniel Kirschten
333 protected void setOutlineRenderer(Renderer outlineRenderer)
335 this.outlineRenderer = outlineRenderer;
336 model.requestRedraw();
340 * @see #renderOutline(GeneralGC, Rectangle)
342 * @author Daniel Kirschten
344 public Renderer getOutlineRenderer()
346 return outlineRenderer;
350 public void render(GeneralGC gc, Rectangle visibleRegion)
352 GCConfig conf = new GCConfig(gc);
353 TranslatedGC tgc = new TranslatedGC(gc, getPosX(), getPosY(), submodelScale, true);
355 double visibleRegionFillRatio = Math.max(getWidth() / visibleRegion.width, getHeight() / visibleRegion.height);
356 double alphaFactor = map(visibleRegionFillRatio, maxVisibleRegionFillRatioForAlpha0, minVisibleRegionFillRatioForAlpha1, 0, 1);
357 alphaFactor = Math.max(0, Math.min(1, alphaFactor));
358 // we need to take the old alpha into account to support nested submodules better.
359 int oldAlpha = gc.getAlpha();
360 int submodelAlpha = Math.max(0, Math.min(255, (int) (oldAlpha * alphaFactor)));
361 int labelAlpha = Math.max(0, Math.min(255, (int) (oldAlpha * (1 - alphaFactor))));
362 if (submodelAlpha != 0)
364 gc.setAlpha(submodelAlpha);
365 renderer.render(tgc, visibleRegion.translate(getPosX() / submodelScale, getPosY() / submodelScale, 1 / submodelScale));
369 gc.setAlpha(labelAlpha);
370 renderSymbol(gc, visibleRegion);
373 // draw the outline after all other operations to make interface pins look better
374 renderOutline(gc, visibleRegion);
378 * Render the symbol of this {@link SubmodelComponent}, e.g. the things that should be hidden if the submodel is drawn.
380 * @author Daniel Kirschten
382 protected void renderSymbol(GeneralGC gc, Rectangle visibleRegion)
384 if (symbolRenderer != null)
385 symbolRenderer.render(gc, visibleRegion);
389 * Render the outline of this {@link SubmodelComponent}, e.g. the graphical elements that should stay visible if the submodel is drawn.
391 * @author Daniel Kirschten
393 protected void renderOutline(GeneralGC gc, Rectangle visibleRegion)
395 if (outlineRenderer != null)
396 outlineRenderer.render(gc, visibleRegion);
399 private static double map(double val, double valMin, double valMax, double mapMin, double mapMax)
401 return mapMin + (val - valMin) * (mapMax - mapMin) / (valMax - valMin);
405 public boolean clicked(double x, double y)
407 double scaledX = (x - getPosX()) / submodelScale;
408 double scaledY = (y - getPosY()) / submodelScale;
409 for (GUIComponent component : submodel.getComponentsByName().values())
410 if (component.getBounds().contains(scaledX, scaledY) && component.clicked(scaledX, scaledY))
415 // operations no longer supported
418 protected void addPin(Pin pin)
420 throw new UnsupportedOperationException("Can't add pins to a SubmodelComponent directly, call addSubmodelInterface instead");
424 protected void removePin(String name)
426 throw new UnsupportedOperationException("Can't remove pins of a SubmodelComponent directly, call removeSubmodelInterface instead");