org.jsfml.window.event

Class MouseEvent

java.lang.Object

org.jsfml.window.event.Event

org.jsfml.window.event.MouseEvent

Direct Known Subclasses:

MouseButtonEvent, MouseWheelEvent

public class MouseEvent
extends Event

Represents generic mouse events.

Objects of this class are created for events of type Event.Type.MOUSE_ENTERED, Event.Type.MOUSE_MOVED, Event.Type.MOUSE_LEFT, Event.Type.MOUSE_WHEEL_MOVED, Event.Type.MOUSE_BUTTON_PRESSED or Event.Type.MOUSE_BUTTON_RELEASED.

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
Vector2i	position The position of the mouse pointer in pixels, relative to the window's top left corner.

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

type

Constructor Summary

Constructors

Constructor and Description
MouseEvent(int type, int x, int y) /** Constructs a new mouse button event.

Method Summary

Methods

Modifier and Type	Method and Description
MouseEvent	asMouseEvent() Attempts to cast this event to a MouseEvent.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

position

public final Vector2i position

The position of the mouse pointer in pixels, relative to the window's top left corner.

Constructor Detail

MouseEvent

public MouseEvent(int type,
          int x,
          int y)

/** Constructs a new mouse button 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.

Method Detail

asMouseEvent

public MouseEvent asMouseEvent()

Description copied from class: Event

Attempts to cast this event to a MouseEvent.

Overrides:

asMouseEvent in class Event

Returns:

the event cast to a MouseEvent if its type is one of Event.Type.MOUSE_ENTERED, Event.Type.MOUSE_MOVED, Event.Type.MOUSE_LEFT, Event.Type.MOUSE_BUTTON_PRESSED, Event.Type.MOUSE_BUTTON_RELEASED or Event.Type.MOUSE_WHEEL_MOVED, null otherwise.