spot.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.
 *
 * Additional copyright for this file:
 * Copyright (C) 1995-1997 Presto Studios, Inc.
 *
 * 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 PEGASUS_NEIGHBORHOOD_SPOT_H
#define PEGASUS_NEIGHBORHOOD_SPOT_H

#include "common/array.h"
#include "common/endian.h"

#include "pegasus/constants.h"

namespace Common {
    class SeekableReadStream;
}

namespace Pegasus {

typedef byte SpotFlags;

enum {
    kSpotLoopsBit, // Loop or once only?
    kSpotOnArrivalBit,
    kSpotOnTurnBit,
    kSpotOnDoorOpenBit
};

static const SpotFlags kNoSpotFlags = 0;
static const SpotFlags kSpotLoopsMask = 1 << kSpotLoopsBit;
static const SpotFlags kSpotOnArrivalMask = 1 << kSpotOnArrivalBit;
static const SpotFlags kSpotOnTurnMask = 1 << kSpotOnTurnBit;
static const SpotFlags kSpotOnDoorOpenMask = 1 << kSpotOnDoorOpenBit;

static const SpotFlags kSpotTriggers = kSpotOnArrivalMask | kSpotOnTurnMask | kSpotOnDoorOpenMask;

class SpotTable {
public:
    SpotTable() {}
    ~SpotTable() {}

    static uint32 getResTag() { return MKTAG('S', 'p', 'o', 't'); }

    void loadFromStream(Common::SeekableReadStream *stream);
    void clear();

    struct Entry {
        Entry() { clear(); }
        bool isEmpty() { return movieStart == 0xffffffff; }
        void clear() {
            room = kNoRoomID;
            direction = kNoDirection;
            srcFlags = kNoSpotFlags;
            altCode = kNoAlternateID;
            movieStart = 0xffffffff;
            movieEnd = 0xffffffff;
            dstFlags = kNoSpotFlags;
        }

        RoomID room;
        DirectionConstant direction;
        SpotFlags srcFlags;
        AlternateID altCode;
        TimeValue movieStart;
        TimeValue movieEnd;
        SpotFlags dstFlags;
    };

    Entry findEntry(RoomID room, DirectionConstant direction, SpotFlags srcFlags, AlternateID altCode);

private:
    Common::Array<Entry> _entries;
};

} // End of namespace Pegasus

#endif