hotspots.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 MADS_HOTSPOTS_H
#define MADS_HOTSPOTS_H

#include "common/scummsys.h"
#include "mads/events.h"
#include "mads/player.h"

namespace MADS {

class MADSEngine;

class DynamicHotspot {
public:
    bool _active;
    int _seqIndex;
    int _animIndex;
    Common::Rect _bounds;
    Common::Point _feetPos;
    Facing _facing;
    int _descId;
    int _verbId;
    bool _valid;    // V2
    int _articleNumber;
    byte _syntax;   // V2
    CursorType _cursor;

    DynamicHotspot();

    void synchronize(Common::Serializer &s);
};

#define DYNAMIC_HOTSPOTS_SIZE 16

#define SYNTAX_SINGULAR               0
#define SYNTAX_PLURAL                 1
#define SYNTAX_PARTITIVE              2
#define SYNTAX_SINGULAR_MASC          3
#define SYNTAX_SINGULAR_FEM           4
#define SYNTAX_SINGULAR_LIVING        5
#define SYNTAX_MASC_NOT_PROPER        6
#define SYNTAX_FEM_NOT_PROPER         7
#define MAX_SYNTAX                    8

class DynamicHotspots {
private:
    MADSEngine *_vm;
    Common::Array<DynamicHotspot> _entries;
    int _count;
public:
    bool _changed;
public:
    DynamicHotspots(MADSEngine *vm);

    Common::Array<MADS::DynamicHotspot>::size_type size() const { return _entries.size(); }
    DynamicHotspot &operator[](uint idx) { return _entries[idx]; }
    int add(int descId, int verbId, byte syntax, int seqIndex, const Common::Rect &bounds); // V2
    int add(int descId, int verbId, int seqIndex, const Common::Rect &bounds);
    int setPosition(int index, const Common::Point &pos, Facing facing);
    int setCursor(int index, CursorType cursor);
    void remove(int index);
    void clear();
    void reset();
    void refresh();

    DynamicHotspot &get(int index);

    void synchronize(Common::Serializer &s);
};

class Hotspot {
public:
    Common::Rect _bounds;
    Common::Point _feetPos;
    Facing _facing;
    int _articleNumber;
    bool _active;
    byte _syntax;   // V2
    CursorType _cursor;
    int _vocabId;
    int _verbId;

    Hotspot();
    Hotspot(Common::SeekableReadStream &f, bool isV2);
};

class Hotspots : public Common::Array<Hotspot> {
private:
    MADSEngine *_vm;
public:
    Hotspots(MADSEngine *vm) : _vm(vm) {}

    void activate(int vocabId, bool active);

    void activateAtPos(int vocabId, bool active, Common::Point pos);

};

} // End of namespace MADS

#endif  /* MADS_HOTSPOTS_H */