entities.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 LASTEXPRESS_ENTITIES_H
#define LASTEXPRESS_ENTITIES_H

/*
    Entities
    --------

    The entities structure contains 40 Entity_t structures for each entity

*/

#include "lastexpress/entities/entity.h"

#include "lastexpress/shared.h"

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

namespace LastExpress {

class LastExpressEngine;
class Sequence;

class Entities : Common::Serializable {
public:
    Entities(LastExpressEngine *engine);
    ~Entities() override;

    // Serializable
    void saveLoadWithSerializer(Common::Serializer &ser) override;
    void savePositions(Common::Serializer &ser);
    void saveCompartments(Common::Serializer &ser);

    void setup(bool isFirstChapter, EntityIndex entity);
    void setupChapter(ChapterIndex chapter);
    void reset();

    // Update & drawing

    void resetState(EntityIndex entity);
    void updateFields() const;
    void updateSequences() const;
    void updateCallbacks();

    EntityIndex canInteractWith(const Common::Point &point) const;
    bool compare(EntityIndex entity1, EntityIndex entity2) const;

    void updateFrame(EntityIndex entity) const;
    void updatePositionEnter(EntityIndex entity, CarIndex car, Position position);
    void updatePositionExit(EntityIndex entity, CarIndex car, Position position);
    void enterCompartment(EntityIndex entity, ObjectIndex compartment, bool useCompartment1 = false);
    void exitCompartment(EntityIndex entity, ObjectIndex compartment, bool useCompartment1 = false);

    // Sequences
    void drawSequenceLeft(EntityIndex index, const char *sequence) const;
    void drawSequenceRight(EntityIndex index, const char *sequence) const;
    void clearSequences(EntityIndex index) const;

    bool updateEntity(EntityIndex entity, CarIndex car, EntityPosition position) const;
    bool hasValidFrame(EntityIndex entity) const;

    // Accessors
    Entity *get(EntityIndex entity);
    EntityData::EntityCallData *getData(EntityIndex entity) const;
    int getPosition(CarIndex car, Position position) const;
    int getCompartments(int index) const;
    int getCompartments1(int index) const;

    // Scene
    void loadSceneFromEntityPosition(CarIndex car, EntityPosition position, bool alternate = false) const;

    // Checks

    bool isInsideCompartment(EntityIndex entity, CarIndex car, EntityPosition position) const;

    bool checkFields2(ObjectIndex object) const;

    bool isInsideCompartments(EntityIndex entity) const;

    bool isPlayerPosition(CarIndex car, Position position) const;

    bool isInsideTrainCar(EntityIndex entity, CarIndex car) const;

    bool isInGreenCarEntrance(EntityIndex entity) const;

    bool isPlayerInCar(CarIndex car) const;

    bool isDirectionUpOrDown(EntityIndex entity) const;

    bool isDistanceBetweenEntities(EntityIndex entity1, EntityIndex entity2, uint distance) const;

    bool checkFields10(EntityIndex entity) const;

    bool isSomebodyInsideRestaurantOrSalon() const;

    bool isInSalon(EntityIndex entity) const;

    bool isInRestaurant(EntityIndex entity) const;

    bool isInKronosSalon(EntityIndex entity) const;

    bool isOutsideAlexeiWindow() const;

    bool isOutsideAnnaWindow() const;

    bool isInKitchen(EntityIndex entity) const;

    bool isNobodyInCompartment(CarIndex car, EntityPosition position) const;

    bool checkFields19(EntityIndex entity, CarIndex car, EntityPosition position) const;

    bool isInBaggageCarEntrance(EntityIndex entity) const;

    bool isInBaggageCar(EntityIndex entity) const;

    bool isInKronosSanctum(EntityIndex entity) const;

    bool isInKronosCarEntrance(EntityIndex entity) const;

    bool checkDistanceFromPosition(EntityIndex entity, EntityPosition position, int distance) const;

    bool isWalkingOppositeToPlayer(EntityIndex entity) const;

    static bool isFemale(EntityIndex entity);

    static bool isMarried(EntityIndex entity);

private:
    static const int _compartmentsCount = 16;
    static const int _positionsCount = 100 * 10;  // 100 positions per train car

    LastExpressEngine       *_engine;
    EntityData              *_header;
    Common::Array<Entity *>  _entities;

    // Compartments & positions
    uint _compartments[_compartmentsCount];
    uint _compartments1[_compartmentsCount];
    uint _positions[_positionsCount];

    void executeCallbacks();
    void incrementDirectionCounter(EntityData::EntityCallData *data) const;
    void processEntity(EntityIndex entity);

    void drawSequence(EntityIndex entity, const char *sequence, EntityDirection direction) const;
    void drawSequences(EntityIndex entity, EntityDirection direction, bool loadSequence) const;
    void loadSequence2(EntityIndex entity, Common::String sequenceName, Common::String sequenceName2, byte field30, bool loadSequence) const;

    void clearEntitySequenceData(EntityData::EntityCallData *data, EntityDirection direction) const;
    void computeCurrentFrame(EntityIndex entity) const;
    int16 getCurrentFrame(EntityIndex entity, Sequence *sequence, EntityPosition position, bool doProcessing) const;
    void processFrame(EntityIndex entity, bool keepPreviousFrame, bool dontPlaySound);
    void drawNextSequence(EntityIndex entity) const;
    void updateEntityPosition(EntityIndex entity) const;
    void copySequenceData(EntityIndex entity) const;

    bool changeCar(EntityData::EntityCallData *data, EntityIndex entity, CarIndex car, EntityPosition position, bool increment, EntityPosition newPosition, CarIndex newCar) const;

    void getSequenceName(EntityIndex entity, EntityDirection direction, Common::String &sequence1, Common::String &sequence2) const;

    void updatePositionsEnter(EntityIndex entity, CarIndex car, Position position1, Position position2, Position position3, Position position4);
    void updatePositionsExit(EntityIndex entity, CarIndex car, Position position1, Position position2);

    void resetSequences(EntityIndex entity) const;

    bool checkPosition(EntityPosition position) const;
    bool checkSequenceFromPosition(EntityIndex entity) const;
    EntityPosition getEntityPositionFromCurrentPosition() const;
};

} // End of namespace LastExpress

#endif // LASTEXPRESS_ENTITIES_H