/*
 * Copyright (C) 2006-2019 Christopho, Solarus - http://www.solarus-games.org
 *
 * Solarus 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.
 *
 * Solarus 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 SOLARUS_POINT_H
#define SOLARUS_POINT_H

#include "solarus/core/Common.h"
#include "solarus/core/Size.h"
#include <iosfwd>

#include <glm/vec2.hpp>

namespace Solarus {

/**
 * \brief Represents a 2D point.
 *
 * This class represents a point with its two integer coordinates, x and y.
 */
class Point {

  public:

    ////////////////////////////////////////////////////////////
    // Constructors

    constexpr Point();
    constexpr Point(int x, int y);
    constexpr explicit Point(const Size& size);

    ////////////////////////////////////////////////////////////
    // Operators

    Point& operator+=(const Point& other);
    Point& operator-=(const Point& other);

    operator glm::vec2() const;

    Point& operator*=(int factor);
    Point& operator/=(int divisor);

    ////////////////////////////////////////////////////////////
    // Member data

    int x = 0;    /**< First coordinate */
    int y = 0;    /**< Second coordinate */

};

////////////////////////////////////////////////////////////
// Free functions

// Comparison operators
constexpr bool operator==(const Point& lhs, const Point& rhs);
constexpr bool operator!=(const Point& lhs, const Point& rhs);

// Unary arithmetic operators
constexpr Point operator+(const Point& point);
constexpr Point operator-(const Point& point);

// Binary arithmetic operators
constexpr Point operator+(const Point& lhs, const Point& rhs);
constexpr Point operator-(const Point& lhs, const Point& rhs);

constexpr Point operator*(const Point& point, int factor);
constexpr Point operator*(int factor, const Point& point);
constexpr Point operator/(const Point& point, int divisor);

// Output to stream
std::ostream& operator<<(std::ostream& stream, const Point& point);

}

#include "solarus/core/Point.inl"

#endif

