aniobject.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/>.
 *
 *
 * This file is dual-licensed.
 * In addition to the GPLv3 license mentioned above, this code is also
 * licensed under LGPL 2.1. See LICENSES/COPYING.LGPL file for the
 * full text of the license.
 *
 */

#ifndef GOB_ANIOBJECT_H
#define GOB_ANIOBJECT_H

#include "common/system.h"

#include "gob/backbuffer.h"

namespace Gob {

class ANIFile;
class CMPFile;
class Surface;

class ANIObject : public BackBuffer {
public:
    enum Mode {
        kModeContinuous, 
        kModeOnce        
    };

    ANIObject(const ANIFile &ani);
    ANIObject(const CMPFile &cmp);
    virtual ~ANIObject();

    void setVisible(bool visible);

    bool isVisible() const;

    void setPause(bool pause);

    bool isPaused() const;

    void setMode(Mode mode);

    virtual void setPosition();
    virtual void setPosition(int16 x, int16 y);

    void getPosition(int16 &x, int16 &y) const;

    void getFramePosition(int16 &x, int16 &y, uint16 n = 0) const;
    void getFrameSize(int16 &width, int16 &height, uint16 n = 0) const;

    bool isIn(int16 x, int16 y) const;
    bool isIn(const ANIObject &obj) const;

    void setAnimation(uint16 animation);

    void rewind();

    void setFrame(uint16 frame);

    uint16 getAnimation() const;
    uint16 getFrame() const;

    bool lastFrame() const;

    virtual bool draw(Surface &dest, int16 &left, int16 &top, int16 &right, int16 &bottom);
    virtual bool clear(Surface &dest, int16 &left, int16 &top, int16 &right, int16 &bottom);

    virtual void advance();

private:
    const ANIFile *_ani; 
    const CMPFile *_cmp; 

    uint16 _animation; 
    uint16 _frame;     

    bool _visible; 
    bool _paused;  

    Mode _mode; 

    int16 _x; 
    int16 _y; 


    bool drawCMP(Surface &dest, int16 &left, int16 &top, int16 &right, int16 &bottom);
    bool drawANI(Surface &dest, int16 &left, int16 &top, int16 &right, int16 &bottom);
};

} // End of namespace Gob

#endif // GOB_ANIOBJECT_H