org.jsfml.window.event

Class MouseWheelEvent

java.lang.Object

org.jsfml.window.event.Event

org.jsfml.window.event.MouseEvent

org.jsfml.window.event.MouseWheelEvent

public final class MouseWheelEvent
extends MouseEvent

Represents mouse wheel movement events.

Objects of this class are created for events of type Event.Type.MOUSE_WHEEL_MOVED.

Nested Class Summary

Nested classes/interfaces inherited from class org.jsfml.window.event.Event

Event.Type

Field Summary

Fields

Modifier and Type	Field and Description
int	delta The amount of ticks that the mouse wheel was moved.

Fields inherited from class org.jsfml.window.event.MouseEvent

position

Fields inherited from class org.jsfml.window.event.Event

type

Constructor Summary

Constructors

Constructor and Description
MouseWheelEvent(int type, int x, int y, int delta) Constructs a new mouse wheel event.

Method Summary

Methods

Modifier and Type	Method and Description
MouseWheelEvent	asMouseWheelEvent() Attempts to cast this event to a MouseWheelEvent.

Methods inherited from class org.jsfml.window.event.MouseEvent

asMouseEvent

Methods inherited from class org.jsfml.window.event.Event

asJoystickButtonEvent, asJoystickEvent, asJoystickMoveEvent, asKeyEvent, asMouseButtonEvent, asSizeEvent, asTextEvent

Methods inherited from class java.lang.Object

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

Field Detail

delta

public final int delta

The amount of ticks that the mouse wheel was moved.

Constructor Detail

MouseWheelEvent

public MouseWheelEvent(int type,
               int x,
               int y,
               int delta)

Constructs a new mouse wheel event.

Parameters:

type - the type of the event. This must be a valid ordinal in the Event.Type enumeration.

x - the X coordinate of the mouse cursor relative to the window.

y - the Y coordinate of the mouse cursor relative to the window.

delta - the amount of ticks that the mouse wheel was moved.

Method Detail

asMouseWheelEvent

public MouseWheelEvent asMouseWheelEvent()

Description copied from class: Event

Attempts to cast this event to a MouseWheelEvent.

Overrides:

asMouseWheelEvent in class Event

Returns:

the event cast to a MouseWheelEvent if its type is Event.Type.MOUSE_WHEEL_MOVED, null otherwise.