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.snippets.Renderer;
22 * A {@link GUIComponent} consisting of another model. A <code>SubmodelComponent</code> can have so-called "interface pins" connecting the
23 * inner and outer models.
25 //TODO override getParams
26 public abstract class SubmodelComponent extends GUIComponent
28 public static final String SUBMODEL_INTERFACE_NAME = "_submodelinterface";
30 * A modifiable view of {@link #submodel}.
32 protected final ViewModelModifiable submodelModifiable;
34 * The model this {@link SubmodelComponent} consists of.
36 public final ViewModel submodel;
38 * The list of all submodel interface pins of this {@link SubmodelComponent} on the submodel side.
40 private final Map<String, MovablePin> submodelPins;
42 * An unmodifiable view of {@link #submodelPins}.
44 private final Map<String, MovablePin> submodelMovablePinsUnmodifiable;
46 * An unmodifiable view of {@link #submodelPins} where pins are not movable.
48 private final Map<String, Pin> submodelUnmovablePinsUnmodifiable;
50 * The list of all submodel interface pins of this {@link SubmodelComponent} on the supermodel side.
52 private final Map<String, MovablePin> supermodelPins;
54 * An unmodifiable view of {@link #supermodelPins}.
56 private final Map<String, MovablePin> supermodelMovablePinsUnmodifiable;
58 * An unmodifiable view of {@link #supermodelPins} where pins are not movable.
60 private final Map<String, Pin> supermodelUnmovablePinsUnmodifiable;
62 * A pseudo-component containing all submodel interface pins on the submodel side.
64 private final SubmodelInterface submodelInterface;
67 * The factor by which the submodel is scaled when rendering.
69 private double submodelScale;
71 * If this {@link SubmodelComponent} fills at least this amount of the visible region vertically or horizontally, the submodel starts to
74 private double maxVisibleRegionFillRatioForAlpha0;
76 * If this {@link SubmodelComponent} fills at least this amount of the visible region vertically or horizontally, the submodel is fully
79 private double minVisibleRegionFillRatioForAlpha1;
81 * The renderer used for rendering the submodel.
83 private final LogicUIRenderer renderer;
86 * The {@link Renderer} used to render the symbol of this SubmodelCoponent.
88 private Renderer symbolRenderer;
90 * The {@link Renderer} used to render the outline of this SubmodelCoponent.
92 private Renderer outlineRenderer;
94 // creation and destruction
96 public SubmodelComponent(ViewModelModifiable model, String name)
99 this.submodelModifiable = new ViewModelModifiable();
100 this.submodel = submodelModifiable;
101 this.submodelPins = new HashMap<>();
102 this.submodelMovablePinsUnmodifiable = Collections.unmodifiableMap(submodelPins);
103 this.submodelUnmovablePinsUnmodifiable = Collections.unmodifiableMap(submodelPins);
104 this.supermodelPins = new HashMap<>();
105 this.supermodelMovablePinsUnmodifiable = Collections.unmodifiableMap(supermodelPins);
106 this.supermodelUnmovablePinsUnmodifiable = Collections.unmodifiableMap(supermodelPins);
107 this.submodelInterface = new SubmodelInterface(submodelModifiable, SUBMODEL_INTERFACE_NAME);
109 this.submodelScale = 1;
110 this.maxVisibleRegionFillRatioForAlpha0 = 0.8;
111 this.minVisibleRegionFillRatioForAlpha1 = 0.9;
112 this.renderer = new LogicUIRenderer(submodelModifiable);
114 Consumer<Runnable> redrawHandlerChangedListener = submodelModifiable::setRedrawHandler;
115 model.addRedrawHandlerChangedListener(redrawHandlerChangedListener);
116 model.addComponentRemovedListener(c ->
119 model.removeRedrawHandlerChangedListener(redrawHandlerChangedListener);
121 submodelModifiable.setRedrawHandler(model.getRedrawHandler());
127 * Adds a new submodel interface pin.
129 * @param supermodelPin the submodel interface pin on the supermodel side
131 * @return the submodel interface pin on the submodel side
133 * @author Daniel Kirschten
135 protected Pin addSubmodelInterface(MovablePin supermodelPin)
137 super.addPin(supermodelPin);// do this first to be fail-fast if the supermodel does not belong to this component
139 String name = supermodelPin.name;
140 MovablePin submodelPin = new MovablePin(submodelInterface, name, supermodelPin.logicWidth, supermodelPin.getRelX() / submodelScale,
141 supermodelPin.getRelY() / submodelScale);
143 submodelPin.addPinMovedListener(p ->
145 double newRelX = p.getRelX() * submodelScale;
146 double newRelY = p.getRelY() * submodelScale;
147 if (supermodelPin.getRelX() != newRelX || supermodelPin.getRelY() != newRelY)
148 supermodelPin.setRelPos(newRelX, newRelY);
150 supermodelPin.addPinMovedListener(p ->
152 double newRelX = p.getRelX() / submodelScale;
153 double newRelY = p.getRelY() / submodelScale;
154 if (submodelPin.getRelX() != newRelX || submodelPin.getRelY() != newRelY)
155 submodelPin.setRelPos(newRelX, newRelY);
158 submodelInterface.addPin(submodelPin);
160 submodelPins.put(name, submodelPin);
161 supermodelPins.put(name, supermodelPin);
163 // no need to call requestRedraw() because addPin() will request a redraw
168 * Removes a submodel interface pin.
170 * @author Daniel Kirschten
172 protected void removeSubmodelInterface(String name)
174 super.removePin(name);// do this first to be fail-fast if this component doesn't have a pin with the given name
175 Pin submodelPin = submodelPins.remove(name);
176 submodelInterface.removePin(submodelPin.name);
177 supermodelPins.remove(name);
179 // no need to call requestRedraw() because removePin() will request a redraw
183 * Returns a collection of submodel interface pins on the submodel side of this component.
185 * @author Daniel Kirschten
187 public Map<String, Pin> getSubmodelPins()
189 return submodelUnmovablePinsUnmodifiable;
193 * Returns the submodel interface pin with the given name on the submodel side of this component.
195 * @author Daniel Kirschten
197 public Pin getSubmodelPin(String name)
199 return getSubmodelMovablePin(name);
203 * Returns a collection of movable submodel interface pins on the submodel side of this component.
205 * @author Daniel Kirschten
207 protected Map<String, MovablePin> getSubmodelMovablePins()
209 return submodelMovablePinsUnmodifiable;
213 * Returns the movable submodel interface pin with the given name on the submodel side of this component.
215 * @author Daniel Kirschten
217 protected MovablePin getSubmodelMovablePin(String name)
219 return submodelPins.get(name);
223 * Returns a collection of submodel interface pins on the supermodel side of this component.
225 * @author Daniel Kirschten
227 public Map<String, Pin> getSupermodelPins()
229 return supermodelUnmovablePinsUnmodifiable;
233 * Returns the submodel interface pin with the given name on the supermodel side of this component.
235 * @author Daniel Kirschten
237 public Pin getSupermodelPin(String name)
239 return getSupermodelMovablePin(name);
243 * Returns a collection of movable submodel interface pins on the supermodel side of this component.
245 * @author Daniel Kirschten
247 protected Map<String, MovablePin> getSupermodelMovablePins()
249 return supermodelMovablePinsUnmodifiable;
253 * Returns the movable submodel interface pin with the given name on the supermodel side of this component.
255 * @author Daniel Kirschten
257 protected MovablePin getSupermodelMovablePin(String name)
259 return supermodelPins.get(name);
262 // "graphical" operations
265 * Sets the factor by which the submodel is scaled when rendering and calls redrawListeners. Note that the submodel interface pins will
266 * stay at their position relative to the supermodel, which means they will move relative to the submodel.
268 * @author Daniel Kirschten
270 protected void setSubmodelScale(double submodelScale)
272 this.submodelScale = submodelScale;
274 for (Entry<String, MovablePin> e : supermodelPins.entrySet())
275 getSubmodelMovablePin(e.getKey()).setRelPos(e.getValue().getRelX() * submodelScale, e.getValue().getRelY() * submodelScale);
277 model.requestRedraw();// needed if there is no submodel interface pin
281 * Returns the current factor by which the submodel is scaled when rendering.
283 * @author Daniel Kirschten
285 public double getSubmodelScale()
287 return submodelScale;
291 * @see #renderSymbol(GeneralGC, Rectangle)
293 * @author Daniel Kirschten
295 protected void setSymbolRenderer(Renderer symbolRenderer)
297 this.symbolRenderer = symbolRenderer;
298 model.requestRedraw();
302 * @see #renderSymbol(GeneralGC, Rectangle)
304 * @author Daniel Kirschten
306 public Renderer getSymbolRenderer()
308 return symbolRenderer;
312 * @see #renderOutline(GeneralGC, Rectangle)
314 * @author Daniel Kirschten
316 protected void setOutlineRenderer(Renderer outlineRenderer)
318 this.outlineRenderer = outlineRenderer;
319 model.requestRedraw();
323 * @see #renderOutline(GeneralGC, Rectangle)
325 * @author Daniel Kirschten
327 public Renderer getOutlineRenderer()
329 return outlineRenderer;
333 public void render(GeneralGC gc, Rectangle visibleRegion)
335 GCConfig conf = new GCConfig(gc);
336 TranslatedGC tgc = new TranslatedGC(gc, getPosX(), getPosY(), submodelScale, true);
338 double visibleRegionFillRatio = Math.max(getWidth() / visibleRegion.width, getHeight() / visibleRegion.height);
339 double alphaFactor = map(visibleRegionFillRatio, maxVisibleRegionFillRatioForAlpha0, minVisibleRegionFillRatioForAlpha1, 0, 1);
340 alphaFactor = Math.max(0, Math.min(1, alphaFactor));
341 // we need to take the old alpha into account to support nested submodules better.
342 int oldAlpha = gc.getAlpha();
343 int submodelAlpha = Math.max(0, Math.min(255, (int) (oldAlpha * alphaFactor)));
344 int labelAlpha = Math.max(0, Math.min(255, (int) (oldAlpha * (1 - alphaFactor))));
345 if (submodelAlpha != 0)
347 gc.setAlpha(submodelAlpha);
348 renderer.render(tgc, visibleRegion.translate(getPosX() / submodelScale, getPosY() / submodelScale, 1 / submodelScale));
352 gc.setAlpha(labelAlpha);
353 renderSymbol(gc, visibleRegion);
356 // draw the outline after all other operations to make interface pins look better
357 renderOutline(gc, visibleRegion);
361 * Render the symbol of this {@link SubmodelComponent}, e.g. the things that should be hidden if the submodel is drawn.
363 * @author Daniel Kirschten
365 protected void renderSymbol(GeneralGC gc, Rectangle visibleRegion)
367 if (symbolRenderer != null)
368 symbolRenderer.render(gc, visibleRegion);
372 * Render the outline of this {@link SubmodelComponent}, e.g. the graphical elements that should stay visible if the submodel is drawn.
374 * @author Daniel Kirschten
376 protected void renderOutline(GeneralGC gc, Rectangle visibleRegion)
378 if (outlineRenderer != null)
379 outlineRenderer.render(gc, visibleRegion);
382 private static double map(double val, double valMin, double valMax, double mapMin, double mapMax)
384 return mapMin + (val - valMin) * (mapMax - mapMin) / (valMax - valMin);
388 public boolean clicked(double x, double y)
390 double scaledX = (x - getPosX()) / submodelScale;
391 double scaledY = (y - getPosY()) / submodelScale;
392 for (GUIComponent component : submodel.getComponentsByName().values())
393 if (component.getBounds().contains(scaledX, scaledY) && component.clicked(scaledX, scaledY))
398 // operations no longer supported
401 protected void addPin(Pin pin)
403 throw new UnsupportedOperationException("Can't add pins to a SubmodelComponent directly, call addSubmodelInterface instead");
407 protected void removePin(String name)
409 throw new UnsupportedOperationException("Can't remove pins of a SubmodelComponent directly, call removeSubmodelInterface instead");