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 ASYLUM_SYSTEM_CURSOR_H
#define ASYLUM_SYSTEM_CURSOR_H

#include "common/events.h"
#include "common/rect.h"

#include "asylum/shared.h"

namespace Asylum {

class AsylumEngine;
class GraphicResource;

enum CursorAnimation {
    kCursorAnimationNone   = 0,
    kCursorAnimationLinear = 1,
    kCursorAnimationMirror = 2
};

class Cursor {
public:
    Cursor(AsylumEngine *engine);
    virtual ~Cursor();

    void show() const;

    void hide() const;

    bool isHidden() const;

    void set(ResourceId resourceId, int32 cnt = 0, CursorAnimation anim = kCursorAnimationMirror, int32 frames = -1);

    void animate();

    // Accessors
    void setForceHide(bool state) { _forceHide = state; }
    ResourceId getResourceId() { return _graphicResourceId; }
    CursorAnimation getAnimation() { return _animation; }

    const Common::Point position() const;

private:
    AsylumEngine *_vm;

    // Cursor resource
    GraphicResource *_cursorRes;

    Common::Point _pos;

    Common::Point _hotspot;

    // The number of milliseconds between cursor gfx updates
    uint32 _nextTick;

    int32 _frameStep;

    // NOTE: The original engine contains a function that assigns global variables to a
    // struct associated with cursor graphics info. Since this functionality only
    // ever seems to be used to reference cursor info, the struct members
    // may as well be class members in order to simplify the logic a bit
    ResourceId _graphicResourceId;
    uint32 _currentFrame;
    uint32 _lastFrameIndex;
    int32 _counter;
    CursorAnimation _animation;

    bool _forceHide;

    void update();

    void updateFrame();

    Common::Point getHotspot(uint32 frameIndex);
};

} // end of namespace Asylum

#endif // ASYLUM_SYSTEM_CURSOR_H