MouseEvent.java

/* -*- mode: java; c-basic-offset: 2; indent-tabs-mode: nil -*- */

/*
  Part of the Processing project - http://processing.org

  Copyright (c) 2012 The Processing Foundation

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation, version 2.1.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General
  Public License along with this library; if not, write to the
  Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  Boston, MA  02111-1307  USA
*/

package processing.event;

//import processing.core.PConstants;


public class MouseEvent extends Event {
  static public final int PRESS = 1;
  static public final int RELEASE = 2;
  static public final int CLICK = 3;
  static public final int DRAG = 4;
  static public final int MOVE = 5;
  static public final int ENTER = 6;
  static public final int EXIT = 7;
  static public final int WHEEL = 8;

  protected int x, y;
  protected int button;
//  protected int clickCount;
//  protected float amount;
  protected int count;


//  public MouseEvent(int x, int y) {
//    this(null,
//         System.currentTimeMillis(), PRESSED, 0,
//         x, y, PConstants.LEFT, 1);
//  }


  public MouseEvent(Object nativeObject,
                    long millis, int action, int modifiers,
                    int x, int y, int button, int count) {  //float amount) {  //int clickCount) {
    super(nativeObject, millis, action, modifiers);
    this.flavor = MOUSE;
    this.x = x;
    this.y = y;
    this.button = button;
    //this.clickCount = clickCount;
    //this.amount = amount;
    this.count = count;
  }


  public int getX() {
    return x;
  }


  public int getY() {
    return y;
  }


  /** Which button was pressed, either LEFT, CENTER, or RIGHT. */
  public int getButton() {
    return button;
  }


//  public void setButton(int button) {
//    this.button = button;
//  }


  /** Do not use, getCount() is the correct method. */
  @Deprecated
  public int getClickCount() {
    //return (int) amount; //clickCount;
    return count;
  }


  /** Do not use, getCount() is the correct method. */
  @Deprecated
  public float getAmount() {
    //return amount;
    return count;
  }


  /**
   * Number of clicks for mouse button events, or the number of steps (positive
   * or negative depending on direction) for a mouse wheel event.
   * Wheel events follow Java (see <a href="http://docs.oracle.com/javase/6/docs/api/java/awt/event/MouseWheelEvent.html#getWheelRotation()">here</a>), so
   * getAmount() will return "negative values if the mouse wheel was rotated
   * up or away from the user" and positive values in the other direction.
   * On Mac OS X, this will be reversed when "natural" scrolling is enabled
   * in System Preferences &rarr Mouse.
   */
  public int getCount() {
    return count;
  }


//  public void setClickCount(int clickCount) {
//    this.clickCount = clickCount;
//  }

  private String actionString() {
    switch (action) {
    default:
      return "UNKNOWN";
    case CLICK:
      return "CLICK";
    case DRAG:
      return "DRAG";
    case ENTER:
      return "ENTER";
    case EXIT:
      return "EXIT";
    case MOVE:
      return "MOVE";
    case PRESS:
      return "PRESS";
    case RELEASE:
      return "RELEASE";
    case WHEEL:
      return "WHEEL";
    }
  }

  @Override
  public String toString() {
    return String.format("<MouseEvent %s@%d,%d count:%d button:%d>",
                         actionString(), x, y, count, button);
  }
}