com.transmote.nest.events
Class MouseEvent

java.lang.Object
  extended by com.transmote.nest.events.Event
      extended by com.transmote.nest.events.MouseEvent

public class MouseEvent
extends Event

MouseEvent instances represent events dispatched by the Nest framework, which wrap the processing.event.Event instances generated by Processing.

Author:
Eric Socolofsky
See Also:
Event, EventDispatcher

Nested Class Summary
 
Nested classes/interfaces inherited from class com.transmote.nest.events.Event
Event.PHASE
 
Field Summary
static int MOUSE_CLICKED
           
static int MOUSE_DRAGGED
           
static int MOUSE_ENTERED
           
static int MOUSE_EXITED
           
static int MOUSE_MOVED
           
static int MOUSE_PRESSED
           
static int MOUSE_RELEASED
           
 
Fields inherited from class com.transmote.nest.events.Event
ADDED, ADDED_TO_STAGE, DISPATCHER_DISPOSE, ERROR, INIT, REMOVED
 
Constructor Summary
MouseEvent(processing.event.MouseEvent pEvent)
          A Nest mouse event instance, generated automatically by the Nest framework.
 
Method Summary
 int getButton()
           
 int getCount()
           
 Point2D.Float getPoint()
          The location of the mouse relative to the PApplet.
 int getX()
           
 int getY()
           
 processing.event.MouseEvent pMouseEvent()
          The processing MouseEvent instance generated by Processing, if applicable (if this MouseEvent instance was generated in response to a mouse action captured and processed by PApplet).
 
Methods inherited from class com.transmote.nest.events.Event
bubbles, currentTarget, isPropagationStopped, phase, processingEvent, stopPropagation, target, toString, type
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MOUSE_CLICKED

public static final int MOUSE_CLICKED

MOUSE_ENTERED

public static final int MOUSE_ENTERED

MOUSE_EXITED

public static final int MOUSE_EXITED

MOUSE_PRESSED

public static final int MOUSE_PRESSED

MOUSE_RELEASED

public static final int MOUSE_RELEASED

MOUSE_DRAGGED

public static final int MOUSE_DRAGGED

MOUSE_MOVED

public static final int MOUSE_MOVED
Constructor Detail

MouseEvent

public MouseEvent(processing.event.MouseEvent pEvent)
A Nest mouse event instance, generated automatically by the Nest framework.

Parameters:
pEvent - This MouseEvent instance will wrap a processing.event.MouseEvent, passed in from PApplet.
Method Detail

getPoint

public Point2D.Float getPoint()
The location of the mouse relative to the PApplet. Returns null if not available (e.g. the MouseEvent was not generated in response to a mouse action), else returns mouse coordinates as a Point2D.Float instance.


pMouseEvent

public processing.event.MouseEvent pMouseEvent()
The processing MouseEvent instance generated by Processing, if applicable (if this MouseEvent instance was generated in response to a mouse action captured and processed by PApplet).


getX

public int getX()

getY

public int getY()

getButton

public int getButton()

getCount

public int getCount()


Processing library Nest by Eric Socolofsky. (C) Eric Socolofsky 2011-2013