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

   1 package net.mograsim.logic.ui.model.components;
   2
   3 import java.util.ArrayList;
   4 import java.util.Collections;
   5 import java.util.HashMap;
   6 import java.util.List;
   7 import java.util.Map;
   8 import java.util.TreeMap;
   9 import java.util.function.Consumer;
  10 import java.util.function.Supplier;
  11
  12 import net.haspamelodica.swt.helper.gcs.GeneralGC;
  13 import net.haspamelodica.swt.helper.swtobjectwrappers.Rectangle;
  14 import net.mograsim.logic.ui.model.ViewModelModifiable;
  15 import net.mograsim.logic.ui.model.Visitable;
  16 import net.mograsim.logic.ui.model.wires.Pin;
  17
  18 /**
  19  * The base class for all GUI components.<br>
  20  * A <code>GUIComponent</code> has a position and size. The size can only be modified by subclasses.<br>
  21  *
  22  * @author Daniel Kirschten
  23  */
  24 public abstract class GUIComponent implements Visitable
  25 {
  26         /**
  27          * The model this component is a part of.
  28          */
  29         protected final ViewModelModifiable model;
  30         private final Rectangle bounds;
  31         /**
  32          * The list of all pins of this component by name.
  33          */
  34         private final Map<String, Pin> pinsByName;
  35         /**
  36          * An unmodifiable view of {@link #pinsByName}.
  37          */
  38         protected final Map<String, Pin> pinsUnmodifiable;
  39
  40         private final List<Consumer<? super GUIComponent>> componentMovedListeners;
  41         private final List<Consumer<? super Pin>> pinAddedListeners;
  42         private final List<Consumer<? super Pin>> pinRemovedListeners;
  43         private final List<Runnable> redrawListeners;
  44
  45         private final Runnable redrawListenerForSubcomponents;
  46         // Defines how the GUIComponent is referenced in SubmodelComponentParams
  47         protected Supplier<String> identifierDelegate = () -> "class:".concat(getClass().getCanonicalName());
  48
  49         // creation and destruction
  50
  51         public GUIComponent(ViewModelModifiable model)
  52         {
  53                 this.model = model;
  54                 this.bounds = new Rectangle(0, 0, 0, 0);
  55                 this.pinsByName = new HashMap<>();
  56                 this.pinsUnmodifiable = Collections.unmodifiableMap(pinsByName);
  57
  58                 this.componentMovedListeners = new ArrayList<>();
  59                 this.pinAddedListeners = new ArrayList<>();
  60                 this.pinRemovedListeners = new ArrayList<>();
  61                 this.redrawListeners = new ArrayList<>();
  62
  63                 redrawListenerForSubcomponents = this::requestRedraw;
  64
  65                 model.componentCreated(this);
  66         }
  67
  68         /**
  69          * Destroys this component. This method implicitly calls {@link ViewModelModifiable#componentDestroyed(GUIComponent)
  70          * componentDestroyed()} for the model this component is a part of.
  71          *
  72          * @author Daniel Kirschten
  73          */
  74         public void destroy()
  75         {
  76                 pinsByName.values().forEach(p -> pinRemovedListeners.forEach(l -> l.accept(p)));
  77                 model.componentDestroyed(this);
  78         }
  79
  80         // pins
  81
  82         /**
  83          * Adds the given pin to this component and calls pinAddedListeners and redrawListeners.
  84          *
  85          * @throws IllegalArgumentException if the pin doesn't belong to this component
  86          * @throws IllegalArgumentException if there already is a pin with the given name
  87          *
  88          * @author Daniel Kirschten
  89          */
  90         protected void addPin(Pin pin)
  91         {
  92                 if (pin.component != this)
  93                         throw new IllegalArgumentException("Can't add a pin not belonging to this component!");
  94                 if (pinsByName.containsKey(pin.name))
  95                         throw new IllegalArgumentException("Duplicate pin name: " + pin.name);
  96                 pinsByName.put(pin.name, pin);
  97                 callPinAddedListeners(pin);
  98                 pin.addRedrawListener(redrawListenerForSubcomponents);
  99                 requestRedraw();
 100         }
 101
 102         /**
 103          * Removes the given pin from this component and calls pinAddedListeners and redrawListeners.
 104          *
 105          * @throws NullPointerException if there was no pin with this name
 106          *
 107          * @author Daniel Kirschten
 108          */
 109         protected void removePin(String name)
 110         {
 111                 Pin pin = pinsByName.remove(name);
 112                 callPinRemovedListeners(pin);
 113                 pin.removeRedrawListener(redrawListenerForSubcomponents);
 114                 requestRedraw();
 115         }
 116
 117         /**
 118          * Returns a collection of pins of this component.
 119          *
 120          * @author Daniel Kirschten
 121          */
 122         public Map<String, Pin> getPins()
 123         {
 124                 return pinsUnmodifiable;
 125         }
 126
 127         /**
 128          * Returns the pin with the given name of this component.
 129          *
 130          * @throws IllegalArgumentException if there is no pin with the given name
 131          *
 132          * @author Daniel Kirschten
 133          */
 134         public Pin getPin(String name)
 135         {
 136                 Pin pin = pinsByName.get(name);
 137                 if (pin == null)
 138                         throw new IllegalArgumentException("No pin with the name " + name);
 139                 return pin;
 140         }
 141
 142         // "graphical" operations
 143
 144         /**
 145          * Sets the position of this component and calls componentMovedListeners and redrawListeners.
 146          *
 147          * @author Daniel Kirschten
 148          */
 149         public void moveTo(double x, double y)
 150         {
 151                 bounds.x = x;
 152                 bounds.y = y;
 153                 callComponentMovedListeners();
 154                 requestRedraw();
 155         }
 156
 157         /**
 158          * Sets the size of this component and calls redrawListeners.
 159          *
 160          * @author Daniel Kirschten
 161          */
 162         protected void setSize(double width, double height)
 163         {
 164                 bounds.width = width;
 165                 bounds.height = height;
 166                 requestRedraw();
 167         }
 168
 169         /**
 170          * Returns the bounds of this component. Is a bit slower than {@link #getPosX()}, {@link #getPosY()}, {@link #getWidth},
 171          * {@link #getHeight}, because new objects are created.
 172          *
 173          * @author Daniel Kirschten
 174          */
 175         public Rectangle getBounds()
 176         {
 177                 return new Rectangle(bounds.x, bounds.y, bounds.width, bounds.height);
 178         }
 179
 180         /**
 181          * Returns the x coordinate of the position of this component. Is a bit faster than {@link #getBounds()} because no objects are created.
 182          *
 183          * @author Daniel Kirschten
 184          */
 185         public double getPosX()
 186         {
 187                 return bounds.x;
 188         }
 189
 190         /**
 191          * Returns the y coordinate of the position of this component. Is a bit faster than {@link #getBounds()} because no objects are created.
 192          *
 193          * @author Daniel Kirschten
 194          */
 195         public double getPosY()
 196         {
 197                 return bounds.y;
 198         }
 199
 200         /**
 201          * Returns the (graphical) width of this component. Is a bit faster than {@link #getBounds()} because no objects are created.
 202          *
 203          * @author Daniel Kirschten
 204          */
 205         public double getWidth()
 206         {
 207                 return bounds.width;
 208         }
 209
 210         /**
 211          * Returns the height of this component. Is a bit faster than {@link #getBounds()} because no objects are created.
 212          *
 213          * @author Daniel Kirschten
 214          */
 215         public double getHeight()
 216         {
 217                 return bounds.height;
 218         }
 219
 220         /**
 221          * Called when this component is clicked. Absolute coordinates of the click are given. Returns true if this component consumed this
 222          * click.
 223          *
 224          * @author Daniel Kirschten
 225          */
 226         @SuppressWarnings({ "static-method", "unused" }) // this method is inteded to be overridden
 227         public boolean clicked(double x, double y)
 228         {
 229                 return false;
 230         }
 231
 232         /**
 233          * Render this component to the given gc, in absoulute coordinates.
 234          *
 235          * @author Daniel Kirschten
 236          */
 237         public abstract void render(GeneralGC gc, Rectangle visibleRegion);
 238
 239         // serializing
 240
 241         /**
 242          * @return an identifier used to reference this GUIComponent inside of {@link SubmodelComponentParams}
 243          */
 244         public String getIdentifier()
 245         {
 246                 return identifierDelegate.get();
 247         }
 248
 249         @SuppressWarnings("static-method")
 250         public Map<String, Object> getInstantiationParameters()
 251         {
 252                 return new TreeMap<>();
 253         }
 254
 255         // listeners
 256
 257         /**
 258          * Calls redraw listeners.
 259          *
 260          * @author Daniel Kirschten
 261          */
 262         protected void requestRedraw()
 263         {
 264                 callRedrawListeners();
 265         }
 266
 267         // @formatter:off
 268         public void addComponentMovedListener   (Consumer<? super GUIComponent> listener) {componentMovedListeners.add   (listener);}
 269         public void addPinAddedListener         (Consumer<? super Pin         > listener) {pinAddedListeners      .add   (listener);}
 270         public void addPinRemovedListener       (Consumer<? super Pin         > listener) {pinRemovedListeners    .add   (listener);}
 271         public void addRedrawListener           (Runnable                       listener) {redrawListeners        .add   (listener);}
 272
 273         public void removeComponentMovedListener(Consumer<? super GUIComponent> listener) {componentMovedListeners .remove(listener);}
 274         public void removePinAddedListener      (Consumer<? super Pin         > listener) {pinAddedListeners       .remove(listener);}
 275         public void removePinRemovedListener    (Consumer<? super Pin         > listener) {pinRemovedListeners     .remove(listener);}
 276         public void removeRedrawListener        (Runnable                       listener) {redrawListeners         .remove(listener);}
 277
 278         private void callComponentMovedListeners(     ) {componentMovedListeners.forEach(l -> l.accept(this));}
 279         private void callPinAddedListeners      (Pin p) {pinAddedListeners      .forEach(l -> l.accept(p   ));}
 280         private void callPinRemovedListeners    (Pin p) {pinRemovedListeners    .forEach(l -> l.accept(p   ));}
 281         private void callRedrawListeners        (     ) {redrawListeners        .forEach(l -> l.run(       ));}
 282         // @formatter:on
 283 }