1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
/*
* This source file is part of libRocket, the HTML/CSS Interface Middleware
*
* For the latest information, see http://www.librocket.com
*
* Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*/
#ifndef ROCKETCOREVECTOR2_H
#define ROCKETCOREVECTOR2_H
#include "Debug.h"
#include "Math.h"
namespace Rocket {
namespace Core {
/**
Templated class for a generic two-component vector.
@author Peter Curry
*/
template < typename Type >
class Vector2
{
public:
/// Lightweight, non-initialising constructor.
inline Vector2();
/// Initialising constructor.
/// @param[in] x Initial x-value of the vector.
/// @param[in] y Initial y-value of the vector.
inline Vector2(Type x, Type y);
/// Returns the magnitude of the vector.
/// @return The computed magnitude.
inline float Magnitude() const;
/// Returns the squared magnitude of the vector.
/// @return The computed squared magnitude.
inline Type SquaredMagnitude() const;
/// Generates a normalised vector from this vector.
/// @return The normalised vector.
inline Vector2 Normalise() const;
/// Computes the dot-product between this vector and another.
/// @param[in] rhs The other vector to use in the dot-product.
/// @return The computed dot-product between the two vectors.
inline Type DotProduct(const Vector2& rhs) const;
/// Returns this vector rotated around the origin.
/// @param[in] theta The angle to rotate by, in radians.
/// @return The rotated vector.
inline Vector2 Rotate(float theta) const;
/// Returns the negation of this vector.
/// @return The negation of this vector.
inline Vector2 operator-() const;
/// Returns the sum of this vector and another.
/// @param[in] rhs The vector to add this to.
/// @return The sum of the two vectors.
inline Vector2 operator+(const Vector2& rhs) const;
/// Returns the result of subtracting another vector from this vector.
/// @param[in] rhs The vector to subtract from this vector.
/// @return The result of the subtraction.
inline Vector2 operator-(const Vector2& rhs) const;
/// Returns the result of multiplying this vector by a scalar.
/// @param[in] rhs The scalar value to multiply by.
/// @return The result of the scale.
inline Vector2 operator*(Type rhs) const;
/// Returns the result of dividing this vector by a scalar.
/// @param[in] rhs The scalar value to divide by.
/// @return The result of the scale.
inline Vector2 operator/(Type rhs) const;
/// Adds another vector to this in-place.
/// @param[in] rhs The vector to add.
/// @return This vector, post-operation.
inline Vector2& operator+=(const Vector2& rhs);
/// Subtracts another vector from this in-place.
/// @param[in] rhs The vector to subtract.
/// @return This vector, post-operation.
inline Vector2& operator-=(const Vector2& rhs);
/// Scales this vector in-place.
/// @param[in] rhs The value to scale this vector's components by.
/// @return This vector, post-operation.
inline Vector2& operator*=(const Type& rhs);
/// Scales this vector in-place by the inverse of a value.
/// @param[in] rhs The value to divide this vector's components by.
/// @return This vector, post-operation.
inline Vector2& operator/=(const Type& rhs);
/// Equality operator.
/// @param[in] rhs The vector to compare this against.
/// @return True if the two vectors are equal, false otherwise.
inline bool operator==(const Vector2& rhs) const;
/// Inequality operator.
/// @param[in] rhs The vector to compare this against.
/// @return True if the two vectors are not equal, false otherwise.
inline bool operator!=(const Vector2& rhs) const;
/// Auto-cast operator.
/// @return A pointer to the first value.
inline operator const Type*() const;
/// Constant auto-cast operator.
/// @return A constant pointer to the first value.
inline operator Type*();
// The components of the vector.
Type x;
Type y;
};
#include "Vector2.inl"
}
}
#endif
|
