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.Collection;
   5 import java.util.Collections;
   6 import java.util.HashMap;
   7 import java.util.List;
   8 import java.util.Map;
   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.wires.Pin;
  16
  17 public abstract class GUIComponent
  18 {
  19         protected final ViewModelModifiable model;
  20         private final Rectangle bounds;
  21         private final Map<String, Pin> pinsByName;
  22         protected final Collection<Pin> pinsUnmodifiable;
  23
  24         private final List<Consumer<? super GUIComponent>> componentMovedListeners;
  25         private final List<Consumer<? super Pin>> pinAddedListeners;
  26         private final List<Consumer<? super Pin>> pinRemovedListeners;
  27         private final List<Runnable> redrawListeners;
  28
  29         private final Runnable redrawListenerForSubcomponents;
  30         // Defines how the GUIComponent is referenced in SubmodelComponentParams
  31         protected Supplier<String> identifierDelegate = () -> "class:".concat(getClass().getCanonicalName());
  32
  33         public GUIComponent(ViewModelModifiable model)
  34         {
  35                 this.model = model;
  36                 this.bounds = new Rectangle(0, 0, 0, 0);
  37                 this.pinsByName = new HashMap<>();
  38                 this.pinsUnmodifiable = Collections.unmodifiableCollection(pinsByName.values());
  39
  40                 this.componentMovedListeners = new ArrayList<>();
  41                 this.pinAddedListeners = new ArrayList<>();
  42                 this.pinRemovedListeners = new ArrayList<>();
  43                 this.redrawListeners = new ArrayList<>();
  44
  45                 redrawListenerForSubcomponents = this::callRedrawListeners;
  46
  47                 model.componentCreated(this);
  48         }
  49
  50         public void destroy()
  51         {
  52                 pinsByName.values().forEach(p -> pinRemovedListeners.forEach(l -> l.accept(p)));
  53                 model.componentDestroyed(this);
  54         }
  55
  56         public void moveTo(double x, double y)
  57         {
  58                 bounds.x = x;
  59                 bounds.y = y;
  60                 callComponentMovedListeners();
  61         }
  62
  63         /**
  64          * Returns the bounds of this component. Used for calculating which component is clicked.
  65          */
  66         public Rectangle getBounds()
  67         {
  68                 return new Rectangle(bounds.x, bounds.y, bounds.width, bounds.height);
  69         }
  70
  71         /**
  72          * Called when this component is clicked. Absolute coordinates of the click are given. Returns true if this component consumed this
  73          * click.
  74          */
  75         @SuppressWarnings({ "static-method", "unused" }) // this method is inteded to be overridden
  76         public boolean clicked(double x, double y)
  77         {
  78                 return false;
  79         }
  80
  81         /**
  82          * Returns a collection of pins of this component.
  83          */
  84         public Collection<Pin> getPins()
  85         {
  86                 return pinsUnmodifiable;
  87         }
  88
  89         public Pin getPin(String name)
  90         {
  91                 return pinsByName.get(name);
  92         }
  93
  94         // @formatter:off
  95         public void addComponentMovedListener   (Consumer<? super GUIComponent> listener) {componentMovedListeners.add   (listener);}
  96         public void addPinAddedListener         (Consumer<? super Pin         > listener) {pinAddedListeners      .add   (listener);}
  97         public void addPinRemovedListener       (Consumer<? super Pin         > listener) {pinRemovedListeners    .add   (listener);}
  98         public void addRedrawListener           (Runnable                       listener) {redrawListeners        .add   (listener);}
  99
 100         public void removeComponentMovedListener(Consumer<? super GUIComponent> listener) {componentMovedListeners .remove(listener);}
 101         public void removePinAddedListener      (Consumer<? super Pin         > listener) {pinAddedListeners       .remove(listener);}
 102         public void removePinRemovedListener    (Consumer<? super Pin         > listener) {pinRemovedListeners     .remove(listener);}
 103         public void removeRedrawListener        (Runnable                       listener) {redrawListeners         .remove(listener);}
 104
 105         private void callComponentMovedListeners(     ) {componentMovedListeners.forEach(l -> l.accept(this));}
 106         private void callPinAddedListeners      (Pin p) {pinAddedListeners      .forEach(l -> l.accept(p   ));}
 107         private void callPinRemovedListeners    (Pin p) {pinRemovedListeners    .forEach(l -> l.accept(p   ));}
 108         private void callRedrawListeners        (     ) {redrawListeners        .forEach(l -> l.run(       ));}
 109         // @formatter:on
 110
 111         /**
 112          * Render this component to the given gc.
 113          */
 114         public abstract void render(GeneralGC gc, Rectangle visibleRegion);
 115
 116         protected void requestRedraw()
 117         {
 118                 callRedrawListeners();
 119         }
 120
 121         protected void setSize(double width, double height)
 122         {
 123                 bounds.width = width;
 124                 bounds.height = height;
 125                 callRedrawListeners();
 126         }
 127
 128         protected void addPin(Pin pin)
 129         {
 130                 if (pinsByName.containsKey(pin.name))
 131                         throw new IllegalArgumentException("Duplicate pin name: " + pin.name);
 132                 pinsByName.put(pin.name, pin);
 133                 callPinAddedListeners(pin);
 134                 pin.addRedrawListener(redrawListenerForSubcomponents);
 135                 callRedrawListeners();
 136         }
 137
 138         protected void removePin(String name)
 139         {
 140                 Pin pin = pinsByName.remove(name);
 141                 callPinRemovedListeners(pin);
 142                 pin.removeRedrawListener(redrawListenerForSubcomponents);
 143                 callRedrawListeners();
 144         }
 145
 146         /**
 147          * @return an identifier used to reference this GUIComponent inside of {@link SubmodelComponentParams}
 148          */
 149         public String getIdentifier()
 150         {
 151                 return identifierDelegate.get();
 152         }
 153 }