riven_card.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 RIVEN_CARD_H
#define RIVEN_CARD_H

#include "mohawk/riven_scripts.h"
#include "mohawk/riven_sound.h"

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

namespace Mohawk {

class RivenHotspot;
struct MLSTRecord;

class RivenCard {
public:
    RivenCard(MohawkEngine_Riven *vm, uint16 id);
    ~RivenCard();

    struct Picture {
        uint16 index;
        uint16 id;
        Common::Rect rect;
    };

    void enter(bool unkMovies);

    void leave();

    void runScript(uint16 scriptType);

    uint16 getId() const;

    Picture getPicture(uint16 index) const;

    void drawPicture(uint16 index, bool queue = false);

    void playSound(uint16 index, bool queue = false);

    SLSTRecord getSound(uint16 index) const;

    void overrideSound(uint16 index, uint16 withIndex);

    void playMovie(uint16 index, bool queue = false);

    MLSTRecord getMovie(uint16 index) const;

    void drawHotspotRects();

    void initializeZipMode();

    RivenHotspot *getHotspotContainingPoint(const Common::Point &point) const;

    RivenHotspot *getHotspotByName(const Common::String &name, bool optional = false) const;

    RivenHotspot *findEnabledHotspotByName(const char **names) const;

    RivenHotspot *getHotspotByBlstId(const uint16 blstId) const;

    RivenHotspot *getCurHotspot() const;

    Common::Array<RivenHotspot *> getHotspots() const;

    void activateHotspotEnableRecord(uint16 index);

    void activateWaterEffect(uint16 index);

    RivenScriptPtr onMouseDown(const Common::Point &mouse);

    RivenScriptPtr onMouseUp(const Common::Point &mouse);

    RivenScriptPtr onMouseMove(const Common::Point &mouse);

    RivenScriptPtr onKeyAction(RivenAction keyAction);

    RivenScriptPtr onFrame();

    RivenScriptPtr onMouseUpdate();

    RivenScriptPtr onMouseDragUpdate();

    void dump() const;

private:
    void loadCardResource(uint16 id);
    void loadHotspots(uint16 id);
    void loadCardPictureList(uint16 id);
    void loadCardSoundList(uint16 id);
    void loadCardMovieList(uint16 id);
    void loadCardHotspotEnableList(uint16 id);
    void loadCardWaterEffectList(uint16 id);
    void applyPatches(uint16 id);
    void applyPropertiesPatchE2E(uint32 globalId);
    void applyPropertiesPatch1518D(uint32 globalId);
    void applyPropertiesPatch8EB7(uint32 globalId, const Common::String &var, uint16 hotspotId);
    void applyPropertiesPatch2E76(uint32 globalId);
    void applyPropertiesPatch22118(uint32 globalId);
    void applyPropertiesPatch2B414(uint32 globalId);
    void setCurrentCardVariable();

    void moveHotspot(uint16 blstId, const Common::Rect &position);
    void addMenuHotspot(uint16 blstId, const Common::Rect &position, uint16 index,
                        uint16 externalCommandNameId, const char *externalCommandName);

    RivenScriptPtr getScript(uint16 scriptType) const;
    void defaultLoadScript();

    void updateMouseCursor();

    struct HotspotEnableRecord {
        uint16 index;
        uint16 enabled;
        uint16 hotspotId;
    };

    struct WaterEffectRecord {
        uint16 index;
        uint16 sfxeId;
        uint16 u0;
    };

    MohawkEngine_Riven *_vm;

    // General card data
    uint16 _id;
    int16 _name;
    uint16 _zipModePlace;
    RivenScriptList _scripts;

    Common::Array<RivenHotspot *> _hotspots;
    RivenHotspot *_hoveredHotspot;
    RivenHotspot *_pressedHotspot;

    // Resource lists
    Common::Array<Picture> _pictureList;
    Common::Array<SLSTRecord> _soundList;
    Common::Array<MLSTRecord> _movieList;
    Common::Array<HotspotEnableRecord> _hotspotEnableList;
    Common::Array<WaterEffectRecord> _waterEffectList;
};

struct MLSTRecord {
    uint16 index;
    uint16 movieID;
    uint16 playbackSlot;
    uint16 left;
    uint16 top;
    uint16 lowBoundTime;
    uint16 startTime;
    uint16 highBoundTime;
    uint16 loop;
    uint16 volume;
    uint16 rate;
};

class RivenHotspot {
public:
    RivenHotspot(MohawkEngine_Riven *vm, Common::ReadStream *stream);

    RivenScriptPtr getScript(uint16 scriptType) const;

    void enable(bool e);

    bool isEnabled() const;

    bool isZip() const;

    Common::Rect getRect() const;

    bool containsPoint(const Common::Point &point) const;

    void setRect(const Common::Rect &rect);

    uint16 getMouseCursor() const;

    Common::String getName() const;

    int16 getNameId() const;

    uint16 getIndex() const;

    uint16 getBlstId() const;

    int16 getTransitionOffset() const;

    void dump() const;

    void applyScriptPatches(uint32 cardGlobalId);

    void applyPropertiesPatches(uint32 cardGlobalId);

private:
    enum {
        kFlagZip = 1,
        kFlagEnabled = 2
    };

    void loadFromStream(Common::ReadStream *stream);

    MohawkEngine_Riven *_vm;

    uint16 _blstID;
    int16 _nameResource;
    Common::Rect _rect;
    uint16 _u0;
    uint16 _mouseCursor;
    uint16 _index;
    int16 _transitionOffset;
    uint16 _flags;
    RivenScriptList _scripts;
};

} // End of namespace Mohawk

#endif