remixlab.proscene

Class MouseAgent

java.lang.Object

remixlab.bias.Agent

remixlab.proscene.MouseAgent

public class MouseAgent
extends Agent

Proscene mouse-agent. A Processing fully fledged mouse Agent.

See Also:

Agent, KeyAgent, DroidKeyAgent, DroidTouchAgent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MouseAgent.PickingMode

Field Summary

Fields

Modifier and Type	Field and Description
static int	CENTER_CLICK_ID
static int	CENTER_ID
static int	LEFT_CLICK_ID
static int	LEFT_ID
static int	NO_BUTTON
static int	RIGHT_CLICK_ID
static int	RIGHT_ID
static int	WHEEL_ID

Constructor Summary

Constructors

Constructor and Description
MouseAgent(Scene scn) Calls super on (scn,n) and sets pickingMode() to MouseAgent.PickingMode.MOVE.

Method Summary

Modifier and Type	Method and Description
void	mouseEvent(MouseEvent e) Processing mouseEvent method to be registered at the PApplet's instance.
MouseAgent.PickingMode	pickingMode() Returns the agent pickingMode().
Scene	scene() Returns the scene this object belongs to.
float[]	sensitivities(MotionEvent event) Returns the sensitivities used in Agent.handle(BogusEvent) to MotionEvent.modulate(float[]).
void	setPickingMode(MouseAgent.PickingMode mode) Sets the agent pickingMode().
void	setXSensitivity(float sensitivity) Defines the xSensitivity().
void	setYSensitivity(float sensitivity) Defines the ySensitivity().
float	xSensitivity() Returns the x sensitivity.
float	ySensitivity() Returns the y sensitivity.

Methods inherited from class remixlab.bias.Agent

addGrabber, defaultGrabber, disableTracking, enableTracking, grabbers, hasGrabber, inputGrabber, inputHandler, isInputGrabber, isTracking, removeGrabber, removeGrabbers, resetTrackedGrabber, setDefaultGrabber, setTracking, shiftDefaultGrabber, toggleTracking, trackedGrabber

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LEFT_ID

public static final int LEFT_ID

CENTER_ID

public static final int CENTER_ID

RIGHT_ID

public static final int RIGHT_ID

WHEEL_ID

public static final int WHEEL_ID

NO_BUTTON

public static final int NO_BUTTON

LEFT_CLICK_ID

public static final int LEFT_CLICK_ID

RIGHT_CLICK_ID

public static final int RIGHT_CLICK_ID

CENTER_CLICK_ID

public static final int CENTER_CLICK_ID

Constructor Detail

MouseAgent

public MouseAgent(Scene scn)

Calls super on (scn,n) and sets pickingMode() to MouseAgent.PickingMode.MOVE.

See Also:

setPickingMode(PickingMode)

Method Detail

scene

public Scene scene()

Returns the scene this object belongs to.

setPickingMode

public void setPickingMode(MouseAgent.PickingMode mode)

Sets the agent pickingMode(). Either MouseAgent.PickingMode.MOVE or MouseAgent.PickingMode.CLICK.

See Also:

pickingMode()

pickingMode

public MouseAgent.PickingMode pickingMode()

Returns the agent pickingMode(). Either MouseAgent.PickingMode.MOVE or MouseAgent.PickingMode.CLICK.

See Also:

setPickingMode(PickingMode)

mouseEvent

public void mouseEvent(MouseEvent e)

Processing mouseEvent method to be registered at the PApplet's instance.

sensitivities

public float[] sensitivities(MotionEvent event)

Description copied from class: Agent

Returns the sensitivities used in Agent.handle(BogusEvent) to MotionEvent.modulate(float[]).

Overrides:

sensitivities in class Agent

setXSensitivity

public void setXSensitivity(float sensitivity)

Defines the xSensitivity().

xSensitivity

public float xSensitivity()

Returns the x sensitivity.

Default value is 1. A higher value will make the event more efficient (usually meaning a faster motion). Use a negative value to invert the along x-Axis motion direction.

setYSensitivity

public void setYSensitivity(float sensitivity)

Defines the ySensitivity().

ySensitivity

public float ySensitivity()

Returns the y sensitivity.

Default value is 1. A higher value will make the event more efficient (usually meaning a faster motion). Use a negative value to invert the along y-Axis motion direction.