point.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_VIDEO_POINT_H
#define FIFE_VIDEO_POINT_H

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

// Platform specific includes

// 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 "util/base/fife_stdint.h"
#include "util/math/fife_math.h"

namespace FIFE {

    template <typename T> class PointType2D {
    public:
        union {
            T val[2];
            struct {
                T x,y;
            };
        };

        explicit PointType2D(T _x = 0, T _y = 0): x(_x), y(_y) {
        }

        PointType2D(const PointType2D<T>& rhs): x(rhs.x), y(rhs.y) {
        }

        PointType2D<T> operator+(const PointType2D<T>& p) const {
            return PointType2D<T>(x + p.x, y + p.y);
        }

        PointType2D<T> operator-(const PointType2D<T>& p) const {
            return PointType2D<T>(x - p.x, y - p.y);
        }

        PointType2D<T>& operator+=(const PointType2D<T>& p) {
            x += p.x;
            y += p.y;
            return *this;
        }

        PointType2D<T>& operator-=(const PointType2D<T>& p) {
            x -= p.x;
            y -= p.y;
            return *this;
        }

        PointType2D<T> operator*(const T& i) const {
            return PointType2D<T>(x * i, y * i);
        }

        PointType2D<T> operator/(const T& i) const {
            return PointType2D<T>(x / i, y / i);
        }

        bool operator==(const PointType2D<T>& p) const {
            return x == p.x && y == p.y;
        }

        bool operator!=(const PointType2D<T>& p) const {
            return !(x == p.x && y == p.y);
        }

        T length() const {
            double sq;
            sq = x*x + y*y;
            return static_cast<T>(Mathd::Sqrt(sq));
        }

        void normalize() {
            T invLength = static_cast<T>(1.0/length());

            //TODO: get rid of this static cast
            if (invLength > static_cast<T>(Mathd::zeroTolerance())) {
                x = x * invLength;
                y = y * invLength;
            }
            else {
                x = 0;
                y = 0;
            }
        }

        void rotate(T angle){
            //TODO: get rid of this static cast
            T theta = (angle * static_cast<T>(Mathd::pi()))/180;
            T costheta = static_cast<T>(Mathd::Cos(theta));
            T sintheta = static_cast<T>(Mathd::Sin(theta));

            T nx = x;
            T ny = y;

            x = costheta * nx - sintheta * ny;
            y = sintheta * nx + costheta * ny;
        }

        void rotate(const PointType2D<T>& origin, T angle){
            //TODO: get rid of this static cast
            T theta = (angle * static_cast<T>(Mathd::pi()))/180;
            T costheta = static_cast<T>(Mathd::Cos(theta));
            T sintheta = static_cast<T>(Mathd::Sin(theta));

            T nx = x - origin.x;
            T ny = y - origin.y;

            x = costheta * nx - sintheta * ny;
            y = sintheta * nx + costheta * ny;
        }

        void set(T _x, T _y) {
            x = _x;
            y = _y;
        }

        inline T& operator[] (int32_t ind) {
            assert(ind > -1 && ind < 2);
            return val[ind];
        }
    };

    template<typename T>
    std::ostream& operator<<(std::ostream& os, const PointType2D<T>& p) {
        return os << "(" << p.x << ":" << p.y << ")";
    }

    typedef PointType2D<int32_t> Point;
    typedef PointType2D<double> DoublePoint;
    typedef std::vector<Point> PointVector;
    typedef std::vector<DoublePoint> DoublePointVector;

    template <typename T> class PointType3D {
    public:
        union {
            T val[3];
            struct {
                T x,y,z;
            };
        };

        explicit PointType3D(T _x = 0, T _y = 0, T _z = 0): x(_x), y(_y), z(_z) {
        }

        PointType3D(const PointType3D<T>& rhs): x(rhs.x), y(rhs.y), z(rhs.z) {
        }

        PointType3D<T> operator+(const PointType3D<T>& p) const {
            return PointType3D<T>(x + p.x, y + p.y, z + p.z);
        }

        PointType3D<T> operator-(const PointType3D<T>& p) const {
            return PointType3D<T>(x - p.x, y - p.y, z - p.z);
        }

        PointType3D<T>& operator+=(const PointType3D<T>& p) {
            x += p.x;
            y += p.y;
            z += p.z;
            return *this;
        }

        PointType3D<T>& operator-=(const PointType3D<T>& p) {
            x -= p.x;
            y -= p.y;
            z -= p.z;
            return *this;
        }

        PointType3D<T> operator*(const T& i) const {
            return PointType3D<T>(x * i, y * i, z * i);
        }

        PointType3D<T> operator/(const T& i) const {
            return PointType3D<T>(x / i, y / i, z / i);
        }

        bool operator==(const PointType3D<T>& p) const {
            /*return x == p.x && y == p.y && z == p.z;*/
            return Mathd::Equal(x, p.x) && Mathd::Equal(y, p.y) && Mathd::Equal(z, p.z);
        }

        bool operator!=(const PointType3D<T>& p) const {
            return !(Mathd::Equal(x, p.x) && Mathd::Equal(y, p.y) && Mathd::Equal(z, p.z));
        }

        T length() const {
            double sq;
            sq = x*x + y*y + z*z;
            return static_cast<T>(Mathd::Sqrt(sq));
        }

        void normalize() {
            T invLength = static_cast<T>(1.0/length());

            //TODO: get rid of this static cast
            if (invLength > static_cast<T>(Mathd::zeroTolerance())) {
                x = x * invLength;
                y = y * invLength;
                z = z * invLength;
            }
            else {
                x = 0;
                y = 0;
                z = 0;
            }
        }

        void set(T _x, T _y, T _z) {
            x = _x;
            y = _y;
            z = _z;
        }

        inline T& operator[] (int32_t ind) {
            assert(ind > -1 && ind < 3);
            return val[ind];
        }
    };

    template<typename T>
    std::ostream& operator<<(std::ostream& os, const PointType3D<T>& p) {
        return os << "(" << p.x << ":" << p.y << ":" << p.z << ")";
    }

    typedef PointType3D<int32_t> Point3D;
    typedef PointType3D<double> DoublePoint3D;
    typedef std::vector<Point3D> Point3DVector;
    typedef std::vector<DoublePoint3D> DoublePoint3DVector;

    inline Point doublePt2intPt(DoublePoint pt) {
        Point tmp(static_cast<int32_t>(round(pt.x)), static_cast<int32_t>(round(pt.y)));
        return tmp;
    }

    inline Point3D doublePt2intPt(DoublePoint3D pt) {
        Point3D tmp(static_cast<int32_t>(round(pt.x)), static_cast<int32_t>(round(pt.y)), static_cast<int32_t>(round(pt.z)));
        return tmp;
    }

    inline DoublePoint intPt2doublePt(Point pt) {
        DoublePoint tmp(static_cast<double>(pt.x), static_cast<double>(pt.y));
        return tmp;
    }

    inline DoublePoint3D intPt2doublePt(Point3D pt) {
        DoublePoint3D tmp(static_cast<double>(pt.x), static_cast<double>(pt.y), static_cast<double>(pt.z));
        return tmp;
    }

}

#endif