DOF6Event (Javadocs: proscene)

java.lang.Object
- remixlab.bias.BogusEvent
- - remixlab.bias.event.MotionEvent
  - - remixlab.bias.event.DOF6Event

All Implemented Interfaces:

Copyable
```
public class DOF6Event
extends MotionEvent
```
A MotionEvent with six degrees-of-freedom ( x(), y(), z() , rx(), ry() and rz()).

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DOF3Event`	`dof3Event()` Convenience function that simply returns `return dof3Event(true)`
`DOF3Event`	`dof3Event(boolean fromTranslation)` Reduces the event to a `DOF3Event` (lossy reduction).
`float`	`drx()`
`float`	`dry()`
`float`	`drz()`
`float`	`dx()`
`float`	`dy()`
`float`	`dz()`
`boolean`	`equals(Object obj)`
`DOF6Event`	`fire()` Same as `this.get()` but sets the `BogusEvent.fired()` flag to true.
`DOF6Event`	`flush()` Same as `this.get()` but sets the `BogusEvent.flushed()` flag to true.
`DOF6Event`	`get()` Returns a deep copy of the object.
`int`	`hashCode()`
`boolean`	`isNull()` Only `MotionEvent`s may be null.
`void`	`modulate(float[] sens)` Modulate the event dofs according to `sens`.
`float`	`pitch()` Alias for `ry()`, only meaningful if the event `MotionEvent.isRelative()`
`float`	`prevRX()`
`float`	`prevRY()`
`float`	`prevRZ()`
`float`	`prevX()`
`float`	`prevY()`
`float`	`prevZ()`
`float`	`roll()` Alias for `rx()`, only meaningful if the event `MotionEvent.isRelative()`
`float`	`rx()`
`float`	`ry()`
`float`	`rz()`
`float`	`x()`
`float`	`y()`
`float`	`yaw()` alias for `rz()`, only meaningful if the event `MotionEvent.isRelative()`
`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
  - DOF6Event
```
public DOF6Event(float dx,
                 float dy,
                 float dz,
                 float drx,
                 float dry,
                 float drz,
                 int modifiers,
                 int id)
```
    Construct an absolute event from the given dof's and modifiers.
    
    Parameters:
    
    dx -
    
    dy -
    
    dz -
    
    drx -
    
    dry -
    
    drz -
    
    modifiers -
    
    id -
  - DOF6Event
```
public DOF6Event(MotionEvent prevEvent,
                 float x,
                 float y,
                 float z,
                 float rx,
                 float ry,
                 float rz,
                 int modifiers,
                 int id)
```
    Same as this(prevEvent instanceof DOF6Event ? (DOF6Event) prevEvent : null, x, y, z, rx, ry, rz, modifiers, id).
    
    See Also:
    
    DOF6Event(DOF6Event, float, float, float, float, float, float, int, int)
  - DOF6Event
```
public DOF6Event(DOF6Event prevEvent,
                 float x,
                 float y,
                 float z,
                 float rx,
                 float ry,
                 float rz,
                 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 -
    
    rx -
    
    ry -
    
    rz -
    
    modifiers -
    
    id -
  - DOF6Event
```
public DOF6Event(float dx,
                 float dy,
                 float dz,
                 float drx,
                 float dry,
                 float drz)
```
    Construct an absolute event from the given dof's and modifiers.
    
    Parameters:
    
    dx -
    
    dy -
    
    dz -
    
    drx -
    
    dry -
    
    drz -
  - DOF6Event
```
public DOF6Event(MotionEvent prevEvent,
                 float x,
                 float y,
                 float z,
                 float rx,
                 float ry,
                 float rz)
```
    Same as this(prevEvent instanceof DOF6Event ? (DOF6Event) prevEvent : null, x, y, z, rx, ry, rz).
    
    See Also:
    
    DOF6Event(DOF6Event, float, float, float, float, float, float)
  - DOF6Event
```
public DOF6Event(DOF6Event prevEvent,
                 float x,
                 float y,
                 float z,
                 float rx,
                 float ry,
                 float rz)
```
    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 -
    
    rx -
    
    ry -
    
    rz -
- Method Detail
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class MotionEvent
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class MotionEvent
  - get
```
public DOF6Event 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 DOF6Event 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 DOF6Event 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:
    
    dof1, only meaningful if the event MotionEvent.isRelative()
  - dx
```
public float dx()
```
    Returns:
    
    dof1 delta
  - prevX
```
public float prevX()
```
    Returns:
    
    previous dof1, only meaningful if the event MotionEvent.isRelative()
  - y
```
public float y()
```
    Returns:
    
    dof2, only meaningful if the event MotionEvent.isRelative()
  - dy
```
public float dy()
```
    Returns:
    
    dof2 delta
  - prevY
```
public float prevY()
```
    Returns:
    
    previous dof2, only meaningful if the event MotionEvent.isRelative()
  - z
```
public float z()
```
    Returns:
    
    dof3, only meaningful if the event MotionEvent.isRelative()
  - dz
```
public float dz()
```
    Returns:
    
    dof3 delta
  - prevZ
```
public float prevZ()
```
    Returns:
    
    previous dof3, only meaningful if the event MotionEvent.isRelative()
  - roll
```
public float roll()
```
    Alias for rx(), only meaningful if the event MotionEvent.isRelative()
  - rx
```
public float rx()
```
    Returns:
    
    dof4, only meaningful if the event MotionEvent.isRelative()
  - pitch
```
public float pitch()
```
    Alias for ry(), only meaningful if the event MotionEvent.isRelative()
  - ry
```
public float ry()
```
    Returns:
    
    dof5, only meaningful if the event MotionEvent.isRelative()
  - yaw
```
public float yaw()
```
    alias for rz(), only meaningful if the event MotionEvent.isRelative()
  - rz
```
public float rz()
```
    Returns:
    
    dof6, only meaningful if the event MotionEvent.isRelative()
  - drx
```
public float drx()
```
    Returns:
    
    dof4 delta
  - dry
```
public float dry()
```
    Returns:
    
    dof5 delta
  - drz
```
public float drz()
```
    Returns:
    
    dof6 delta
  - prevRX
```
public float prevRX()
```
    Returns:
    
    previous dof4, only meaningful if the event MotionEvent.isRelative()
  - prevRY
```
public float prevRY()
```
    Returns:
    
    previous dof5, only meaningful if the event MotionEvent.isRelative()
  - prevRZ
```
public float prevRZ()
```
    Returns:
    
    previous dof6, 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
  - dof3Event
```
public DOF3Event dof3Event()
```
    Convenience function that simply returns return dof3Event(true)
    
    See Also:
    
    dof3Event(boolean)
  - dof3Event
```
public DOF3Event dof3Event(boolean fromTranslation)
```
    Reduces the event to a DOF3Event (lossy reduction).
    
    Parameters:
    
    fromTranslation - if true keeps dof1, dof2 and dof3; otherwise keeps dof4, dof4 and dof6.

Class DOF6Event

Field Summary

Fields inherited from class remixlab.bias.BogusEvent

Constructor Summary

Method Summary

Methods inherited from class remixlab.bias.event.MotionEvent

Methods inherited from class remixlab.bias.BogusEvent

Methods inherited from class java.lang.Object

Constructor Detail

DOF6Event

DOF6Event

DOF6Event

DOF6Event

DOF6Event

DOF6Event

Method Detail

hashCode

equals

get

flush

fire

x

dx

prevX

y

dy

prevY

z

dz

prevZ

roll

rx

pitch

ry

yaw

rz

drx

dry

drz

prevRX

prevRY

prevRZ

modulate

isNull

dof3Event

dof3Event