Sci::GfxCursor32 Class Reference

Inheritance diagram for Sci::GfxCursor32:

Public Member Functions
void	init (const Buffer &outputBuffer)
bool	deviceMoved (Common::Point &position)
virtual void	gonnaPaint (Common::Rect paintRect)
virtual void	paintStarting ()
virtual void	donePainting ()
virtual void	hide ()
virtual void	unhide ()
virtual void	show ()
virtual void	setView (const GuiResourceId viewId, const int16 loopNo, const int16 celNo)
void	setPosition (const Common::Point &position)
void	setRestrictedArea (const Common::Rect &rect)
void	clearRestrictedArea ()
void	saveLoadWithSerializer (Common::Serializer &ser) override
virtual void	setMacCursorRemapList (int cursorCount, reg_t *cursors)

Protected Attributes
CelInfo32	_cursorInfo
int	_hideCount

Member Function Documentation

init()

void Sci::GfxCursor32::init

(

const Buffer &

outputBuffer

)

Initialises the cursor system with the given buffer to use as the output buffer for rendering the cursor.

deviceMoved()

bool Sci::GfxCursor32::deviceMoved

(

Common::Point &

position

)

Called when the hardware mouse moves.

gonnaPaint()

virtual void Sci::GfxCursor32::gonnaPaint ( Common::Rect  paintRect )

virtual

Called by GfxFrameout once for each show rectangle that is going to be drawn to hardware.

Reimplemented in Sci::GfxMacCursor32.

paintStarting()

virtual void Sci::GfxCursor32::paintStarting ( )

virtual

Called by GfxFrameout when the rendering to hardware begins.

Reimplemented in Sci::GfxMacCursor32.

donePainting()

virtual void Sci::GfxCursor32::donePainting ( )

virtual

Called by GfxFrameout when the output buffer has finished rendering to hardware.

Reimplemented in Sci::GfxMacCursor32.

hide()

virtual void Sci::GfxCursor32::hide ( )

virtual

Hides the cursor. Each call to hide will increment a hide counter, which must be returned to 0 before the cursor will be shown again.

Reimplemented in Sci::GfxMacCursor32.

unhide()

virtual void Sci::GfxCursor32::unhide ( )

virtual

Shows the cursor, if the hide counter is returned to 0.

Reimplemented in Sci::GfxMacCursor32.

show()

virtual void Sci::GfxCursor32::show ( )

virtual

Shows the cursor regardless of the state of the hide counter.

Reimplemented in Sci::GfxMacCursor32.

setView()

virtual void Sci::GfxCursor32::setView ( const GuiResourceId  viewId, const int16  loopNo, const int16  celNo  )

virtual

Sets the view used to render the cursor.

Reimplemented in Sci::GfxMacCursor32.

setPosition()

void Sci::GfxCursor32::setPosition

(

const Common::Point &

position

)

Explicitly sets the position of the cursor, in game script coordinates.

setRestrictedArea()

void Sci::GfxCursor32::setRestrictedArea

(

const Common::Rect &

rect

)

Sets the region that the mouse is allowed to move within.

clearRestrictedArea()

void Sci::GfxCursor32::clearRestrictedArea

(

)

Removes restrictions on mouse movement.

Member Data Documentation

_cursorInfo

CelInfo32 Sci::GfxCursor32::_cursorInfo

protected

Information about the current cursor. Used to restore cursor when loading a savegame.

_hideCount

int Sci::GfxCursor32::_hideCount

protected

The number of times the cursor has been hidden.

---

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

• engines/sci/graphics/cursor32.h