vector2.h

Go to the documentation of this file.

/*
    Sheep - A Rigid Body Dynamics Engine
    Copyright (C) 2001-2004 Francois Beaune
    Contact: http://toxicengine.sourceforge.net/

    This file is part of Sheep.

    Sheep 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 2 of the License, or
    (at your option) any later version.

    Sheep 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 Sheep; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef SHEEP_MATH_VECTOR2_H
#define SHEEP_MATH_VECTOR2_H

#include "common/misc/htmlstream.h"
#include "real.h"

#include <cassert>
#include <cmath>    // std::sqrt()

namespace sheep {

    class Vector2 {
    public:
        Real m_x, m_y;

        //! Constructors.
        Vector2();
        Vector2(Real r);
        Vector2(const Vector2 &v);
        Vector2(Real x, Real y);

        //! Assignment operators.
        Vector2 &operator=(Real rhs);
        Vector2 &operator=(const Vector2 &rhs);

        //! Array subscripting.
        Real &operator[](int i);

        //! Square of the vector length.
        Real SquareNorm() const;

        //! Vector length.
        Real Norm() const;

        //! Normalized vector.
        Vector2 Normalized() const;

        //! Normalize the vector.
        void Normalize();

        //! Returns true if the vector is (approximately) unit-length.
        bool IsUnitLength(Real e = EPS) const;
    };

    //! Basic operations.
    Vector2 operator+(const Vector2 &lhs, const Vector2 &rhs);
    Vector2 operator-(const Vector2 &lhs, const Vector2 &rhs);
    Vector2 operator-(const Vector2 &v);
    Vector2 operator*(const Vector2 &lhs, Real rhs);
    Vector2 operator*(Real lhs, const Vector2 &rhs);
    Vector2 operator/(const Vector2 &lhs, Real rhs);
    Vector2 &operator+=(Vector2 &lhs, const Vector2 &rhs);
    Vector2 &operator-=(Vector2 &lhs, const Vector2 &rhs);
    Vector2 &operator*=(Vector2 &lhs, Real rhs);
    Vector2 &operator/=(Vector2 &lhs, Real rhs);

    //! Dot product.
    Real operator*(const Vector2 &lhs, const Vector2 &rhs);

    //! Deprecated.
    htmlstream& operator<<(htmlstream &s, const Vector2 &v);

#include "vector2.inl"

}

#endif  // !SHEEP_MATH_VECTOR2_H

---