location.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_LOCATION_H
#define FIFE_LOCATION_H

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

// 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/base/exception.h"

namespace FIFE {
    class Map;
    class Layer;

    class Location {
    public:
        Location();
        
        Location(const Location& loc);
        
        Location(Layer* layer);
        
        ~Location();
        
        void reset();
        
        Location& operator=(const Location& rhs);
        
        inline bool operator==(const Location& loc) const {
            return ((m_layer == loc.m_layer) && (m_exact_layer_coords == loc.m_exact_layer_coords));
        }
        
        inline bool operator!=(const Location& loc) const {
            return !(*this == loc);
        }
        
        Map* getMap() const;
        
        void setLayer(Layer* layer);
        
        Layer* getLayer() const;
        
        void setExactLayerCoordinates(const ExactModelCoordinate& coordinates);
        
        void setLayerCoordinates(const ModelCoordinate& coordinates);

        void setMapCoordinates(const ExactModelCoordinate& coordinates);

        ExactModelCoordinate& getExactLayerCoordinatesRef();
        
        ExactModelCoordinate getExactLayerCoordinates() const;

        ExactModelCoordinate getExactLayerCoordinates(const Layer* layer) const;
        
        ModelCoordinate getLayerCoordinates() const;
        
        ModelCoordinate getLayerCoordinates(const Layer* layer) const;
        
        ExactModelCoordinate getMapCoordinates() const;
    
        double getCellOffsetDistance() const;
        
        bool isValid() const;
        
        double getMapDistanceTo(const Location& location) const;

        double getLayerDistanceTo(const Location& location) const;
        
    private:
        bool isValid(const Layer* layer) const;
        
        Layer* m_layer;
        ExactModelCoordinate m_exact_layer_coords;
    };
    
    std::ostream& operator<<(std::ostream&, const Location&);
}
#endif //FIFE_LOCATION_H