Fixed a bug in Am2900; created dlatch8/80; relayouted some components
[Mograsim.git] / net.mograsim.logic.model / src / net / mograsim / logic / model / model / components / submodels / SubmodelComponent.java
index 6ca7705..9388e2f 100644 (file)
@@ -11,29 +11,35 @@ import net.haspamelodica.swt.helper.gcs.GeneralGC;
 import net.haspamelodica.swt.helper.gcs.TranslatedGC;
 import net.haspamelodica.swt.helper.swtobjectwrappers.Rectangle;
 import net.mograsim.logic.model.LogicUIRenderer;
-import net.mograsim.logic.model.model.ViewModel;
-import net.mograsim.logic.model.model.ViewModelModifiable;
-import net.mograsim.logic.model.model.components.GUIComponent;
+import net.mograsim.logic.model.model.LogicModel;
+import net.mograsim.logic.model.model.LogicModelModifiable;
+import net.mograsim.logic.model.model.components.ModelComponent;
 import net.mograsim.logic.model.model.wires.MovablePin;
 import net.mograsim.logic.model.model.wires.Pin;
+import net.mograsim.logic.model.model.wires.PinUsage;
+import net.mograsim.logic.model.serializing.IdentifyParams;
+import net.mograsim.logic.model.serializing.IndirectModelComponentCreator;
+import net.mograsim.logic.model.serializing.SubmodelComponentParams;
+import net.mograsim.logic.model.serializing.SubmodelComponentSerializer;
 import net.mograsim.logic.model.snippets.Renderer;
+import net.mograsim.logic.model.util.JsonHandler;
+import net.mograsim.preferences.Preferences;
 
 /**
- * A {@link GUIComponent} consisting of another model. A <code>SubmodelComponent</code> can have so-called "interface pins" connecting the
+ * A {@link ModelComponent} consisting of another model. A <code>SubmodelComponent</code> can have so-called "interface pins" connecting the
  * inner and outer models.
  */
-//TODO override getParams
-public abstract class SubmodelComponent extends GUIComponent
+public abstract class SubmodelComponent extends ModelComponent
 {
        public static final String SUBMODEL_INTERFACE_NAME = "_submodelinterface";
        /**
         * A modifiable view of {@link #submodel}.
         */
-       protected final ViewModelModifiable submodelModifiable;
+       protected final LogicModelModifiable submodelModifiable;
        /**
         * The model this {@link SubmodelComponent} consists of.
         */
-       public final ViewModel submodel;
+       public final LogicModel submodel;
        /**
         * The list of all submodel interface pins of this {@link SubmodelComponent} on the submodel side.
         */
@@ -93,10 +99,15 @@ public abstract class SubmodelComponent extends GUIComponent
 
        // creation and destruction
 
-       public SubmodelComponent(ViewModelModifiable model, String name)
+       public SubmodelComponent(LogicModelModifiable model, String name)
        {
-               super(model, name);
-               this.submodelModifiable = new ViewModelModifiable();
+               this(model, name, true);
+       }
+
+       protected SubmodelComponent(LogicModelModifiable model, String name, boolean callInit)
+       {
+               super(model, name, false);
+               this.submodelModifiable = new LogicModelModifiable();
                this.submodel = submodelModifiable;
                this.submodelPins = new HashMap<>();
                this.submodelMovablePinsUnmodifiable = Collections.unmodifiableMap(submodelPins);
@@ -104,11 +115,11 @@ public abstract class SubmodelComponent extends GUIComponent
                this.supermodelPins = new HashMap<>();
                this.supermodelMovablePinsUnmodifiable = Collections.unmodifiableMap(supermodelPins);
                this.supermodelUnmovablePinsUnmodifiable = Collections.unmodifiableMap(supermodelPins);
-               this.submodelInterface = new SubmodelInterface(submodelModifiable, SUBMODEL_INTERFACE_NAME);
+               this.submodelInterface = new SubmodelInterface(submodelModifiable);
 
                this.submodelScale = 1;
-               this.maxVisibleRegionFillRatioForAlpha0 = 0.0;
-               this.minVisibleRegionFillRatioForAlpha1 = 0.0;
+               this.maxVisibleRegionFillRatioForAlpha0 = 0.8;
+               this.minVisibleRegionFillRatioForAlpha1 = 0.9;
                this.renderer = new LogicUIRenderer(submodelModifiable);
 
                Consumer<Runnable> redrawHandlerChangedListener = submodelModifiable::setRedrawHandler;
@@ -119,6 +130,9 @@ public abstract class SubmodelComponent extends GUIComponent
                                model.removeRedrawHandlerChangedListener(redrawHandlerChangedListener);
                });
                submodelModifiable.setRedrawHandler(model.getRedrawHandler());
+
+               if (callInit)
+                       init();
        }
 
        // pins
@@ -137,8 +151,24 @@ public abstract class SubmodelComponent extends GUIComponent
                super.addPin(supermodelPin);// do this first to be fail-fast if the supermodel does not belong to this component
 
                String name = supermodelPin.name;
