EventGrabberTuple.java

/**************************************************************************************
 * bias_tree
 * Copyright (c) 2014-2017 National University of Colombia, https://github.com/remixlab
 * @author Jean Pierre Charalambos, http://otrolado.info/
 *
 * All rights reserved. Library that eases the creation of interactive
 * scenes, released under the terms of the GNU Public License v3.0
 * which is available at http://www.gnu.org/licenses/gpl.html
 **************************************************************************************/

package remixlab.bias;

/**
 * A [{@link BogusEvent},{@link Grabber}] tuple. An
 * enqueued tuple fires {@link Grabber#performInteraction(BogusEvent)}
 * call from the event in the tuple.
 * <p>
 * Tuples are typically enqueued by an agent (see
 * {@link Agent#handle(BogusEvent)}), but may be enqueued manually, see
 * {@link InputHandler#enqueueEventTuple(EventGrabberTuple)}.
 */
public class EventGrabberTuple {
  protected BogusEvent event;
  protected Grabber grabber;

  /**
   * Constructs a {@link BogusEvent},
   * {@link Grabber} tuple.
   *
   * @param e {@link BogusEvent}
   * @param g {@link Grabber}
   */
  public EventGrabberTuple(BogusEvent e, Grabber g) {
    event = e;
    grabber = g;
  }

  /**
   * Calls {@link Grabber#performInteraction(BogusEvent)}.
   *
   * @return true if succeeded and false otherwise.
   */
  public boolean perform() {
    if (grabber == null || event == null)
      return false;
    grabber.performInteraction(event);
    return true;
  }

  /**
   * Returns the event from the tuple.
   */
  public BogusEvent event() {
    return event;
  }

  /**
   * Returns the object Grabber in the tuple.
   */
  public Grabber grabber() {
    return grabber;
  }
}