X-Git-Url: https://mograsim.net/gitweb/?a=blobdiff_plain;f=net.mograsim.logic.ui%2Fsrc%2Fnet%2Fmograsim%2Flogic%2Fui%2Fmodel%2Fcomponents%2FSubmodelComponent.java;h=3db44fdf2dc442257a29d558b639970751ce5cef;hb=74bced7a3a38f65c65f3395cc422eb98e34da0b8;hp=8febda89a5d9b52e8b650818b3322eabcbf5783d;hpb=c223a9de7b0ef783bcb4f7612da350583ca29abd;p=Mograsim.git
diff --git a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/SubmodelComponent.java b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/SubmodelComponent.java
index 8febda89..3db44fdf 100644
--- a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/SubmodelComponent.java
+++ b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/SubmodelComponent.java
@@ -24,23 +24,70 @@ import net.mograsim.logic.ui.model.wires.GUIWire;
import net.mograsim.logic.ui.model.wires.MovablePin;
import net.mograsim.logic.ui.model.wires.Pin;
+/**
+ * A {@link GUIComponent} consisting of another model. A SubmodelComponent
can have so-called "interface pins" connecting the
+ * inner and outer models.
+ */
public abstract class SubmodelComponent extends GUIComponent
{
+ /**
+ * A modifiable view of {@link #submodel}.
+ */
protected final ViewModelModifiable submodelModifiable;
+ /**
+ * The model this {@link SubmodelComponent} consists of.
+ */
public final ViewModel submodel;
+ /**
+ * The list of all submodel interface pins of this {@link SubmodelComponent} on the submodel side.
+ */
private final Map submodelPins;
+ /**
+ * An unmodifiable view of {@link #submodelPins}.
+ */
private final Map submodelMovablePinsUnmodifiable;
+ /**
+ * An unmodifiable view of {@link #submodelPins} where pins are not movable.
+ */
private final Map submodelUnmovablePinsUnmodifiable;
+ /**
+ * The list of all submodel interface pins of this {@link SubmodelComponent} on the supermodel side.
+ */
private final Map supermodelPins;
+ /**
+ * An unmodifiable view of {@link #supermodelPins}.
+ */
private final Map supermodelMovablePinsUnmodifiable;
+ /**
+ * An unmodifiable view of {@link #supermodelPins} where pins are not movable.
+ */
private final Map supermodelUnmovablePinsUnmodifiable;
+ /**
+ * A pseudo-component containing all submodel interface pins on the submodel side.
+ */
private final SubmodelInterface submodelInterface;
+ /**
+ * The factor by which the submodel is scaled when rendering.
+ */
private double submodelScale;
+ /**
+ * If this {@link SubmodelComponent} fills at least this amount of the visible region vertically or horizontally, the submodel starts to
+ * be visible.
+ */
private double maxVisibleRegionFillRatioForAlpha0;
+ /**
+ * If this {@link SubmodelComponent} fills at least this amount of the visible region vertically or horizontally, the submodel is fully
+ * visible.
+ */
private double minVisibleRegionFillRatioForAlpha1;
+ /**
+ * The renderer used for rendering the submodel.
+ */
private final LogicUIRenderer renderer;
+ // creation and destruction
+
public SubmodelComponent(ViewModelModifiable model)
{
super(model);
@@ -62,28 +109,24 @@ public abstract class SubmodelComponent extends GUIComponent
submodelModifiable.addRedrawListener(this::requestRedraw);
}
- protected void setSubmodelScale(double submodelScale)
- {
- this.submodelScale = submodelScale;
-
- for (Entry e : supermodelPins.entrySet())
- getSubmodelMovablePin(e.getKey()).setRelPos(e.getValue().getRelX() * submodelScale, e.getValue().getRelY() * submodelScale);
-
- requestRedraw();// needed if there is no submodel interface pin
- }
-
- protected double getSubmodelScale()
- {
- return submodelScale;
- }
+ // pins
/**
- * Returns the submodel pin.
+ * Adds a new submodel interface pin.
+ *
+ * @param supermodelPin the submodel interface pin on the supermodel side
+ *
+ * @return the submodel interface pin on the submodel side
+ *
+ * @author Daniel Kirschten
*/
- protected Pin addSubmodelInterface(String name, int logicWidth, double relX, double relY)
+ protected Pin addSubmodelInterface(MovablePin supermodelPin)
{
- MovablePin submodelPin = new MovablePin(submodelInterface, name, logicWidth, relX / submodelScale, relY / submodelScale);
- MovablePin supermodelPin = new MovablePin(this, name, logicWidth, relX, relY);
+ 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);
submodelPin.addPinMovedListener(p ->
{
@@ -101,7 +144,6 @@ public abstract class SubmodelComponent extends GUIComponent
});
submodelInterface.addPin(submodelPin);
- super.addPin(supermodelPin);
submodelPins.put(name, submodelPin);
supermodelPins.put(name, supermodelPin);
@@ -110,58 +152,129 @@ public abstract class SubmodelComponent extends GUIComponent
return submodelPin;
}
+ /**
+ * Removes a submodel interface pin.
+ *
+ * @author Daniel Kirschten
+ */
protected void removeSubmodelInterface(String name)
{
- super.removePin(name);
- Pin submodelPin = getSubmodelMovablePin(name);
+ super.removePin(name);// do this first to be fail-fast if this component doesn't have a pin with the given name
+ Pin submodelPin = submodelPins.remove(name);
submodelInterface.removePin(submodelPin.name);
-
- submodelPins.remove(name);
supermodelPins.remove(name);
// no need to call requestRedraw() because removePin() will request a redraw
}
+ /**
+ * Returns a collection of submodel interface pins on the submodel side of this component.
+ *
+ * @author Daniel Kirschten
+ */
public Map getSubmodelPins()
{
return submodelUnmovablePinsUnmodifiable;
}
+ /**
+ * Returns the submodel interface pin with the given name on the submodel side of this component.
+ *
+ * @author Daniel Kirschten
+ */
public Pin getSubmodelPin(String name)
{
return getSubmodelMovablePin(name);
}
+ /**
+ * Returns a collection of movable submodel interface pins on the submodel side of this component.
+ *
+ * @author Daniel Kirschten
+ */
protected Map getSubmodelMovablePins()
{
return submodelMovablePinsUnmodifiable;
}
+ /**
+ * Returns the movable submodel interface pin with the given name on the submodel side of this component.
+ *
+ * @author Daniel Kirschten
+ */
protected MovablePin getSubmodelMovablePin(String name)
{
return submodelPins.get(name);
}
+ /**
+ * Returns a collection of submodel interface pins on the supermodel side of this component.
+ *
+ * @author Daniel Kirschten
+ */
public Map getSupermodelPins()
{
return supermodelUnmovablePinsUnmodifiable;
}
+ /**
+ * Returns the submodel interface pin with the given name on the supermodel side of this component.
+ *
+ * @author Daniel Kirschten
+ */
public Pin getSupermodelPin(String name)
{
return getSupermodelMovablePin(name);
}
+ /**
+ * Returns a collection of movable submodel interface pins on the supermodel side of this component.
+ *
+ * @author Daniel Kirschten
+ */
protected Map getSupermodelMovablePins()
{
return supermodelMovablePinsUnmodifiable;
}
+ /**
+ * Returns the movable submodel interface pin with the given name on the supermodel side of this component.
+ *
+ * @author Daniel Kirschten
+ */
protected MovablePin getSupermodelMovablePin(String name)
{
return supermodelPins.get(name);
}
+ // "graphical" operations
+
+ /**
+ * Sets the factor by which the submodel is scaled when rendering and calls redrawListeners. Note that the submodel interface pins will
+ * stay at their position relative to the supermodel, which means they will move relative to the submodel.
+ *
+ * @author Daniel Kirschten
+ */
+ protected void setSubmodelScale(double submodelScale)
+ {
+ this.submodelScale = submodelScale;
+
+ for (Entry e : supermodelPins.entrySet())
+ getSubmodelMovablePin(e.getKey()).setRelPos(e.getValue().getRelX() * submodelScale, e.getValue().getRelY() * submodelScale);
+
+ requestRedraw();// needed if there is no submodel interface pin
+ }
+
+ /**
+ * Returns the current factor by which the submodel is scaled when rendering.
+ *
+ * @author Daniel Kirschten
+ */
+ protected double getSubmodelScale()
+ {
+ return submodelScale;
+ }
+
@Override
public void render(GeneralGC gc, Rectangle visibleRegion)
{
@@ -210,12 +323,15 @@ public abstract class SubmodelComponent extends GUIComponent
return false;
}
+ // serializing
+
/**
* @return {@link SubmodelComponentParams}, which describe this {@link SubmodelComponent}.
*/
public SubmodelComponentParams calculateParams()
{
SubmodelComponentParams params = new SubmodelComponentParams();
+ params.name = getIdentifier();
params.type = SubmodelComponent.class.getSimpleName();
params.composition = calculateCompositionParams();
@@ -224,7 +340,7 @@ public abstract class SubmodelComponent extends GUIComponent
InterfacePinParams[] iPins = new InterfacePinParams[getPins().size()];
int i = 0;
- for (Pin p : getPins())
+ for (Pin p : getPins().values())
{
InterfacePinParams iPinParams = new InterfacePinParams();
iPins[i] = iPinParams;
@@ -253,8 +369,8 @@ public abstract class SubmodelComponent extends GUIComponent
InnerComponentParams inner = new InnerComponentParams();
comps[i] = inner;
inner.params = component.getInstantiationParameters();
- inner.pos = new Point(getPosX(), getPosY());
- inner.type = component.getIdentifier();
+ inner.pos = new Point(component.getPosX(), component.getPosY());
+ inner.name = component.getIdentifier();
i++;
}
params.subComps = comps;
@@ -281,6 +397,18 @@ public abstract class SubmodelComponent extends GUIComponent
return params;
}
+ public List getComponents()
+ {
+ return submodel.getComponents();
+ }
+
+ public List getWires()
+ {
+ return submodel.getWires();
+ }
+
+ // operations no longer supported
+
@Override
protected void addPin(Pin pin)
{