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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef TITANIC_FVECTOR_H
#define TITANIC_FVECTOR_H
#include "titanic/star_control/fpoint.h"
namespace Titanic {
enum Axis { X_AXIS, Y_AXIS, Z_AXIS };
class FPose;
/**
* Floating point vector class.
*/
class FVector {
public:
float _x, _y, _z;
public:
FVector() : _x(0), _y(0), _z(0) {}
FVector(float x, float y, float z) : _x(x), _y(y), _z(z) {}
/**
* Clears the vector
*/
void clear() {
_x = _y = _z = 0.0;
}
/**
* Returns a vector with all components of this vector circularlly rotated up 1.
* this x being _y, this y being _z, and this z being _x. A sign change may also
* be done on x/_y based on some conditions.
*/
FVector swapComponents() const;
/**
* Calculates the cross-product between this matrix and a passed one
*/
FVector crossProduct(const FVector &src) const;
/**
* Rotate this vector about the Y axis
*/
void rotVectAxisY(float angleDeg);
/**
* Attempts to normalizes the vector so the length from origin equals 1.0
* Return value is whether or not it was successful in normalizing
* First argument is scale value that normalizes the vector
* TODO: split this function into 2. One that calculates the normalization
* and another that does the normalization. The 2nd would assert if a
* normalization of one was requested. This is cleaner than the current
* implementation.
*/
bool normalize(float &);
/**
* Adds the current vector and a passed one together, normalizes them,
* and then returns the resulting vector
*/
FVector addAndNormalize(const FVector &v) const;
/**
* Returns a vector, v, that represents a magnitude, and two angles in radians
* 1. Scale this vector to be unit magnitude and store scale in x component of v
* 2. X rotation angle from +y axis of this vector is put in y component of v
* 3. z component output of v is the 4-quadrant angle that z makes with x (Y axis rotation)
*/
FVector getAnglesAsVect() const;
/**
* Returns the distance between a specified point and this one
*/
float getDistance(const FVector &src) const;
/**
* Returns a vector that is this vector on the left as a row vector
* times the 3x4 affine matrix on the right.
*/
FVector matProdRowVect(const FPose &pose) const;
/**
* Returns a matrix that contains the frame rotation based on this vector and
* a vector rotation based on input vector v
*/
FPose getFrameTransform(const FVector &v);
/**
* Constructs an affine matrix that does a x then a y axis frame rotation
* based on the orientation of this vector
*/
FPose formRotXY() const;
/**
* Returns true if the passed vector equals this one
*/
bool operator==(const FVector &src) const {
return _x == src._x && _y == src._y && _z == src._z;
}
/**
* Returns true if the passed vector does not equal this one
*/
bool operator!=(const FVector &src) const {
return _x != src._x || _y != src._y || _z != src._z;
}
FVector operator+(const FVector &delta) const {
return FVector(_x + delta._x, _y + delta._y, _z + delta._z);
}
FVector operator-(const FVector &delta) const {
return FVector(_x - delta._x, _y - delta._y, _z - delta._z);
}
const FVector operator*(float right) const {
return FVector(_x * right, _y * right, _z * right);
}
const FVector operator*(const FVector &right) const {
return FVector(_x * right._x, _y * right._y, _z * right._z);
}
void operator+=(const FVector &delta) {
_x += delta._x;
_y += delta._y;
_z += delta._z;
}
void operator-=(const FVector &delta) {
_x -= delta._x;
_y -= delta._y;
_z -= delta._z;
}
void operator+=(const FPoint &delta) {
_x += delta._x;
_y += delta._y;
}
void operator-=(const FPoint &delta) {
_x -= delta._x;
_y -= delta._y;
}
/**
* Converts the vector to a string
*/
Common::String toString() const;
};
} // End of namespace Titanic
#endif /* TITANIC_FVECTOR_H */
|
