added GPL copyrights
[physics.git] / src / Vector2.h
1 /*
2  *  Copyright (C) 2008 Patrik Gornicz, Gornicz_P (at) hotmail (dot) com.
3  *
4  *  This program is free software: you can redistribute it and/or modify
5  *  it under the terms of the GNU General Public License as published by
6  *  the Free Software Foundation, either version 3 of the License, or
7  *  (at your option) any later version.
8  *
9  *  This program is distributed in the hope that it will be useful,
10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  *  GNU General Public License for more details.
13  *
14  *  You should have received a copy of the GNU General Public License
15  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 #ifndef VECTOR2_H
19 #define VECTOR2_H
20
21 #include <string>
22
23 using std::string;
24
25 /// ***** Header Class *****
26 class Vector2
27 {
28   public:
29     float x;
30     float y;
31
32     Vector2();
33     Vector2(float, float);
34     Vector2(const Vector2&);
35     ~Vector2();
36
37     void zero();
38     void unit();
39
40     float angle() const;
41     float length() const;
42
43     Vector2 add(const Vector2&) const;
44     Vector2 subtract(const Vector2&) const;
45     Vector2 divide(float) const;
46     Vector2 multiply(float) const;
47
48     string toString() const;
49     void print() const;
50 };
51
52 /// ***** Header Methods *****
53
54 // definitions of the operators are external because (float, Vector2) would
55 // fail inside the class
56
57 Vector2 operator+(const Vector2&, const Vector2&);
58 Vector2 operator-(const Vector2&, const Vector2&);
59 Vector2 operator*(float, const Vector2&);
60 Vector2 operator*(const Vector2&, float);
61 Vector2 operator/(const Vector2&, float);
62
63 void operator+=(Vector2&, const Vector2&);
64 void operator-=(Vector2&, const Vector2&);
65 void operator*=(Vector2&, float);
66 void operator/=(Vector2&, float);
67
68 #endif // VECTOR2_H