net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/SubmodelComponent.java

   1 package net.mograsim.logic.ui.model.components;
   2
   3 import java.util.Collections;
   4 import java.util.HashMap;
   5 import java.util.Iterator;
   6 import java.util.List;
   7 import java.util.Map;
   8 import java.util.Map.Entry;
   9
  10 import net.haspamelodica.swt.helper.gcs.GCConfig;
  11 import net.haspamelodica.swt.helper.gcs.GeneralGC;
  12 import net.haspamelodica.swt.helper.gcs.TranslatedGC;
  13 import net.haspamelodica.swt.helper.swtobjectwrappers.Point;
  14 import net.haspamelodica.swt.helper.swtobjectwrappers.Rectangle;
  15 import net.mograsim.logic.ui.LogicUIRenderer;
  16 import net.mograsim.logic.ui.model.ViewModel;
  17 import net.mograsim.logic.ui.model.ViewModelModifiable;
  18 import net.mograsim.logic.ui.model.components.SubmodelComponentParams.ComponentCompositionParams;
  19 import net.mograsim.logic.ui.model.components.SubmodelComponentParams.ComponentCompositionParams.InnerComponentParams;
  20 import net.mograsim.logic.ui.model.components.SubmodelComponentParams.InnerPinParams;
  21 import net.mograsim.logic.ui.model.components.SubmodelComponentParams.InnerWireParams;
  22 import net.mograsim.logic.ui.model.components.SubmodelComponentParams.InterfacePinParams;
  23 import net.mograsim.logic.ui.model.wires.GUIWire;
  24 import net.mograsim.logic.ui.model.wires.MovablePin;
  25 import net.mograsim.logic.ui.model.wires.Pin;
  26
  27 public abstract class SubmodelComponent extends GUIComponent
  28 {
  29         protected final ViewModelModifiable submodelModifiable;
  30         public final ViewModel submodel;
  31         private final Map<String, MovablePin> submodelPins;
  32         private final Map<String, MovablePin> submodelMovablePinsUnmodifiable;
  33         private final Map<String, Pin> submodelUnmovablePinsUnmodifiable;
  34         private final Map<String, MovablePin> supermodelPins;
  35         private final Map<String, MovablePin> supermodelMovablePinsUnmodifiable;
  36         private final Map<String, Pin> supermodelUnmovablePinsUnmodifiable;
  37         private final SubmodelInterface submodelInterface;
  38
  39         private double submodelScale;
  40         private double maxVisibleRegionFillRatioForAlpha0;
  41         private double minVisibleRegionFillRatioForAlpha1;
  42         private final LogicUIRenderer renderer;
  43
  44         public SubmodelComponent(ViewModelModifiable model)
  45         {
  46                 super(model);
  47                 this.submodelModifiable = new ViewModelModifiable();
  48                 this.submodel = submodelModifiable;
  49                 this.submodelPins = new HashMap<>();
  50                 this.submodelMovablePinsUnmodifiable = Collections.unmodifiableMap(submodelPins);
  51                 this.submodelUnmovablePinsUnmodifiable = Collections.unmodifiableMap(submodelPins);
  52                 this.supermodelPins = new HashMap<>();
  53                 this.supermodelMovablePinsUnmodifiable = Collections.unmodifiableMap(supermodelPins);
  54                 this.supermodelUnmovablePinsUnmodifiable = Collections.unmodifiableMap(supermodelPins);
  55                 this.submodelInterface = new SubmodelInterface(submodelModifiable);
  56
  57                 this.submodelScale = 1;
  58                 this.maxVisibleRegionFillRatioForAlpha0 = 0.4;
  59                 this.minVisibleRegionFillRatioForAlpha1 = 0.8;
  60                 this.renderer = new LogicUIRenderer(submodelModifiable);
  61
  62                 submodelModifiable.addRedrawListener(this::requestRedraw);
  63         }
  64
  65         protected void setSubmodelScale(double submodelScale)
  66         {
  67                 this.submodelScale = submodelScale;
  68
  69                 for (Entry<String, MovablePin> e : supermodelPins.entrySet())
  70                         getSubmodelMovablePin(e.getKey()).setRelPos(e.getValue().getRelX() * submodelScale, e.getValue().getRelY() * submodelScale);
  71
  72                 requestRedraw();// needed if there is no submodel interface pin
  73         }
  74
  75         protected double getSubmodelScale()
  76         {
  77                 return submodelScale;
  78         }
  79
  80         /**
  81          * Returns the submodel pin.
  82          */
  83         protected Pin addSubmodelInterface(String name, int logicWidth, double relX, double relY)
  84         {
  85                 MovablePin submodelPin = new MovablePin(submodelInterface, name, logicWidth, relX / submodelScale, relY / submodelScale);
  86                 MovablePin supermodelPin = new MovablePin(this, name, logicWidth, relX, relY);
  87
  88                 submodelPin.addPinMovedListener(p ->
  89                 {
  90                         double newRelX = p.getRelX() * submodelScale;
  91                         double newRelY = p.getRelY() * submodelScale;
  92                         if (supermodelPin.getRelX() != newRelX || supermodelPin.getRelY() != newRelY)
  93                                 supermodelPin.setRelPos(newRelX, newRelY);
  94                 });
  95                 supermodelPin.addPinMovedListener(p ->
  96                 {
  97                         double newRelX = p.getRelX() / submodelScale;
  98                         double newRelY = p.getRelY() / submodelScale;
  99                         if (submodelPin.getRelX() != newRelX || submodelPin.getRelY() != newRelY)
 100                                 submodelPin.setRelPos(newRelX, newRelY);
 101                 });
 102
 103                 submodelInterface.addPin(submodelPin);
 104                 super.addPin(supermodelPin);
 105
 106                 submodelPins.put(name, submodelPin);
 107                 supermodelPins.put(name, supermodelPin);
 108
 109                 // no need to call requestRedraw() because addPin() will request a redraw
 110                 return submodelPin;
 111         }
 112
 113         protected void removeSubmodelInterface(String name)
 114         {
 115                 super.removePin(name);
 116                 Pin submodelPin = getSubmodelMovablePin(name);
 117                 submodelInterface.removePin(submodelPin.name);
 118
 119                 submodelPins.remove(name);
 120                 supermodelPins.remove(name);
 121
 122                 // no need to call requestRedraw() because removePin() will request a redraw
 123         }
 124
 125         public Map<String, Pin> getSubmodelPins()
 126         {
 127                 return submodelUnmovablePinsUnmodifiable;
 128         }
 129
 130         public Pin getSubmodelPin(String name)
 131         {
 132                 return getSubmodelMovablePin(name);
 133         }
 134
 135         protected Map<String, MovablePin> getSubmodelMovablePins()
 136         {
 137                 return submodelMovablePinsUnmodifiable;
 138         }
 139
 140         protected MovablePin getSubmodelMovablePin(String name)
 141         {
 142                 return submodelPins.get(name);
 143         }
 144
 145         public Map<String, Pin> getSupermodelPins()
 146         {
 147                 return supermodelUnmovablePinsUnmodifiable;
 148         }
 149
 150         public Pin getSupermodelPin(String name)
 151         {
 152                 return getSupermodelMovablePin(name);
 153         }
 154
 155         protected Map<String, MovablePin> getSupermodelMovablePins()
 156         {
 157                 return supermodelMovablePinsUnmodifiable;
 158         }
 159
 160         protected MovablePin getSupermodelMovablePin(String name)
 161         {
 162                 return supermodelPins.get(name);
 163         }
 164
 165         @Override
 166         public void render(GeneralGC gc, Rectangle visibleRegion)
 167         {
 168                 GCConfig conf = new GCConfig(gc);
 169                 TranslatedGC tgc = new TranslatedGC(gc, getPosX(), getPosY(), submodelScale, true);
 170                 conf.reset(tgc);
 171                 double visibleRegionFillRatio = Math.max(getWidth() / visibleRegion.width, getHeight() / visibleRegion.height);
 172                 double alphaFactor = map(visibleRegionFillRatio, maxVisibleRegionFillRatioForAlpha0, minVisibleRegionFillRatioForAlpha1, 0, 1);
 173                 alphaFactor = Math.max(0, Math.min(1, alphaFactor));
 174                 // we need to take the old alpha into account to support nested submodules better.
 175                 int oldAlpha = gc.getAlpha();
 176                 int submodelAlpha = Math.max(0, Math.min(255, (int) (oldAlpha * alphaFactor)));
 177                 int labelAlpha = Math.max(0, Math.min(255, (int) (oldAlpha * (1 - alphaFactor))));
 178                 if (submodelAlpha != 0)
 179                 {
 180                         gc.setAlpha(submodelAlpha);
 181                         renderer.render(tgc, visibleRegion.translate(getPosX() / submodelScale, getPosY() / submodelScale, 1 / submodelScale));
 182                 }
 183                 if (labelAlpha != 0)
 184                 {
 185                         gc.setAlpha(labelAlpha);
 186                         renderSymbol(gc, visibleRegion);
 187                 }
 188                 conf.reset(gc);
 189                 // draw the outline after all other operations to make interface pins look better
 190                 renderOutline(gc, visibleRegion);
 191         }
 192
 193         protected abstract void renderOutline(GeneralGC gc, Rectangle visibleRegion);
 194
 195         protected abstract void renderSymbol(GeneralGC gc, Rectangle visibleRegion);
 196
 197         private static double map(double val, double valMin, double valMax, double mapMin, double mapMax)
 198         {
 199                 return mapMin + (val - valMin) * (mapMax - mapMin) / (valMax - valMin);
 200         }
 201
 202         @Override
 203         public boolean clicked(double x, double y)
 204         {
 205                 double scaledX = (x - getPosX()) / submodelScale;
 206                 double scaledY = (y - getPosY()) / submodelScale;
 207                 for (GUIComponent component : submodel.getComponents())
 208                         if (component.getBounds().contains(scaledX, scaledY) && component.clicked(scaledX, scaledY))
 209                                 return true;
 210                 return false;
 211         }
 212
 213         /**
 214          * @return {@link SubmodelComponentParams}, which describe this {@link SubmodelComponent}.
 215          */
 216         public SubmodelComponentParams calculateParams()
 217         {
 218                 SubmodelComponentParams params = new SubmodelComponentParams();
 219                 params.type = SubmodelComponent.class.getSimpleName();
 220                 params.composition = calculateCompositionParams();
 221
 222                 params.width = getWidth();
 223                 params.height = getHeight();
 224
 225                 InterfacePinParams[] iPins = new InterfacePinParams[getPins().size()];
 226                 int i = 0;
 227                 for (Pin p : getPins())
 228                 {
 229                         InterfacePinParams iPinParams = new InterfacePinParams();
 230                         iPins[i] = iPinParams;
 231                         iPinParams.location = p.getRelPos();
 232                         iPinParams.name = p.name;
 233                         iPinParams.logicWidth = p.logicWidth;
 234                         i++;
 235                 }
 236                 params.interfacePins = iPins;
 237                 return params;
 238         }
 239
 240         protected ComponentCompositionParams calculateCompositionParams()
 241         {
 242                 ComponentCompositionParams params = new ComponentCompositionParams();
 243                 params.innerScale = getSubmodelScale();
 244
 245                 List<GUIComponent> compList = submodelModifiable.getComponents();
 246                 Iterator<GUIComponent> componentIt = compList.iterator();
 247                 componentIt.next(); // Skip inner SubmodelInterface
 248                 InnerComponentParams[] comps = new InnerComponentParams[compList.size() - 1];
 249                 int i = 0;
 250                 while (componentIt.hasNext())
 251                 {
 252                         GUIComponent component = componentIt.next();
 253                         InnerComponentParams inner = new InnerComponentParams();
 254                         comps[i] = inner;
 255                         inner.params = component.getInstantiationParameters();
 256                         inner.pos = new Point(getPosX(), getPosY());
 257                         inner.type = component.getIdentifier();
 258                         i++;
 259                 }
 260                 params.subComps = comps;
 261
 262                 List<GUIWire> wireList = submodelModifiable.getWires();
 263                 InnerWireParams wires[] = new InnerWireParams[wireList.size()];
 264                 i = 0;
 265                 for (GUIWire wire : wireList)
 266                 {
 267                         InnerWireParams inner = new InnerWireParams();
 268                         wires[i] = inner;
 269                         InnerPinParams pin1Params = new InnerPinParams(), pin2Params = new InnerPinParams();
 270
 271                         pin1Params.pinName = wire.getPin1().name;
 272                         pin1Params.compId = compList.indexOf(wire.getPin1().component);
 273                         pin2Params.pinName = wire.getPin2().name;
 274                         pin2Params.compId = compList.indexOf(wire.getPin2().component);
 275                         inner.pin1 = pin1Params;
 276                         inner.pin2 = pin2Params;
 277                         inner.path = wire.getPath();
 278                         i++;
 279                 }
 280                 params.innerWires = wires;
 281                 return params;
 282         }
 283
 284         @Override
 285         protected void addPin(Pin pin)
 286         {
 287                 throw new UnsupportedOperationException("Can't add pins to a SubmodelComponent directly, call addSubmodelInterface instead");
 288         }
 289
 290         @Override
 291         protected void removePin(String name)
 292         {
 293                 throw new UnsupportedOperationException("Can't remove pins of a SubmodelComponent directly, call removeSubmodelInterface instead");
 294         }
 295 }