remixlab.bias.event

Class DOF3Event

java.lang.Object

remixlab.bias.BogusEvent

remixlab.bias.event.MotionEvent

remixlab.bias.event.DOF3Event

All Implemented Interfaces:

Copyable

public class DOF3Event
extends MotionEvent

A MotionEvent with three degrees-of-freedom ( x(), y() and z() ).

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
DOF3Event(DOF3Event prevEvent, float x, float y, float z) Construct a relative event from the given previous event, dof's and modifiers.
DOF3Event(DOF3Event prevEvent, float x, float y, float z, int modifiers, int id) Construct a relative event from the given previous event, dof's and modifiers.
DOF3Event(float dx, float dy, float dz) Construct an absolute event from the given dof's.
DOF3Event(float dx, float dy, float dz, int modifiers, int id) Construct an absolute event from the given dof's and modifiers.
DOF3Event(MotionEvent prevEvent, float x, float y, float z) Same as this(prevEvent instanceof DOF3Event ? (DOF3Event) prevEvent : null, x, y, z).
DOF3Event(MotionEvent prevEvent, float x, float y, float z, int modifiers, int id) Same as this(prevEvent instanceof DOF3Event ? (DOF3Event) prevEvent : null, x, y, z, modifiers, id).

Method Summary

Modifier and Type	Method and Description
DOF2Event	dof2Event() Reduces the event to a DOF2Event (lossy reduction).
float	dx()
float	dy()
float	dz()
boolean	equals(Object obj)
DOF3Event	fire() Same as this.get() but sets the BogusEvent.fired() flag to true.
DOF3Event	flush() Same as this.get() but sets the BogusEvent.flushed() flag to true.
DOF3Event	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	prevY()
float	prevZ()
float	x()
float	y()
float	z()

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

DOF3Event

public DOF3Event(float dx,
                 float dy,
                 float dz,
                 int modifiers,
                 int id)

Construct an absolute event from the given dof's and modifiers.

Parameters:

dx -

dy -

dz -

modifiers -

id -

DOF3Event

public DOF3Event(MotionEvent prevEvent,
                 float x,
                 float y,
                 float z,
                 int modifiers,
                 int id)

Same as this(prevEvent instanceof DOF3Event ? (DOF3Event) prevEvent : null, x, y, z, modifiers, id).

See Also:

DOF3Event(DOF3Event, float, float, float, int, int)

DOF3Event

public DOF3Event(DOF3Event prevEvent,
                 float x,
                 float y,
                 float z,
                 int modifiers,
                 int id)

Construct a relative event from the given previous event, dof's and modifiers.

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 -

y -

z -

modifiers -

id -

DOF3Event

public DOF3Event(float dx,
                 float dy,
                 float dz)

Construct an absolute event from the given dof's.

Parameters:

dx -

dy -

dz -

DOF3Event

public DOF3Event(MotionEvent prevEvent,
                 float x,
                 float y,
                 float z)

Same as this(prevEvent instanceof DOF3Event ? (DOF3Event) prevEvent : null, x, y, z).

See Also:

DOF3Event(DOF3Event, float, float, float)

DOF3Event

public DOF3Event(DOF3Event prevEvent,
                 float x,
                 float y,
                 float z)

Construct a relative event from the given previous event, dof's and modifiers.

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 -

y -

z -

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class MotionEvent

equals

public boolean equals(Object obj)

Overrides:

equals in class MotionEvent

get

public DOF3Event 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 DOF3Event 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 DOF3Event 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()

y

public float y()

Returns:

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

dy

public float dy()

Returns:

dof-2 delta

prevY

public float prevY()

Returns:

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

z

public float z()

Returns:

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

dz

public float dz()

Returns:

dof-3 delta

prevZ

public float prevZ()

Returns:

previous dof-3, 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

dof2Event

public DOF2Event dof2Event()

Reduces the event to a DOF2Event (lossy reduction). Keeps dof-1 and dof-2 and discards dof-3.