magnum/src/Math/Vector2.h

#ifndef Magnum_Math_Vector2_h
#define Magnum_Math_Vector2_h
/*
    Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz>

    This file is part of Magnum.

    Magnum is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License version 2
    only, as published by the Free Software Foundation.

    Magnum 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 version 2 for more details.
*/

/** @file
 * @brief Class Magnum::Math::Vector2
 */

#include "Vector.h"

namespace Magnum { namespace Math {

/** @brief Two-component vector */
template<class T> class Vector2: public Vector<T, 2> {
    public:
        /** @copydoc Vector::from(T*) */
        inline constexpr static Vector2<T>& from(T* data) {
            return *reinterpret_cast<Vector2<T>*>(data);
        }

        /** @copydoc Vector::from(const T*) */
        inline constexpr static const Vector2<T>& from(const T* data) {
            return *reinterpret_cast<const Vector2<T>*>(data);
        }

        /** @copydoc Vector::Vector(T) */
        inline constexpr explicit Vector2(T value = T()): Vector<T, 2>(value, value) {}

        /** @copydoc Vector::Vector(const Vector&)  */
        inline constexpr Vector2(const Vector<T, 2>& other): Vector<T, 2>(other) {}

        /**
         * @brief Constructor
         * @param x     X value
         * @param y     Y value
         */
        inline constexpr Vector2(T x, T y): Vector<T, 2>(x, y) {}

        inline constexpr T x() const { return Vector<T, 2>::at(0); } /**< @brief X component */
        inline constexpr T y() const { return Vector<T, 2>::at(1); } /**< @brief Y component */

        inline void setX(T value) { this->set(0, value); } /**< @brief Set X component */
        inline void setY(T value) { this->set(1, value); } /**< @brief Set Y component */

        /** @copydoc Vector::operator=() */
        inline Vector2<T>& operator=(const Vector<T, 2>& other) { return Vector<T, 2>::operator=(other); }

        /** @copydoc Vector::operator*(const Vector<T, size>&) const */
        inline T operator*(const Vector<T, 2>& other) const { return Vector<T, 2>::operator*(other); }

        /** @copydoc Vector::operator*(T) const */
        inline Vector2<T> operator*(T number) const { return Vector<T, 2>::operator*(number); }

        /** @copydoc Vector::operator*=() */
        inline Vector2<T>& operator*=(T number) {
            Vector<T, 2>::operator*=(number);
            return *this;
        }

        /** @copydoc Vector::operator/() */
        inline Vector2<T> operator/(T number) const { return Vector<T, 2>::operator/(number); }

        /** @copydoc Vector::operator/=() */
        inline Vector2<T>& operator/=(T number) {
            Vector<T, 2>::operator/=(number);
            return *this;
        }

        /** @copydoc Vector::operator+() */
        inline Vector2<T> operator+(const Vector<T, 2>& other) const { return Vector<T, 2>::operator+(other); }

        /** @copydoc Vector::operator+=() */
        inline Vector2<T>& operator+=(const Vector<T, 2>& other) {
            Vector<T, 2>::operator+=(other);
            return *this;
        }

        /** @copydoc Vector::operator-(const Vector<T, size>&) const */
        inline Vector2<T> operator-(const Vector<T, 2>& other) const { return Vector<T, 2>::operator-(other); }

        /** @copydoc Vector::operator-=() */
        inline Vector2<T>& operator-=(const Vector<T, 2>& other) {
            Vector<T, 2>::operator-=(other);
            return *this;
        }

        /** @copydoc Vector::operator-() */
        inline Vector2<T> operator-() const { return Vector<T, 2>::operator-(); }

        /** @copydoc Vector::normalized() */
        inline Vector2<T> normalized() const { return Vector<T, 2>::normalized(); }
};

#ifndef DOXYGEN_GENERATING_OUTPUT
template<class T> Corrade::Utility::Debug operator<<(Corrade::Utility::Debug debug, const Magnum::Math::Vector2<T>& value) {
    return debug << static_cast<const Magnum::Math::Vector<T, 2>&>(value);
}
#endif

}}

#endif