-               MovablePin submodelPin = new MovablePin(submodelInterface, name, supermodelPin.logicWidth, supermodelPin.getRelX() / submodelScale,
-                               supermodelPin.getRelY() / submodelScale);
+               // TODO if we upgrade to Java 12, replace with switch-expression
+               PinUsage submodelPinUsage;
+               switch (supermodelPin.usage)
+               {
+               case INPUT:
+                       submodelPinUsage = PinUsage.OUTPUT;
+                       break;
+               case OUTPUT:
+                       submodelPinUsage = PinUsage.INPUT;
+                       break;
+               case TRISTATE:
+                       submodelPinUsage = PinUsage.TRISTATE;
+                       break;
+               default:
+                       throw new IllegalArgumentException("Unknown enum constant: " + supermodelPin.usage);
+               }
+               MovablePin submodelPin = new MovablePin(submodelModifiable, submodelInterface, name, supermodelPin.logicWidth, submodelPinUsage,
+                               supermodelPin.getRelX() / submodelScale, supermodelPin.getRelY() / submodelScale);
 
                submodelPin.addPinMovedListener(p ->
                {
@@ -329,11 +359,22 @@ public abstract class SubmodelComponent extends GUIComponent
                return outlineRenderer;
        }
 
+       @Override
+       public boolean clicked(double x, double y)
+       {
+               double scaledX = (x - getPosX()) / submodelScale;
+               double scaledY = (y - getPosY()) / submodelScale;
+               for (ModelComponent component : submodel.getComponentsByName().values())
+                       if (component.getBounds().contains(scaledX, scaledY) && component.clicked(scaledX, scaledY))
+                               return true;
+               return false;
+       }
+
        @Override
        public void render(GeneralGC gc, Rectangle visibleRegion)
        {
                GCConfig conf = new GCConfig(gc);
-               TranslatedGC tgc = new TranslatedGC(gc, getPosX(), getPosY(), submodelScale, true);
+               GeneralGC tgc = new TranslatedGC(gc, getPosX(), getPosY(), submodelScale, true);
                conf.reset(tgc);
                double visibleRegionFillRatio = Math.max(getWidth() / visibleRegion.width, getHeight() / visibleRegion.height);
                double alphaFactor = map(visibleRegionFillRatio, maxVisibleRegionFillRatioForAlpha0, minVisibleRegionFillRatioForAlpha1, 0, 1);
@@ -353,6 +394,8 @@ public abstract class SubmodelComponent extends GUIComponent
                        renderSymbol(gc, visibleRegion);
                }
                conf.reset(gc);
+               // reset line width explicitly to avoid rounding errors causing weird glitches
+               gc.setLineWidth(Preferences.current().getDouble("net.mograsim.logic.model.linewidth.default"));
                // draw the outline after all other operations to make interface pins look better
                renderOutline(gc, visibleRegion);
        }
@@ -384,15 +427,32 @@ public abstract class SubmodelComponent extends GUIComponent
                return mapMin + (val - valMin) * (mapMax - mapMin) / (valMax - valMin);
        }
 
+       // serializing
+
+       /**
+        * {@link SubmodelComponent}'s implementation of {@link ModelComponent#getIDForSerializing(IdentifyParams)} returns "submodel". It is
+        * recommended to override this behaviour.
+        * 
+        * @see ModelComponent#getIDForSerializing(IdentifyParams)
+        * @see ModelComponent#getParamsForSerializing(IdentifyParams)
+        */
+       @Override
+       public String getIDForSerializing(IdentifyParams idParams)
+       {
+               return "submodel";// TODO what ID?
+       }
+
+       /**
+        * {@link SubmodelComponent}'s implementation of {@link ModelComponent#getParamsForSerializing(IdentifyParams)} returns an instance of
+        * {@link SubmodelComponentParams}. It is recommended to override this behaviour.
+        * 
+        * @see ModelComponent#getIDForSerializing(IdentifyParams)
+        * @see ModelComponent#getParamsForSerializing(IdentifyParams)
+        */
        @Override
-       public boolean clicked(double x, double y)
+       public Object getParamsForSerializing(IdentifyParams idParams)
        {
-               double scaledX = (x - getPosX()) / submodelScale;
-               double scaledY = (y - getPosY()) / submodelScale;
-               for (GUIComponent component : submodel.getComponentsByName().values())
-                       if (component.getBounds().contains(scaledX, scaledY) && component.clicked(scaledX, scaledY))
-                               return true;
-               return false;
+               return SubmodelComponentSerializer.serialize(this, idParams);
        }
 
        // operations no longer supported
@@ -408,4 +468,10 @@ public abstract class SubmodelComponent extends GUIComponent
        {
                throw new UnsupportedOperationException("Can't remove pins of a SubmodelComponent directly, call removeSubmodelInterface instead");
        }
+
+       static
+       {
+               IndirectModelComponentCreator.setComponentSupplier(SubmodelComponent.class.getCanonicalName(),
+                               (m, p, n) -> SubmodelComponentSerializer.deserialize(m, JsonHandler.fromJsonTree(p, SubmodelComponentParams.class), n));
+       }
 }
\ No newline at end of file