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(MovablePin supermodelPin)
  84         {
  85                 super.addPin(supermodelPin);// do this first to be fail-fast if the supermodel does not belong to this component
  86
  87                 String name = supermodelPin.name;
  88                 MovablePin submodelPin = new MovablePin(submodelInterface, name, supermodelPin.logicWidth, supermodelPin.getRelX() / submodelScale,
  89                                 supermodelPin.getRelY() / submodelScale);
  90
  91                 submodelPin.addPinMovedListener(p ->
  92                 {
  93                         double newRelX = p.getRelX() * submodelScale;
  94                         double newRelY = p.getRelY() * submodelScale;
  95                         if (supermodelPin.getRelX() != newRelX || supermodelPin.getRelY() != newRelY)
  96                                 supermodelPin.setRelPos(newRelX, newRelY);
  97                 });
  98                 supermodelPin.addPinMovedListener(p ->
  99                 {
 100                         double newRelX = p.getRelX() / submodelScale;
 101                         double newRelY = p.getRelY() / submodelScale;
 102                         if (submodelPin.getRelX() != newRelX || submodelPin.getRelY() != newRelY)
 103                                 submodelPin.setRelPos(newRelX, newRelY);
 104                 });
 105
 106                 submodelInterface.addPin(submodelPin);
 107
 108                 submodelPins.put(name, submodelPin);
 109                 supermodelPins.put(name, supermodelPin);
 110
 111                 // no need to call requestRedraw() because addPin() will request a redraw
 112                 return submodelPin;
 113         }
 114
 115         protected void removeSubmodelInterface(String name)
 116         {
 117                 super.removePin(name);
 118                 Pin submodelPin = getSubmodelMovablePin(name);
 119                 submodelInterface.removePin(submodelPin.name);
 120
 121                 submodelPins.remove(name);
 122                 supermodelPins.remove(name);
 123
 124                 // no need to call requestRedraw() because removePin() will request a redraw
 125         }
 126
 127         public Map<String, Pin> getSubmodelPins()
 128         {
 129                 return submodelUnmovablePinsUnmodifiable;
 130         }
 131
 132         public Pin getSubmodelPin(String name)
 133         {
 134                 return getSubmodelMovablePin(name);
 135         }
 136
 137         protected Map<String, MovablePin> getSubmodelMovablePins()
 138         {
 139                 return submodelMovablePinsUnmodifiable;
 140         }
 141
 142         protected MovablePin getSubmodelMovablePin(String name)
 143         {
 144                 return submodelPins.get(name);
 145         }
 146
 147         public Map<String, Pin> getSupermodelPins()
 148         {
 149                 return supermodelUnmovablePinsUnmodifiable;
 150         }
 151
 152         public Pin getSupermodelPin(String name)
 153         {
 154                 return getSupermodelMovablePin(name);
 155         }
 156
 157         protected Map<String, MovablePin> getSupermodelMovablePins()
 158         {
 159                 return supermodelMovablePinsUnmodifiable;
 160         }
 161
 162         protected MovablePin getSupermodelMovablePin(String name)
 163         {
 164                 return supermodelPins.get(name);
 165         }
 166
 167         @Override
 168         public void render(GeneralGC gc, Rectangle visibleRegion)
 169         {
 170                 GCConfig conf = new GCConfig(gc);
 171                 TranslatedGC tgc = new TranslatedGC(gc, getPosX(), getPosY(), submodelScale, true);
 172                 conf.reset(tgc);
 173                 double visibleRegionFillRatio = Math.max(getWidth() / visibleRegion.width, getHeight() / visibleRegion.height);
 174                 double alphaFactor = map(visibleRegionFillRatio, maxVisibleRegionFillRatioForAlpha0, minVisibleRegionFillRatioForAlpha1, 0, 1);
 175                 alphaFactor = Math.max(0, Math.min(1, alphaFactor));
 176                 // we need to take the old alpha into account to support nested submodules better.
 177                 int oldAlpha = gc.getAlpha();
 178                 int submodelAlpha = Math.max(0, Math.min(255, (int) (oldAlpha * alphaFactor)));
 179                 int labelAlpha = Math.max(0, Math.min(255, (int) (oldAlpha * (1 - alphaFactor))));
 180                 if (submodelAlpha != 0)
 181                 {
 182                         gc.setAlpha(submodelAlpha);
 183                         renderer.render(tgc, visibleRegion.translate(getPosX() / submodelScale, getPosY() / submodelScale, 1 / submodelScale));
 184                 }
 185                 if (labelAlpha != 0)
 186                 {
 187                         gc.setAlpha(labelAlpha);
 188                         renderSymbol(gc, visibleRegion);
 189                 }
 190                 conf.reset(gc);
 191                 // draw the outline after all other operations to make interface pins look better
 192                 renderOutline(gc, visibleRegion);
 193         }
 194
 195         protected abstract void renderOutline(GeneralGC gc, Rectangle visibleRegion);
 196
 197         protected abstract void renderSymbol(GeneralGC gc, Rectangle visibleRegion);
 198
 199         private static double map(double val, double valMin, double valMax, double mapMin, double mapMax)
 200         {
 201                 return mapMin + (val - valMin) * (mapMax - mapMin) / (valMax - valMin);
 202         }
 203
 204         @Override
 205         public boolean clicked(double x, double y)
 206         {
 207                 double scaledX = (x - getPosX()) / submodelScale;
 208                 double scaledY = (y - getPosY()) / submodelScale;
 209                 for (GUIComponent component : submodel.getComponents())
 210                         if (component.getBounds().contains(scaledX, scaledY) && component.clicked(scaledX, scaledY))
 211                                 return true;
 212                 return false;
 213         }
 214
 215         /**
 216          * @return {@link SubmodelComponentParams}, which describe this {@link SubmodelComponent}.
 217          */
 218         public SubmodelComponentParams calculateParams()
 219         {
 220                 SubmodelComponentParams params = new SubmodelComponentParams();
 221                 params.type = SubmodelComponent.class.getSimpleName();
 222                 params.composition = calculateCompositionParams();
 223
 224                 params.width = getWidth();
 225                 params.height = getHeight();
 226
 227                 InterfacePinParams[] iPins = new InterfacePinParams[getPins().size()];
 228                 int i = 0;
 229                 for (Pin p : getPins().values())
 230                 {
 231                         InterfacePinParams iPinParams = new InterfacePinParams();
 232                         iPins[i] = iPinParams;
 233                         iPinParams.location = p.getRelPos();
 234                         iPinParams.name = p.name;
 235                         iPinParams.logicWidth = p.logicWidth;
 236                         i++;
 237                 }
 238                 params.interfacePins = iPins;
 239                 return params;
 240         }
 241
 242         protected ComponentCompositionParams calculateCompositionParams()
 243         {
 244                 ComponentCompositionParams params = new ComponentCompositionParams();
 245                 params.innerScale = getSubmodelScale();
 246
 247                 List<GUIComponent> compList = submodelModifiable.getComponents();
 248                 Iterator<GUIComponent> componentIt = compList.iterator();
 249                 componentIt.next(); // Skip inner SubmodelInterface
 250                 InnerComponentParams[] comps = new InnerComponentParams[compList.size() - 1];
 251                 int i = 0;
 252                 while (componentIt.hasNext())
 253                 {
 254                         GUIComponent component = componentIt.next();
 255                         InnerComponentParams inner = new InnerComponentParams();
 256                         comps[i] = inner;
 257                         inner.params = component.getInstantiationParameters();
 258                         inner.pos = new Point(getPosX(), getPosY());
 259                         inner.type = component.getIdentifier();
 260                         i++;
 261                 }
 262                 params.subComps = comps;
 263
 264                 List<GUIWire> wireList = submodelModifiable.getWires();
 265                 InnerWireParams wires[] = new InnerWireParams[wireList.size()];
 266                 i = 0;
 267                 for (GUIWire wire : wireList)
 268                 {
 269                         InnerWireParams inner = new InnerWireParams();
 270                         wires[i] = inner;
 271                         InnerPinParams pin1Params = new InnerPinParams(), pin2Params = new InnerPinParams();
 272
 273                         pin1Params.pinName = wire.getPin1().name;
 274                         pin1Params.compId = compList.indexOf(wire.getPin1().component);
 275                         pin2Params.pinName = wire.getPin2().name;
 276                         pin2Params.compId = compList.indexOf(wire.getPin2().component);
 277                         inner.pin1 = pin1Params;
 278                         inner.pin2 = pin2Params;
 279                         inner.path = wire.getPath();
 280                         i++;
 281                 }
 282                 params.innerWires = wires;
 283                 return params;
 284         }
 285
 286         @Override
 287         protected void addPin(Pin pin)
 288         {
 289                 throw new UnsupportedOperationException("Can't add pins to a SubmodelComponent directly, call addSubmodelInterface instead");
 290         }
 291
 292         @Override
 293         protected void removePin(String name)
 294         {
 295                 throw new UnsupportedOperationException("Can't remove pins of a SubmodelComponent directly, call removeSubmodelInterface instead");
 296         }
 297 }