scene.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 SHERLOCK_SCENE_H
#define SHERLOCK_SCENE_H

#include "common/scummsys.h"
#include "common/array.h"
#include "common/rect.h"
#include "common/serializer.h"
#include "sherlock/objects.h"
#include "sherlock/resources.h"
#include "sherlock/screen.h"

namespace Sherlock {

#define MAX_ZONES   40
#define INFO_LINE   140

class SherlockEngine;

struct BgFileHeader {
    int _numStructs;
    int _numImages;
    int _numcAnimations;
    int _descSize;
    int _seqSize;

    // Serrated Scalpel
    int _fill;

    // Rose Tattoo
    int _scrollSize;
    int _bytesWritten;              // Size of the main body of the RRM
    int _fadeStyle;                 // Fade style
    byte _palette[PALETTE_SIZE];    // Palette


    BgFileHeader();

    void load(Common::SeekableReadStream &s, bool isRoseTattoo);
};

struct BgFileHeaderInfo {
    int _filesize;              // How long images are
    int _maxFrames;             // How many unique frames in object
    Common::String _filename;   // Filename of object

    void load(Common::SeekableReadStream &s);
    void load3DO(Common::SeekableReadStream &s);
};

class Exit: public Common::Rect {
public:
    int _scene;
    int _allow;
    PositionFacing _newPosition;

    Common::String _dest;
    int _image;                 // Arrow image to use

    void load(Common::SeekableReadStream &s, bool isRoseTattoo);
    void load3DO(Common::SeekableReadStream &s);
};

struct SceneEntry {
    Common::Point _startPosition;
    int _startDir;
    int _allow;

    void load(Common::SeekableReadStream &s);
    void load3DO(Common::SeekableReadStream &s);
};

struct SceneSound {
    Common::String _name;
    int _priority;

    void load(Common::SeekableReadStream &s);
    void load3DO(Common::SeekableReadStream &s);
};

class ObjectArray : public Common::Array<Object> {
public:
    int indexOf(const Object &obj) const;
};

class ScaleZone: public Common::Rect {
public:
    int _topNumber;     // Numerator of scale size at the top of the zone
    int _bottomNumber;  // Numerator of scale size at the bottom of the zone

    void load(Common::SeekableReadStream &s);
};

class WalkArray : public Common::Array < Common::Point > {
public:
    int _pointsCount;
    int _fileOffset;

    WalkArray() : _pointsCount(0), _fileOffset(-1) {}

    void load(Common::SeekableReadStream &s, bool isRoseTattoo);
};

class Scene {
private:
    void loadSceneSounds();

    void checkSceneStatus();

    void checkInventory();

    void transitionToScene();

    void saveSceneStatus();
protected:
    SherlockEngine *_vm;
    Common::Path _roomFilename;

    virtual bool loadScene(const Common::Path &filename);

    virtual void checkBgShapes();

    virtual void drawAllShapes() = 0;

    virtual void paletteLoaded() {}

    Scene(SherlockEngine *vm);
public:
    int _currentScene;
    int _goToScene;
    bool **_sceneStats;
    bool _walkedInScene;
    int _version;
    bool _compressed;
    int _invGraphicItems;
    Common::String _comments;
    Common::Array<char> _descText;
    Common::Array<Common::Rect> _zones;
    ObjectArray _bgShapes;
    Common::Array<CAnim> _cAnim;
    Common::Array<byte> _sequenceBuffer;
    Common::Array<SceneImage> _images;
    int _walkDirectory[MAX_ZONES][MAX_ZONES];
    Common::Array<WalkArray> _walkPoints;
    Common::Array<Exit> _exits;
    SceneEntry _entrance;
    Common::Array<SceneSound> _sounds;
    Common::Array<Object *> _canimShapes;
    Common::Array<ScaleZone> _scaleZones;
    Common::StringArray _objSoundList;
    bool _restoreFlag;
    int _animating;
    bool _doBgAnimDone;
    int _tempFadeStyle;
    int _cAnimFramePause;
public:
    static Scene *init(SherlockEngine *vm);
    virtual ~Scene();

    void selectScene();

    void checkSceneFlags(bool mode);

    Exit *checkForExit(const Common::Rect &r);

    int toggleObject(const Common::String &name);

    int checkForZones(const Common::Point &pt, int zoneType);

    int whichZone(const Common::Point &pt);

    virtual void freeScene();

    virtual int closestZone(const Common::Point &pt) = 0;

    virtual int findBgShape(const Common::Point &pt) = 0;

    virtual void synchronize(Serializer &s);
public:
    virtual void doBgAnim() = 0;

    virtual void updateBackground();

    virtual int startCAnim(int cAnimNum, int playRate = 1) = 0;
};

} // End of namespace Sherlock

#endif