ScummVM API documentation
ZVision::CursorManager Class Reference

#include <cursor_manager.h>

Public Member Functions

 CursorManager (ZVision *engine, const Graphics::PixelFormat pixelFormat)
 
void initialize ()
 
void changeCursor (int id)
 
int getCursorId (const Common::String &name)
 
void setItemID (int id)
 
void cursorDown (bool pushed)
 
void showMouse (bool vis)
 

Detailed Description

Class to manage cursor changes. The actual changes have to be done through CursorMan. Otherwise the cursor will disappear after GMM or debug console. TODO: Figure out a way to get rid of the extraneous data copying due to having to use CursorMan

Member Function Documentation

◆ initialize()

void ZVision::CursorManager::initialize ( )

Creates the idle cursor and shows it

◆ changeCursor()

void ZVision::CursorManager::changeCursor ( int  id)

Change cursor to specified cursor ID. If item setted to not 0 and cursor id idle/acrive/handpu change cursor to item.

Parameters
idWanted cursor id.

◆ getCursorId()

int ZVision::CursorManager::getCursorId ( const Common::String name)

Return founded id for string contains cursor name

Parameters
nameCursor name
Returns
Id of cursor or idle cursor id if not found

◆ setItemID()

void ZVision::CursorManager::setItemID ( int  id)

Load cursor for item by id, and try to change cursor to item cursor if it's not 0

Parameters
idItem id or 0 for no item cursor

◆ cursorDown()

void ZVision::CursorManager::cursorDown ( bool  pushed)

Change the cursor to a certain push state. If the cursor is already in the specified push state, nothing will happen.

Parameters
pushedShould the cursor be pushed (true) or not pushed (false) (Another way to say it: down or up)

◆ showMouse()

void ZVision::CursorManager::showMouse ( bool  vis)

Show or hide mouse cursor.

Parameters
visShould the cursor be showed (true) or hide (false)

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