cellgrid.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2019 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_MODEL_GRIDS_CELLGRID_H
#define FIFE_MODEL_GRIDS_CELLGRID_H

// Standard C++ library includes
#include <vector>

// 3rd party library includes

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "model/metamodel/modelcoords.h"
#include "util/math/matrix.h"
#include "util/base/fifeclass.h"
#include "util/base/fife_stdint.h"

namespace FIFE {
    class CellGrid: public FifeClass {
    public:
        CellGrid();

        virtual ~CellGrid();

        void getAccessibleCoordinates(const ModelCoordinate& curpos, std::vector<ModelCoordinate>& coordinates);

        virtual const std::string& getType() const = 0;

        virtual const std::string& getName() const = 0;

        virtual bool isAccessible(const ModelCoordinate& curpos, const ModelCoordinate& target) = 0;

        virtual double getAdjacentCost(const ModelCoordinate& curpos, const ModelCoordinate& target) = 0;

        virtual double getHeuristicCost(const ModelCoordinate& curpos, const ModelCoordinate& target) = 0;

        virtual uint32_t getCellSideCount() const = 0;

        ExactModelCoordinate toMapCoordinates(const ModelCoordinate& layer_coords);

        virtual ExactModelCoordinate toMapCoordinates(const ExactModelCoordinate& layer_coords) = 0;

        virtual ModelCoordinate toLayerCoordinates(const ExactModelCoordinate& map_coord) = 0;

        virtual ExactModelCoordinate toExactLayerCoordinates(const ExactModelCoordinate& map_coord) = 0;

        virtual ModelCoordinate toLayerCoordinatesFromExactLayerCoordinates(const ExactModelCoordinate& exact_layer_coords) = 0;

        virtual void getVertices(std::vector<ExactModelCoordinate>& vtx, const ModelCoordinate& cell) = 0;

        virtual std::vector<ModelCoordinate> toMultiCoordinates(const ModelCoordinate& position,
            const std::vector<ModelCoordinate>& orig, bool reverse = false) = 0;

        virtual std::vector<ModelCoordinate> getCoordinatesInLine(const ModelCoordinate& start, const ModelCoordinate& end) = 0;

        void setXShift(const double& xshift) {
            m_xshift = xshift;
            updateMatrices();
        }

        const double getXShift() const { return m_xshift; }

        void setYShift(const double yshift) {
            m_yshift = yshift;
            updateMatrices();
        }

        const double getYShift() const { return m_yshift; }

        void setZShift(const double zshift) {
            m_zshift = zshift;
            updateMatrices();
        }

        const double getZShift() const { return m_zshift; }

        void setXScale(const double scale) {
            m_xscale = scale;
            updateMatrices();
        }

        void setYScale(const double scale) {
            m_yscale = scale;
            updateMatrices();
        }

        void setZScale(const double scale) {
            m_zscale = scale;
            updateMatrices();
        }

        const double getXScale() const { return m_xscale; }

        const double getYScale() const { return m_yscale; }

        const double getZScale() const { return m_zscale; }

        void setRotation(const double rotation) {
            m_rotation = rotation;
            updateMatrices();
        }

        const double getRotation() const { return m_rotation; }

        void setAllowDiagonals(const bool allow_diagonals) {
            m_allow_diagonals = allow_diagonals;
        }

        const bool getAllowDiagonals() const { return m_allow_diagonals; }

        virtual CellGrid* clone() = 0;

    protected:
        void updateMatrices();
        bool ptInTriangle(const ExactModelCoordinate& pt, const ExactModelCoordinate& pt1, const ExactModelCoordinate& pt2, const ExactModelCoordinate& pt3);

        DoubleMatrix m_matrix;
        DoubleMatrix m_inverse_matrix;
        double m_xshift;
        double m_yshift;
        double m_zshift;
        double m_xscale;
        double m_yscale;
        double m_zscale;
        double m_rotation;
        bool m_allow_diagonals;

    private:
        int32_t orientation(const ExactModelCoordinate& pt, const ExactModelCoordinate& pt1, const ExactModelCoordinate& pt2);
    };
}

#endif