Olympe SDK

Class: MoveEvent

olympe.ui.events. MoveEvent

A class representing the 'move' events generated by the pointer. Using a mouse, for instance, a 'move' starts when the right button is clicked and the pointers starts moving. It ends when the button is released.

new MoveEvent(relativePos, absolutePos, delta, eventTimeStamp)

Creates an instance of a MoveEvent.

Parameters:
Name Type Description
relativePos olympe.df.Vector2

position relative to the coordinates of the Element
absolutePos olympe.df.Vector2

absolute position
delta olympe.df.Vector2
eventTimeStamp olympe.df.PODateTime

Extends

Methods

getAbsolutePos()

Gets the absolute starting position of the move event.

Returns:

Absolute Mouse position

Type
olympe.df.Vector2

getDelta()

Gets the delta, or difference, between the current position and the starting position.

Returns:

(x,y) values for the delta

Type
olympe.df.Vector2

getEventTimestamp()

Gets the time stamp for that event, that is the date and time of its creation.

Inherited From:
Overrides:
Returns:

the creation date and time for this event

Type
olympe.df.PODateTime

getRelativePos()

Gets the starting position of the move event relative to the coordinates of its Element.

Returns:

Mouse position relative to targeted element

Type
olympe.df.Vector2