ScummVM API documentation
ZVision::Scroller Class Reference

#include <scroller.h>

Public Member Functions

 Scroller (const Common::Point &activePos, const Common::Point &idlePos, const int16 period=500)
 
void reset ()
 Set idle and immediately jump to idle position.
 
bool update (uint32 deltatime)
 Calculate updated position of scrolled graphics; return true if redraw is necessary.
 
void setActive (bool active)
 Set active or idle & scroll at set speed from current position to that position.
 
bool isMoving ()
 

Public Attributes

Common::Point _pos
 

Detailed Description

Automatically scroll a GUI menu or similar graphical element between an active and an idle position Movement in two dimensions; idle & active positions specified as Common::Point Movement is at constant speed determined by period, specified in ms. If active/idle status is changed mid-transition, will scroll from current position to the appropriate position.


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