remixlab.bias.event

Class DOF1Event

java.lang.Object

remixlab.bias.BogusEvent

remixlab.bias.event.MotionEvent

remixlab.bias.event.DOF1Event

All Implemented Interfaces:

Copyable

public class DOF1Event
extends MotionEvent

A MotionEvent with one degree of freedom ( x()).

Field Summary

Fields inherited from class remixlab.bias.BogusEvent

ALT, ALT_GRAPH, CTRL, META, NO_ID, NO_MODIFIER_MASK, SHIFT

Constructor Summary

Constructors

Constructor and Description
DOF1Event(DOF1Event prevEvent, float x) Construct a relative DOF1 event.
DOF1Event(DOF1Event prevEvent, float x, int modifiers, int id) Construct a relative DOF1 event.
DOF1Event(float dx) Construct an absolute DOF1 event.
DOF1Event(float dx, int modifiers, int id) Construct an absolute DOF1 event.
DOF1Event(MotionEvent prevEvent, float x) Same as this(prevEvent instanceof DOF1Event ? (DOF1Event) prevEvent : null, x).
DOF1Event(MotionEvent prevEvent, float x, int modifiers, int id) Same as this(prevEvent instanceof DOF1Event ? (DOF1Event) prevEvent : null, x, modifiers, id).

Method Summary

Modifier and Type	Method and Description
float	dx()
boolean	equals(Object obj)
DOF1Event	fire() Same as this.get() but sets the BogusEvent.fired() flag to true.
DOF1Event	flush() Same as this.get() but sets the BogusEvent.flushed() flag to true.
DOF1Event	get() Returns a deep copy of the object.
int	hashCode()
boolean	isNull() Only MotionEvents may be null.
void	modulate(float[] sens) Modulate the event dofs according to sens.
float	prevX()
float	x()

Methods inherited from class remixlab.bias.event.MotionEvent

delay, distance, dof1Event, dof1Event, dof2Event, dof2Event, dof3Event, dof3Event, dof6Event, isAbsolute, isRelative, shortcut, speed

Methods inherited from class remixlab.bias.BogusEvent

fired, flushed, id, isAltDown, isAltGraph, isControlDown, isMetaDown, isShiftDown, modifiers, modifiersText, timestamp

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DOF1Event

public DOF1Event(float dx,
                 int modifiers,
                 int id)

Construct an absolute DOF1 event.

Parameters:

dx - 1-dof

modifiers - MotionShortcut modifiers

id - MotionShortcut gesture-id

DOF1Event

public DOF1Event(MotionEvent prevEvent,
                 float x,
                 int modifiers,
                 int id)

Same as this(prevEvent instanceof DOF1Event ? (DOF1Event) prevEvent : null, x, modifiers, id).

See Also:

DOF1Event(DOF1Event, float, int, int)

DOF1Event

public DOF1Event(DOF1Event prevEvent,
                 float x,
                 int modifiers,
                 int id)

Construct a relative DOF1 event.

If the BogusEvent.id() of the prevEvent is different then BogusEvent.id(), sets the MotionEvent.distance(), MotionEvent.delay() and MotionEvent.speed() all to zero.

Parameters:

prevEvent -

x - 1-dof

modifiers - MotionShortcut modifiers

id - MotionShortcut gesture-id

DOF1Event

public DOF1Event(float dx)

Construct an absolute DOF1 event.

Parameters:

dx - 1-dof

DOF1Event

public DOF1Event(MotionEvent prevEvent,
                 float x)

Same as this(prevEvent instanceof DOF1Event ? (DOF1Event) prevEvent : null, x).

See Also:

DOF1Event(DOF1Event, float)

DOF1Event

public DOF1Event(DOF1Event prevEvent,
                 float x)

Construct a relative DOF1 event.

If the BogusEvent.id() of the prevEvent is different then BogusEvent.id(), sets the MotionEvent.distance(), MotionEvent.delay() and MotionEvent.speed() all to zero.

Parameters:

prevEvent -

x - 1-dof

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class MotionEvent

equals

public boolean equals(Object obj)

Overrides:

equals in class MotionEvent

get

public DOF1Event get()

Description copied from interface: Copyable

Returns a deep copy of the object.

Typical implementation should simple look like: return new Object(this).

Specified by:

get in interface Copyable

Overrides:

get in class MotionEvent

flush

public DOF1Event flush()

Description copied from class: BogusEvent

Same as this.get() but sets the BogusEvent.flushed() flag to true. Only agents may call this.

Overrides:

flush in class MotionEvent

See Also:

BogusEvent.flushed()

fire

public DOF1Event fire()

Description copied from class: BogusEvent

Same as this.get() but sets the BogusEvent.fired() flag to true. Only agents may call this.

Overrides:

fire in class MotionEvent

See Also:

BogusEvent.flushed()

x

public float x()

Returns:

dof-1, only meaningful if the event MotionEvent.isRelative()

dx

public float dx()

Returns:

dof-1 delta

prevX

public float prevX()

Returns:

previous dof-1, only meaningful if the event MotionEvent.isRelative()

modulate

public void modulate(float[] sens)

Description copied from class: MotionEvent

Modulate the event dofs according to sens. Only meaningful if the event MotionEvent.isAbsolute().

Overrides:

modulate in class MotionEvent

isNull

public boolean isNull()

Description copied from class: BogusEvent

Only MotionEvents may be null.

Overrides:

isNull in class BogusEvent