Vector2.h

00001 /*
00002  * This source file is part of libRocket, the HTML/CSS Interface Middleware
00003  *
00004  * For the latest information, see http://www.librocket.com
00005  *
00006  * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
00007  *
00008  * Permission is hereby granted, free of charge, to any person obtaining a copy
00009  * of this software and associated documentation files (the "Software"), to deal
00010  * in the Software without restriction, including without limitation the rights
00011  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012  * copies of the Software, and to permit persons to whom the Software is
00013  * furnished to do so, subject to the following conditions:
00014  *
00015  * The above copyright notice and this permission notice shall be included in
00016  * all copies or substantial portions of the Software.
00017  * 
00018  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00021  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00022  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00023  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00024  * THE SOFTWARE.
00025  *
00026  */
00027 
00028 #ifndef ROCKETCOREVECTOR2_H
00029 #define ROCKETCOREVECTOR2_H
00030 
00031 #include <Rocket/Core/Debug.h>
00032 #include <Rocket/Core/Math.h>
00033 
00034 namespace Rocket {
00035 namespace Core {
00036 
00042 template < typename Type >
00043 class Vector2
00044 {
00045         public:
00047                 inline Vector2();
00051                 inline Vector2(Type x, Type y);
00052 
00055                 inline float Magnitude() const;
00058                 inline Type SquaredMagnitude() const;
00061                 inline Vector2 Normalise() const;
00062 
00066                 inline Type DotProduct(const Vector2& rhs) const;
00067 
00071                 inline Vector2 Rotate(float theta) const;
00072 
00075                 inline Vector2 operator-() const;
00076 
00080                 inline Vector2 operator+(const Vector2& rhs) const;
00084                 inline Vector2 operator-(const Vector2& rhs) const;
00088                 inline Vector2 operator*(Type rhs) const;
00092                 inline Vector2 operator/(Type rhs) const;
00093 
00097                 inline Vector2& operator+=(const Vector2& rhs);
00101                 inline Vector2& operator-=(const Vector2& rhs);
00105                 inline Vector2& operator*=(const Type& rhs);
00109                 inline Vector2& operator/=(const Type& rhs);
00110 
00114                 inline bool operator==(const Vector2& rhs) const;
00118                 inline bool operator!=(const Vector2& rhs) const;
00119 
00122                 inline operator const Type*() const;
00125                 inline operator Type*();
00126 
00127                 // The components of the vector.
00128                 Type x;
00129                 Type y;
00130 };
00131 
00132 #include <Rocket/Core/Vector2.inl>
00133 
00134 }
00135 }
00136 
00137 #endif