cursor.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef STARK_UI_CURSOR_H
#define STARK_UI_CURSOR_H

#include "common/rect.h"
#include "common/str.h"
#include "common/scummsys.h"

namespace Stark {

class VisualImageXMG;
class VisualText;

namespace Gfx {
class Driver;
}

namespace Resources {
class Sound;
}

class Cursor {
public:
    explicit Cursor(Gfx::Driver *gfx);
    ~Cursor();

    void render();

    void setMousePosition(const Common::Point &pos);

    void setItemActive(bool fading);

    void onScreenChanged();

    Common::Point getMousePosition(bool unscaled = false) const;

    Common::Rect getHotRectangle() const;

    enum CursorType {
        kImage = -1,
        kDefault = 0,
        kActive = 3,
        kPassive = 9,
        kEye = 10,
        kHand = 11,
        kMouth = 12
    };

    void setCursorType(CursorType type);
    void setCursorImage(VisualImageXMG *image);
    void setMouseHint(const Common::String &hint);
private:
    void updateFadeLevel();
    void updateHintDelay();

    Gfx::Driver *_gfx;

    Common::String _currentHint;
    int32 _hintDisplayDelay;

    Common::Point _mousePos;
    VisualImageXMG *_cursorImage;
    VisualText *_mouseText;
    CursorType _currentCursorType;

    Resources::Sound *_actionHoverSound;

    bool _itemActive;
    float _fadeLevel;
    bool _fadeLevelIncreasing;
    static const float _fadeValueMax;
};

} // End of namespace Stark

#endif // STARK_UI_CURSOR_H