import java.util.Collections;
import java.util.HashMap;
+import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
+import java.util.Set;
import net.haspamelodica.swt.helper.gcs.GCConfig;
import net.haspamelodica.swt.helper.gcs.GeneralGC;
import net.mograsim.logic.ui.model.wires.MovablePin;
import net.mograsim.logic.ui.model.wires.Pin;
+/**
+ * A {@link GUIComponent} consisting of another model. A <code>SubmodelComponent</code> 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<String, MovablePin> submodelPins;
+ /**
+ * An unmodifiable view of {@link #submodelPins}.
+ */
private final Map<String, MovablePin> submodelMovablePinsUnmodifiable;
+ /**
+ * An unmodifiable view of {@link #submodelPins} where pins are not movable.
+ */
private final Map<String, Pin> submodelUnmovablePinsUnmodifiable;
+ /**
+ * The list of all submodel interface pins of this {@link SubmodelComponent} on the supermodel side.
+ */
private final Map<String, MovablePin> supermodelPins;
+ /**
+ * An unmodifiable view of {@link #supermodelPins}.
+ */
private final Map<String, MovablePin> supermodelMovablePinsUnmodifiable;
+ /**
+ * An unmodifiable view of {@link #supermodelPins} where pins are not movable.
+ */
private final Map<String, Pin> supermodelUnmovablePinsUnmodifiable;
+ /**
+ * A pseudo-component containing all submodel interface pins on the submodel side.
+ */
private final SubmodelInterface submodelInterface;
+ /**
+ * The list of all high level state IDs this component supports without delegating to subcomponents.
+ */
+ private final Set<String> highLevelAtomicStates;
+ /**
+ * A map of high level state subcomponent IDs to the {@link GUIComponent} high level state access requests are delegated to.
+ */
+ private final Map<String, GUIComponent> subcomponentsByHighLevelStateSubcomponentID;
+
+ /**
+ * 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);
this.supermodelUnmovablePinsUnmodifiable = Collections.unmodifiableMap(supermodelPins);
this.submodelInterface = new SubmodelInterface(submodelModifiable);
+ this.highLevelAtomicStates = new HashSet<>();
+ this.subcomponentsByHighLevelStateSubcomponentID = new HashMap<>();
+
this.submodelScale = 1;
this.maxVisibleRegionFillRatioForAlpha0 = 0.4;
this.minVisibleRegionFillRatioForAlpha1 = 0.8;
submodelModifiable.addRedrawListener(this::requestRedraw);
}
- protected void setSubmodelScale(double submodelScale)
- {
- this.submodelScale = submodelScale;
-
- for (Entry<String, MovablePin> 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 ->
{
});
submodelInterface.addPin(submodelPin);
- super.addPin(supermodelPin);
submodelPins.put(name, submodelPin);
supermodelPins.put(name, supermodelPin);
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<String, Pin> 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<String, MovablePin> 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<String, Pin> 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<String, MovablePin> 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);
}
+ // high-level access
+
+ /**
+ * Adds the given subcomponent ID to the set of allowed subcomponent IDs and links the given {@link GUIComponent} as the delegate target
+ * for this subcomponent ID. <br>
+ * Note that this method does not affect whether {@link #setSubcomponentHighLevelState(String, String, Object)
+ * set}/{@link #getSubcomponentHighLevelState(String, String)} will be called. <br>
+ * See {@link GUIComponent#setHighLevelState(String, Object)} for details about subcomponent IDs.
+ *
+ * @author Daniel Kirschten
+ */
+ protected void addHighLevelStateSubcomponentID(String subcomponentID, GUIComponent subcomponent)
+ {
+ checkHighLevelStateIDPart(subcomponentID);
+ subcomponentsByHighLevelStateSubcomponentID.put(subcomponentID, subcomponent);
+ }
+
+ /**
+ * Removes the given subcomponent ID from the set of allowed subcomponent IDs. <br>
+ * Note that this method does not affect whether {@link #setSubcomponentHighLevelState(String, String, Object)
+ * set}/{@link #getSubcomponentHighLevelState(String, String)} will be called.<br>
+ * See {@link GUIComponent#setHighLevelState(String, Object)} for details about subcomponent IDs.
+ *
+ * @author Daniel Kirschten
+ */
+ protected void removeHighLevelStateSubcomponentID(String subcomponentID)
+ {
+ subcomponentsByHighLevelStateSubcomponentID.remove(subcomponentID);
+ }
+
+ /**
+ * Adds the given atomic state ID to the set of allowed atomic state IDs. <br>
+ * See {@link GUIComponent#setHighLevelState(String, Object)} for details about atomic state IDs.
+ *
+ * @author Daniel Kirschten
+ */
+ protected void addAtomicHighLevelStateID(String stateID)
+ {
+ checkHighLevelStateIDPart(stateID);
+ highLevelAtomicStates.add(stateID);
+ }
+
+ /**
+ * Removes the given atomic state ID from the set of allowed atomic state IDs. <br>
+ * See {@link GUIComponent#setHighLevelState(String, Object)} for details about atomic state IDs.
+ *
+ * @author Daniel Kirschten
+ */
+ protected void removeAtomicHighLevelStateID(String stateID)
+ {
+ highLevelAtomicStates.remove(stateID);
+ }
+
@Override
- public void render(GeneralGC gc, Rectangle visibleRegion)
+ public final void setHighLevelState(String stateID, Object newState)
+ {
+ int indexOfDot = stateID.indexOf('.');
+ if (indexOfDot == -1)
+ if (highLevelAtomicStates.contains(stateID))
+ setAtomicHighLevelState(stateID, newState);
+ else
+ super.setHighLevelState(stateID, newState);
+ else
+ setSubcomponentHighLevelState(stateID.substring(0, indexOfDot), stateID.substring(indexOfDot + 1), newState);
+ }
+
+ /**
+ * This method is called in {@link #setHighLevelState(String, Object)} when the state ID is not atomic. The default implementation uses
+ * the information given to {@link #addHighLevelStateSubcomponentID(String, GUIComponent)
+ * add}/{@link #removeHighLevelStateSubcomponentID(String)} to decide which subcomponent to delegate to.<br>
+ * Note that {@link #addHighLevelStateSubcomponentID(String, GUIComponent) add}/{@link #removeHighLevelStateSubcomponentID(String)}
+ * don't affect whether this method will be called.
+ *
+ * @author Daniel Kirschten
+ */
+ protected void setSubcomponentHighLevelState(String subcomponentID, String subcomponentHighLevelStateID, Object newState)
+ {
+ GUIComponent subcomponent = subcomponentsByHighLevelStateSubcomponentID.get(subcomponentID);
+ if (subcomponent != null)
+ subcomponent.setHighLevelState(subcomponentHighLevelStateID, newState);
+ else
+ super.setHighLevelState(subcomponentID + "." + subcomponentHighLevelStateID, newState);
+ }
+
+ /**
+ * This method is called in {@link #setHighLevelState(String, Object)} when the state ID is atomic and in the set of allowed atomic
+ * state IDs. <br>
+ * See {@link GUIComponent#setHighLevelState(String, Object)} for details about atomic state IDs.
+ *
+ * @author Daniel Kirschten
+ */
+ @SuppressWarnings({ "static-method", "unused" }) // this method is intended to be overridden
+ protected void setAtomicHighLevelState(String stateID, Object newState)
+ {
+ throw new IllegalStateException("Unknown high level state ID: " + stateID);
+ }
+
+ @Override
+ public final Object getHighLevelState(String stateID)
+ {
+ int indexOfDot = stateID.indexOf('.');
+ if (indexOfDot == -1)
+ {
+ if (highLevelAtomicStates.contains(stateID))
+ return getAtomicHighLevelState(stateID);
+ return super.getHighLevelState(stateID);
+ }
+ return getSubcomponentHighLevelState(stateID.substring(0, indexOfDot), stateID.substring(indexOfDot + 1));
+ }
+
+ /**
+ * This method is called in {@link #getHighLevelState(String, Object)} when the state ID is not atomic. The default implementation uses
+ * the information given to {@link #addHighLevelStateSubcomponentID(String, GUIComponent)
+ * add}/{@link #removeHighLevelStateSubcomponentID(String)} to decide which subcomponent to delegate to. <br>
+ * Note that {@link #addHighLevelStateSubcomponentID(String, GUIComponent) add}/{@link #removeHighLevelStateSubcomponentID(String)}
+ * don't affect whether this method will be called.
+ *
+ * @author Daniel Kirschten
+ */
+ protected Object getSubcomponentHighLevelState(String subcomponentID, String subcomponentHighLevelStateID)
+ {
+ GUIComponent subcomponent = subcomponentsByHighLevelStateSubcomponentID.get(subcomponentID);
+ if (subcomponent != null)
+ return subcomponent.getHighLevelState(subcomponentHighLevelStateID);
+ return super.getHighLevelState(subcomponentID + "." + subcomponentHighLevelStateID);
+ }
+
+ /**
+ * This method is called in {@link SubmodelComponent#getHighLevelState(String)} when the state ID is in the set of allowed atomic state
+ * IDs. <br>
+ * See {@link GUIComponent#setHighLevelState(String, Object)} for details about atomic state IDs.
+ *
+ * @author Daniel Kirschten
+ */
+ @SuppressWarnings("static-method") // this method is intended to be overridden
+ protected Object getAtomicHighLevelState(String stateID)
+ {
+ throw new IllegalStateException("Unknown high level state ID: " + stateID);
+ }
+
+ private static void checkHighLevelStateIDPart(String stateIDPart)
{
- double posX = getBounds().x;
- double posY = getBounds().y;
+ if (stateIDPart.indexOf('.') != -1)
+ throw new IllegalArgumentException("Illegal high level state ID part (contains dot): " + stateIDPart);
+
+ }
+ // "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<String, MovablePin> 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)
+ {
GCConfig conf = new GCConfig(gc);
- TranslatedGC tgc = new TranslatedGC(gc, posX, posY, submodelScale, true);
+ TranslatedGC tgc = new TranslatedGC(gc, getPosX(), getPosY(), submodelScale, true);
conf.reset(tgc);
- double visibleRegionFillRatio = Math.max(getBounds().width / visibleRegion.width, getBounds().height / visibleRegion.height);
+ double visibleRegionFillRatio = Math.max(getWidth() / visibleRegion.width, getHeight() / visibleRegion.height);
double alphaFactor = map(visibleRegionFillRatio, maxVisibleRegionFillRatioForAlpha0, minVisibleRegionFillRatioForAlpha1, 0, 1);
alphaFactor = Math.max(0, Math.min(1, alphaFactor));
// we need to take the old alpha into account to support nested submodules better.
if (submodelAlpha != 0)
{
gc.setAlpha(submodelAlpha);
- renderer.render(tgc, visibleRegion.translate(posX / submodelScale, posY / submodelScale, 1 / submodelScale));
+ renderer.render(tgc, visibleRegion.translate(getPosX() / submodelScale, getPosY() / submodelScale, 1 / submodelScale));
}
if (labelAlpha != 0)
{
renderOutline(gc, visibleRegion);
}
+ /**
+ * Render the outline of this {@link SubmodelComponent}, e.g. the graphical elements that should stay visible if the submodel is drawn.
+ *
+ * @author Daniel Kirschten
+ */
protected abstract void renderOutline(GeneralGC gc, Rectangle visibleRegion);
+ /**
+ * Render the symbol of this {@link SubmodelComponent}, e.g. the things that should be hidden if the submodel is drawn.
+ *
+ * @author Daniel Kirschten
+ */
protected abstract void renderSymbol(GeneralGC gc, Rectangle visibleRegion);
private static double map(double val, double valMin, double valMax, double mapMin, double mapMax)
@Override
public boolean clicked(double x, double y)
{
- // TODO
- double scaledX = (x - getBounds().x) / submodelScale;
- double scaledY = (y - getBounds().y) / submodelScale;
- double roundedScaledX = Math.round(scaledX / 5 * 2) * 5 / 2.;
- double roundedScaledY = Math.round(scaledY / 5 * 2) * 5 / 2.;
- System.out.println(scaledX + "|" + scaledY + ", rounded " + roundedScaledX + "|" + roundedScaledY);
- return true;
+ double scaledX = (x - getPosX()) / submodelScale;
+ double scaledY = (y - getPosY()) / submodelScale;
+ for (GUIComponent component : submodel.getComponents())
+ if (component.getBounds().contains(scaledX, scaledY) && component.clicked(scaledX, scaledY))
+ return true;
+ 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();
- Rectangle bounds = getBounds();
- params.width = bounds.width;
- params.height = bounds.height;
+ params.width = getWidth();
+ params.height = getHeight();
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;
GUIComponent component = componentIt.next();
InnerComponentParams inner = new InnerComponentParams();
comps[i] = inner;
- inner.logicWidth = component.getPins().iterator().next().logicWidth; // TODO This could be done a little more elegantly
- Rectangle bounds = component.getBounds();
- inner.pos = new Point(bounds.x, bounds.y);
- inner.type = component.getIdentifier();
+ inner.params = component.getInstantiationParameters();
+ inner.pos = new Point(component.getPosX(), component.getPosY());
+ inner.name = component.getIdentifier();
i++;
}
params.subComps = comps;
return params;
}
+ // operations no longer supported
+
@Override
protected void addPin(Pin pin)
{
projects / Mograsim.git / blobdiff