region.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/>.
 *
 */

/*
 * This code is based on Broken Sword 2.5 engine
 *
 * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
 *
 * Licensed under GNU GPL v2
 *
 */

#ifndef SWORD25_REGION_H
#define SWORD25_REGION_H

#include "sword25/kernel/common.h"
#include "sword25/kernel/persistable.h"
#include "sword25/math/vertex.h"
#include "sword25/math/polygon.h"
#include "common/rect.h"

namespace Sword25 {

class Region : public Persistable {
protected:
    Region();

    Region(InputPersistenceBlock &reader, uint handle);

public:
    enum REGION_TYPE {
        RT_REGION,
        RT_WALKREGION
    };

    static uint create(REGION_TYPE type);
    static uint create(InputPersistenceBlock &reader, uint handle = 0);

    ~Region() override;

    virtual bool init(const Polygon &contour, const Common::Array<Polygon> *pHoles = NULL);

    //
    // Exploratory Methods
    //

    bool isValid() const {
        return _valid;
    }

    const Vertex &getPosition() const {
        return _position;
    }

    int getPosX() const {
        return _position.x;
    }

    int getPosY() const {
        return _position.y;
    }

    bool isPointInRegion(const Vertex &vertex) const;

    bool isPointInRegion(int x, int y) const;

    const Polygon &getContour() const {
        return _polygons[0];
    }

    int getHoleCount() const {
        return static_cast<int>(_polygons.size() - 1);
    }

    inline const Polygon &getHole(uint i) const;

    Vertex findClosestRegionPoint(const Vertex &point) const;

    Vertex getCentroid() const;

    bool isLineOfSight(const Vertex &a, const Vertex &b) const;

    //
    // Manipulation Methods
    //

    virtual void setPos(int x, int y);

    void setPosX(int x);

    void setPosY(int y);

    //
    // Manipulation Methods
    //

    bool persist(OutputPersistenceBlock &writer) override;
    bool unpersist(InputPersistenceBlock &reader) override;

protected:
    REGION_TYPE _type;
    bool _valid;
    Vertex _position;
    // the array is the contour, all others are the holes
    Common::Array<Polygon> _polygons;
    Common::Rect _boundingBox;

    void updateBoundingBox();

    Vertex findClosestPointOnLine(const Vertex &lineStart, const Vertex &lineEnd, const Vertex point) const;
};

inline const Polygon &Region::getHole(uint i) const {
    assert(i < _polygons.size() - 1);
    return _polygons[i + 1];
}

} // End of namespace Sword25

#endif