i6eVector.h

Go to the documentation of this file.

/*
 * i6engine
 * Copyright (2016) Daniel Bonrath, Michael Baer, All rights reserved.
 *
 * This file is part of i6engine; i6engine 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 __I6ENGINE_MATH_I6EVECTOR_H__
#define __I6ENGINE_MATH_I6EVECTOR_H__

#include <map>
#include <string>

#include "i6engine/utils/i6eSystemParameters.h"

namespace Ogre {
        class Vector2;
        class Vector3;
} /* namespace Ogre */
class btVector3;

namespace i6e {
namespace math {

        class ISIXE_MATH_API i6eVector {
                static const double EPSILON;

        public:
                static const i6eVector ZERO;

                i6eVector() : _x(0.0), _y(0.0), _z(0.0), _valid(false) {
                }

                i6eVector(const double x, const double y, const double z) : _x(x), _y(y), _z(z), _valid(true) {
                }

                explicit i6eVector(const Ogre::Vector3 & ogre);

                explicit i6eVector(const btVector3 & bullet);

                /*
                 * \brief Constructs a vector from a std::string
                 *
                 * is std::string matches the format "x y z"
                 */
                explicit i6eVector(const std::string & s);

                /*
                 * \brief Constructs a vector from an attributeMap
                 *
                 * \param[in] params the attributeMap containing informations for the vector
                 * \param[in] prefix prefix of the values
                 */
                i6eVector(const std::map<std::string, std::string> & params, const std::string & prefix);

                ~i6eVector() {
                }

                double getX() const {
                        return _x;
                }
                double getY() const {
                        return _y;
                }
                double getZ() const {
                        return _z;
                }

                void setX(const double x) {
                        _x = x;
                }
                void setY(const double y) {
                        _y = y;
                }
                void setZ(const double z) {
                        _z = z;
                }

                i6eVector operator+(const i6eVector & b) const {
                        return i6eVector(getX() + b.getX(), getY() + b.getY(), getZ() + b.getZ());
                }

                i6eVector operator-(const i6eVector & b) const {
                        return i6eVector(getX() - b.getX(), getY() - b.getY(), getZ() - b.getZ());
                }

                i6eVector operator*(const i6eVector & b) const {
                        return i6eVector(_y * b._z - _z * b._y, _z * b._x - _x * b._z, _x * b._y - _y * b._x);
                }

                i6eVector operator*(const double b) const {
                        return i6eVector(_x * b, _y * b, _z * b);
                }

                static double scalProd(const i6eVector & a, const i6eVector & b) {
                        return a._x * b._x + a._y * b._y + a._z * b._z;
                }

                i6eVector operator/(const double b) const {
                        return i6eVector(getX() / b, getY() / b, getZ() / b);
                }

                i6eVector operator+=(const i6eVector & b) {
                        setX(getX() + b.getX());
                        setY(getY() + b.getY());
                        setZ(getZ() + b.getZ());
                        return *this;
                }

                i6eVector operator-=(const i6eVector & b) {
                        setX(_x - b.getX());
                        setY(_y - b.getY());
                        setZ(_z - b.getZ());
                        return *this;
                }

                bool operator==(const i6eVector & b) const;

                bool operator!=(const i6eVector & b) const {
                        return !(*this == b);
                }

                i6eVector normalize() const;

                static i6eVector crossProd(const i6eVector & a, const i6eVector & b) {
                         return i6eVector(a._y * b._z - a._z * b._y, a._z * b._x - a._x * b._z, a._x * b._y - a._y * b._x);
                }

                static double crossAngle(const i6eVector & a, const i6eVector & b);

                static double crossAngleSigned(const i6eVector & a, const i6eVector & b, const i6eVector & n);

                void insertInMap(const std::string & prefix, std::map<std::string, std::string> & map) const;

                void mulComponents(const i6eVector & b) {
                        _x = _x * b.getX();
                        _y = _y * b.getY();
                        _z = _z * b.getZ();
                }

                bool isValid() const;
                void setValid(bool b);

                double length() const;

                Ogre::Vector3 toOgre() const;

                Ogre::Vector2 toOgre2() const;

                btVector3 toBullet() const;

                std::string toString() const;

                template<class Archive>
                void serialize(Archive & ar, const unsigned int) {
                        ar & _x;
                        ar & _y;
                        ar & _z;
                }

        private:
                double _x, _y, _z;
                bool _valid;
        };

        ISIXE_MATH_API std::ostream & operator<<(std::ostream & stream, const i6eVector & v);

} /* namespace math */
} /* namespace i6e */

typedef i6e::math::i6eVector Vec3;

#endif /* __I6ENGINE_MATH_I6EVECTOR_H__ */