ScummVM API documentation
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Ultima::Ultima8::Mouse Class Reference

Public Types

enum  MouseButton {
  BUTTON_NONE = 0, BUTTON_LEFT = 1, BUTTON_RIGHT = 2, BUTTON_MIDDLE = 3,
  MOUSE_LAST
}
 
enum  MouseCursor {
  MOUSE_NORMAL = 0, MOUSE_NONE = 1, MOUSE_TARGET = 2, MOUSE_WAIT = 3,
  MOUSE_HAND = 4, MOUSE_QUILL = 5, MOUSE_MAGGLASS = 6, MOUSE_CROSS = 7
}
 
enum  DraggingState { DRAG_NOT = 0, DRAG_OK = 1, DRAG_INVALID = 2, DRAG_TEMPFAIL = 3 }
 

Public Member Functions

bool buttonDown (MouseButton button)
 
bool buttonUp (MouseButton button)
 
int getMouseLength (int mx, int my) const
 get mouse cursor length. 0 = short, 1 = medium, 2 = long
 
int getMouseLength () const
 get mouse cursor length for the current coordinates
 
Direction getMouseDirectionScreen (int mx, int my) const
 get mouse cursor direction on the screen. 0 = up, 1 = up-right, 2 = right, etc...
 
Direction getMouseDirectionScreen () const
 get mouse cursor direction on the screen using the current coordinates.
 
Direction getMouseDirectionWorld (int mx, int my) const
 get mouse cursor direction in the world. 0 = up, 1 = up-right, 2 = right, etc...
 
Direction getMouseDirectionWorld () const
 get mouse cursor direction in the world using the current coordinates.
 
void getMouseCoords (int32 &mx, int32 &my) const
 get current mouse cursor location
 
void setMouseCoords (int mx, int my)
 set current mouse cursor location
 
bool isMouseDownEvent (MouseButton button) const
 
void popAllCursors ()
 remove all existing cursors
 
void setMouseCursor (MouseCursor cursor)
 set the current mouse cursor
 
void flashCrossCursor ()
 flash the red cross mouse cursor for a brief while
 
void pushMouseCursor (MouseCursor cursor)
 push the current mouse cursor to the stack
 
void popMouseCursor ()
 pop the last mouse cursor from the stack
 
int getMouseFrame ()
 get the current mouse frame
 
DraggingState dragging () const
 
void setDraggingOffset (int32 x, int32 y)
 
void getDraggingOffset (int32 &x, int32 &y)
 
uint32 getDoubleClickTime () const
 
void handleDelayedEvents ()
 
Gump * getMouseOverGump () const
 
void resetMouseOverGump ()
 
void update ()
 

Static Public Member Functions

static Mouse * get_instance ()
 

Member Function Documentation

◆ buttonDown()

bool Ultima::Ultima8::Mouse::buttonDown ( MouseButton  button)

Called when a mouse button is pressed down

◆ buttonUp()

bool Ultima::Ultima8::Mouse::buttonUp ( MouseButton  button)

Called when a mouse ubtton is released

The documentation for this class was generated from the following file: