The SuperTux library features a SuperTux namespace now.
[supertux.git] / lib / math / vector.h
1 //  $Id$
2 //
3 //  SuperTux -  A Jump'n Run
4 //  Copyright (C) 2004 Matthias Braun <matze@braunis.de
5 //
6 //  This program is free software; you can redistribute it and/or
7 //  modify it under the terms of the GNU General Public License
8 //  as published by the Free Software Foundation; either version 2
9 //  of the License, or (at your option) any later version.
10 //
11 //  This program is distributed in the hope that it will be useful,
12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 //  GNU General Public License for more details.
15 //
16 //  You should have received a copy of the GNU General Public License
17 //  along with this program; if not, write to the Free Software
18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19
20 #ifndef SUPERTUX_VECTOR_H
21 #define SUPERTUX_VECTOR_H
22
23 namespace SuperTux
24   {
25
26   /// 2D Vector.
27   /** Simple two dimensional vector. */
28   class Vector
29     {
30     public:
31       Vector(float nx, float ny)
32           : x(nx), y(ny)
33       { }
34       Vector(const Vector& other)
35           : x(other.x), y(other.y)
36       { }
37       Vector()
38           : x(0), y(0)
39       { }
40
41       bool operator ==(const Vector& other) const
42         {
43           return x == other.x && y == other.y;
44         }
45
46       const Vector& operator=(const Vector& other)
47       {
48         x = other.x;
49         y = other.y;
50         return *this;
51       }
52
53       Vector operator+(const Vector& other) const
54         {
55           return Vector(x + other.x, y + other.y);
56         }
57
58       Vector operator-(const Vector& other) const
59         {
60           return Vector(x - other.x, y - other.y);
61         }
62
63       Vector operator*(float s) const
64         {
65           return Vector(x * s, y * s);
66         }
67
68       Vector operator/(float s) const
69         {
70           return Vector(x / s, y / s);
71         }
72
73       Vector operator-() const
74         {
75           return Vector(-x, -y);
76         }
77
78       const Vector& operator +=(const Vector& other)
79       {
80         x += other.x;
81         y += other.y;
82         return *this;
83       }
84
85       /// Scalar product of 2 vectors
86       float operator*(const Vector& other) const
87         {
88           return x*other.x + y*other.y;
89         }
90
91       float norm() const;
92       Vector unit() const;
93
94       // ... add the other operators as needed, I'm too lazy now ...
95
96       float x, y; // leave this public, get/set methods just give me headaches
97       // for such simple stuff :)
98     };
99
100 } //namespace SuperTux
101
102 #endif /*SUPERTUX_VECTOR_H*/
103