org.jagatoo.input.devices.components
Class MouseWheel

java.lang.Object
  extended by org.jagatoo.input.devices.components.DeviceComponent
      extended by org.jagatoo.input.devices.components.AnalogDeviceComponent
          extended by org.jagatoo.input.devices.components.MouseWheel

public class MouseWheel
extends AnalogDeviceComponent

This is a simple abstaction of a mouse-wheel.


Nested Class Summary
 class MouseWheel.WheelUpDownComponent
          To allow for using the MouseWheel's up/down state-changes like Key/Button events we need this simple DeviceComponent.
 
Nested classes/interfaces inherited from class org.jagatoo.input.devices.components.DeviceComponent
DeviceComponent.Type
 
Field Summary
static MouseWheel GLOBAL_WHEEL
           
 
Fields inherited from class org.jagatoo.input.devices.components.DeviceComponent
nextID
 
Constructor Summary
MouseWheel(Mouse mouse)
          Creates a new MouseWheel instance.
MouseWheel(Mouse mouse, java.lang.String name)
          Creates a new MouseWheel instance.
 
Method Summary
 MouseWheel.WheelUpDownComponent getDown()
           
 Mouse getMouse()
           
 MouseWheel.WheelUpDownComponent getUp()
           
 
Methods inherited from class org.jagatoo.input.devices.components.AnalogDeviceComponent
addValue, addValue, getFloatValue, getIntValue, getScale, setScale, setValue, setValue, setValue
 
Methods inherited from class org.jagatoo.input.devices.components.DeviceComponent
bindAction, bindAction, getDeviceComponentID, getLocalizedName, getName, getType, isAnalog, isDigital, notifyBoundActions, unbindAction, unbindAction
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

GLOBAL_WHEEL

public static final MouseWheel GLOBAL_WHEEL
Constructor Detail

MouseWheel

public MouseWheel(Mouse mouse,
                  java.lang.String name)
Creates a new MouseWheel instance.

Parameters:
mouse - the mouse, this wheel belongs to
name - the wheel's name

MouseWheel

public MouseWheel(Mouse mouse)
Creates a new MouseWheel instance.

Parameters:
mouse - the mouse, this wheel belongs to
Method Detail

getMouse

public final Mouse getMouse()
Returns:
the Mouse, this wheel belongs to. This can be null for the global mouse-wheel.

getUp

public final MouseWheel.WheelUpDownComponent getUp()
Returns:
the special DeviceComponent, that can be used like a key/button for input bindings.

getDown

public final MouseWheel.WheelUpDownComponent getDown()
Returns:
the special DeviceComponent, that can be used like a key/button for input bindings.