vrshoot

annotate libs/vmath/vector.h @ 0:b2f14e535253

find changesets by author, revision, files, or words in the commit message
initial commit
author John Tsiombikas <nuclear@member.fsf.org>
date Sat, 01 Feb 2014 19:58:19 +0200
parents
children
rev   line source
nuclear@0 1 /*
nuclear@0 2 libvmath - a vector math library
nuclear@0 3 Copyright (C) 2004-2011 John Tsiombikas <nuclear@member.fsf.org>
nuclear@0 4
nuclear@0 5 This program is free software: you can redistribute it and/or modify
nuclear@0 6 it under the terms of the GNU Lesser General Public License as published
nuclear@0 7 by the Free Software Foundation, either version 3 of the License, or
nuclear@0 8 (at your option) any later version.
nuclear@0 9
nuclear@0 10 This program is distributed in the hope that it will be useful,
nuclear@0 11 but WITHOUT ANY WARRANTY; without even the implied warranty of
nuclear@0 12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
nuclear@0 13 GNU Lesser General Public License for more details.
nuclear@0 14
nuclear@0 15 You should have received a copy of the GNU Lesser General Public License
nuclear@0 16 along with this program. If not, see <http://www.gnu.org/licenses/>.
nuclear@0 17 */
nuclear@0 18
nuclear@0 19 #ifndef VMATH_VECTOR_H_
nuclear@0 20 #define VMATH_VECTOR_H_
nuclear@0 21
nuclear@0 22 #include <stdio.h>
nuclear@0 23 #include "vmath_types.h"
nuclear@0 24
nuclear@0 25 #ifdef __cplusplus
nuclear@0 26 extern "C" {
nuclear@0 27 #endif /* __cplusplus */
nuclear@0 28
nuclear@0 29 /* C 2D vector functions */
nuclear@0 30 static inline vec2_t v2_cons(scalar_t x, scalar_t y);
nuclear@0 31 static inline void v2_print(FILE *fp, vec2_t v);
nuclear@0 32
nuclear@0 33 static inline vec2_t v2_add(vec2_t v1, vec2_t v2);
nuclear@0 34 static inline vec2_t v2_sub(vec2_t v1, vec2_t v2);
nuclear@0 35 static inline vec2_t v2_scale(vec2_t v, scalar_t s);
nuclear@0 36 static inline scalar_t v2_dot(vec2_t v1, vec2_t v2);
nuclear@0 37 static inline scalar_t v2_length(vec2_t v);
nuclear@0 38 static inline scalar_t v2_length_sq(vec2_t v);
nuclear@0 39 static inline vec2_t v2_normalize(vec2_t v);
nuclear@0 40
nuclear@0 41 static inline vec2_t v2_lerp(vec2_t v1, vec2_t v2, scalar_t t);
nuclear@0 42
nuclear@0 43 /* C 3D vector functions */
nuclear@0 44 static inline vec3_t v3_cons(scalar_t x, scalar_t y, scalar_t z);
nuclear@0 45 static inline void v3_print(FILE *fp, vec3_t v);
nuclear@0 46
nuclear@0 47 static inline vec3_t v3_add(vec3_t v1, vec3_t v2);
nuclear@0 48 static inline vec3_t v3_sub(vec3_t v1, vec3_t v2);
nuclear@0 49 static inline vec3_t v3_neg(vec3_t v);
nuclear@0 50 static inline vec3_t v3_mul(vec3_t v1, vec3_t v2);
nuclear@0 51 static inline vec3_t v3_scale(vec3_t v1, scalar_t s);
nuclear@0 52 static inline scalar_t v3_dot(vec3_t v1, vec3_t v2);
nuclear@0 53 static inline vec3_t v3_cross(vec3_t v1, vec3_t v2);
nuclear@0 54 static inline scalar_t v3_length(vec3_t v);
nuclear@0 55 static inline scalar_t v3_length_sq(vec3_t v);
nuclear@0 56 static inline vec3_t v3_normalize(vec3_t v);
nuclear@0 57 static inline vec3_t v3_transform(vec3_t v, mat4_t m);
nuclear@0 58
nuclear@0 59 static inline vec3_t v3_rotate(vec3_t v, scalar_t x, scalar_t y, scalar_t z);
nuclear@0 60 static inline vec3_t v3_rotate_axis(vec3_t v, scalar_t angle, scalar_t x, scalar_t y, scalar_t z);
nuclear@0 61 static inline vec3_t v3_rotate_quat(vec3_t v, quat_t q);
nuclear@0 62
nuclear@0 63 static inline vec3_t v3_reflect(vec3_t v, vec3_t n);
nuclear@0 64
nuclear@0 65 static inline vec3_t v3_lerp(vec3_t v1, vec3_t v2, scalar_t t);
nuclear@0 66
nuclear@0 67 /* C 4D vector functions */
nuclear@0 68 static inline vec4_t v4_cons(scalar_t x, scalar_t y, scalar_t z, scalar_t w);
nuclear@0 69 static inline void v4_print(FILE *fp, vec4_t v);
nuclear@0 70
nuclear@0 71 static inline vec4_t v4_add(vec4_t v1, vec4_t v2);
nuclear@0 72 static inline vec4_t v4_sub(vec4_t v1, vec4_t v2);
nuclear@0 73 static inline vec4_t v4_neg(vec4_t v);
nuclear@0 74 static inline vec4_t v4_mul(vec4_t v1, vec4_t v2);
nuclear@0 75 static inline vec4_t v4_scale(vec4_t v, scalar_t s);
nuclear@0 76 static inline scalar_t v4_dot(vec4_t v1, vec4_t v2);
nuclear@0 77 static inline scalar_t v4_length(vec4_t v);
nuclear@0 78 static inline scalar_t v4_length_sq(vec4_t v);
nuclear@0 79 static inline vec4_t v4_normalize(vec4_t v);
nuclear@0 80 static inline vec4_t v4_transform(vec4_t v, mat4_t m);
nuclear@0 81
nuclear@0 82 #ifdef __cplusplus
nuclear@0 83 } /* extern "C" */
nuclear@0 84
nuclear@0 85 /* when included from C++ source files, also define the vector classes */
nuclear@0 86 #include <iostream>
nuclear@0 87
nuclear@0 88 /** 2D Vector */
nuclear@0 89 class Vector2 {
nuclear@0 90 public:
nuclear@0 91 scalar_t x, y;
nuclear@0 92
nuclear@0 93 Vector2(scalar_t x = 0.0, scalar_t y = 0.0);
nuclear@0 94 Vector2(const vec2_t &vec);
nuclear@0 95 Vector2(const Vector3 &vec);
nuclear@0 96 Vector2(const Vector4 &vec);
nuclear@0 97
nuclear@0 98 inline scalar_t &operator [](int elem);
nuclear@0 99 inline const scalar_t &operator [](int elem) const;
nuclear@0 100
nuclear@0 101 inline scalar_t length() const;
nuclear@0 102 inline scalar_t length_sq() const;
nuclear@0 103 void normalize();
nuclear@0 104 Vector2 normalized() const;
nuclear@0 105
nuclear@0 106 void transform(const Matrix3x3 &mat);
nuclear@0 107 Vector2 transformed(const Matrix3x3 &mat) const;
nuclear@0 108
nuclear@0 109 void rotate(scalar_t angle);
nuclear@0 110 Vector2 rotated(scalar_t angle) const;
nuclear@0 111
nuclear@0 112 Vector2 reflection(const Vector2 &normal) const;
nuclear@0 113 Vector2 refraction(const Vector2 &normal, scalar_t src_ior, scalar_t dst_ior) const;
nuclear@0 114 };
nuclear@0 115
nuclear@0 116 /* unary operations */
nuclear@0 117 inline Vector2 operator -(const Vector2 &vec);
nuclear@0 118
nuclear@0 119 /* binary vector (op) vector operations */
nuclear@0 120 inline scalar_t dot_product(const Vector2 &v1, const Vector2 &v2);
nuclear@0 121
nuclear@0 122 inline Vector2 operator +(const Vector2 &v1, const Vector2 &v2);
nuclear@0 123 inline Vector2 operator -(const Vector2 &v1, const Vector2 &v2);
nuclear@0 124 inline Vector2 operator *(const Vector2 &v1, const Vector2 &v2);
nuclear@0 125 inline Vector2 operator /(const Vector2 &v1, const Vector2 &v2);
nuclear@0 126 inline bool operator ==(const Vector2 &v1, const Vector2 &v2);
nuclear@0 127
nuclear@0 128 inline void operator +=(Vector2 &v1, const Vector2 &v2);
nuclear@0 129 inline void operator -=(Vector2 &v1, const Vector2 &v2);
nuclear@0 130 inline void operator *=(Vector2 &v1, const Vector2 &v2);
nuclear@0 131 inline void operator /=(Vector2 &v1, const Vector2 &v2);
nuclear@0 132
nuclear@0 133 /* binary vector (op) scalar and scalar (op) vector operations */
nuclear@0 134 inline Vector2 operator +(const Vector2 &vec, scalar_t scalar);
nuclear@0 135 inline Vector2 operator +(scalar_t scalar, const Vector2 &vec);
nuclear@0 136 inline Vector2 operator -(const Vector2 &vec, scalar_t scalar);
nuclear@0 137 inline Vector2 operator *(const Vector2 &vec, scalar_t scalar);
nuclear@0 138 inline Vector2 operator *(scalar_t scalar, const Vector2 &vec);
nuclear@0 139 inline Vector2 operator /(const Vector2 &vec, scalar_t scalar);
nuclear@0 140
nuclear@0 141 inline void operator +=(Vector2 &vec, scalar_t scalar);
nuclear@0 142 inline void operator -=(Vector2 &vec, scalar_t scalar);
nuclear@0 143 inline void operator *=(Vector2 &vec, scalar_t scalar);
nuclear@0 144 inline void operator /=(Vector2 &vec, scalar_t scalar);
nuclear@0 145
nuclear@0 146 std::ostream &operator <<(std::ostream &out, const Vector2 &vec);
nuclear@0 147
nuclear@0 148 inline Vector2 lerp(const Vector2 &a, const Vector2 &b, scalar_t t);
nuclear@0 149 inline Vector2 catmull_rom_spline(const Vector2 &v0, const Vector2 &v1,
nuclear@0 150 const Vector2 &v2, const Vector2 &v3, scalar_t t);
nuclear@0 151 inline Vector2 bspline(const Vector2 &v0, const Vector2 &v1,
nuclear@0 152 const Vector2 &v2, const Vector2 &v3, scalar_t t);
nuclear@0 153
nuclear@0 154 /* 3D Vector */
nuclear@0 155 class Vector3 {
nuclear@0 156 public:
nuclear@0 157 scalar_t x, y, z;
nuclear@0 158
nuclear@0 159 Vector3(scalar_t x = 0.0, scalar_t y = 0.0, scalar_t z = 0.0);
nuclear@0 160 Vector3(const vec3_t &vec);
nuclear@0 161 Vector3(const Vector2 &vec);
nuclear@0 162 Vector3(const Vector4 &vec);
nuclear@0 163 Vector3(const SphVector &sph);
nuclear@0 164
nuclear@0 165 Vector3 &operator =(const SphVector &sph);
nuclear@0 166
nuclear@0 167 inline scalar_t &operator [](int elem);
nuclear@0 168 inline const scalar_t &operator [](int elem) const;
nuclear@0 169
nuclear@0 170 inline scalar_t length() const;
nuclear@0 171 inline scalar_t length_sq() const;
nuclear@0 172 void normalize();
nuclear@0 173 Vector3 normalized() const;
nuclear@0 174
nuclear@0 175 void transform(const Matrix3x3 &mat);
nuclear@0 176 Vector3 transformed(const Matrix3x3 &mat) const;
nuclear@0 177 void transform(const Matrix4x4 &mat);
nuclear@0 178 Vector3 transformed(const Matrix4x4 &mat) const;
nuclear@0 179 void transform(const Quaternion &quat);
nuclear@0 180 Vector3 transformed(const Quaternion &quat) const;
nuclear@0 181
nuclear@0 182 void rotate(const Vector3 &euler);
nuclear@0 183 Vector3 rotated(const Vector3 &euler) const;
nuclear@0 184
nuclear@0 185 Vector3 reflection(const Vector3 &normal) const;
nuclear@0 186 Vector3 refraction(const Vector3 &normal, scalar_t src_ior, scalar_t dst_ior) const;
nuclear@0 187 Vector3 refraction(const Vector3 &normal, scalar_t ior) const;
nuclear@0 188 };
nuclear@0 189
nuclear@0 190 /* unary operations */
nuclear@0 191 inline Vector3 operator -(const Vector3 &vec);
nuclear@0 192
nuclear@0 193 /* binary vector (op) vector operations */
nuclear@0 194 inline scalar_t dot_product(const Vector3 &v1, const Vector3 &v2);
nuclear@0 195 inline Vector3 cross_product(const Vector3 &v1, const Vector3 &v2);
nuclear@0 196
nuclear@0 197 inline Vector3 operator +(const Vector3 &v1, const Vector3 &v2);
nuclear@0 198 inline Vector3 operator -(const Vector3 &v1, const Vector3 &v2);
nuclear@0 199 inline Vector3 operator *(const Vector3 &v1, const Vector3 &v2);
nuclear@0 200 inline Vector3 operator /(const Vector3 &v1, const Vector3 &v2);
nuclear@0 201 inline bool operator ==(const Vector3 &v1, const Vector3 &v2);
nuclear@0 202
nuclear@0 203 inline void operator +=(Vector3 &v1, const Vector3 &v2);
nuclear@0 204 inline void operator -=(Vector3 &v1, const Vector3 &v2);
nuclear@0 205 inline void operator *=(Vector3 &v1, const Vector3 &v2);
nuclear@0 206 inline void operator /=(Vector3 &v1, const Vector3 &v2);
nuclear@0 207
nuclear@0 208 /* binary vector (op) scalar and scalar (op) vector operations */
nuclear@0 209 inline Vector3 operator +(const Vector3 &vec, scalar_t scalar);
nuclear@0 210 inline Vector3 operator +(scalar_t scalar, const Vector3 &vec);
nuclear@0 211 inline Vector3 operator -(const Vector3 &vec, scalar_t scalar);
nuclear@0 212 inline Vector3 operator *(const Vector3 &vec, scalar_t scalar);
nuclear@0 213 inline Vector3 operator *(scalar_t scalar, const Vector3 &vec);
nuclear@0 214 inline Vector3 operator /(const Vector3 &vec, scalar_t scalar);
nuclear@0 215
nuclear@0 216 inline void operator +=(Vector3 &vec, scalar_t scalar);
nuclear@0 217 inline void operator -=(Vector3 &vec, scalar_t scalar);
nuclear@0 218 inline void operator *=(Vector3 &vec, scalar_t scalar);
nuclear@0 219 inline void operator /=(Vector3 &vec, scalar_t scalar);
nuclear@0 220
nuclear@0 221 std::ostream &operator <<(std::ostream &out, const Vector3 &vec);
nuclear@0 222
nuclear@0 223 inline Vector3 lerp(const Vector3 &a, const Vector3 &b, scalar_t t);
nuclear@0 224 inline Vector3 catmull_rom_spline(const Vector3 &v0, const Vector3 &v1,
nuclear@0 225 const Vector3 &v2, const Vector3 &v3, scalar_t t);
nuclear@0 226 inline Vector3 bspline(const Vector3 &v0, const Vector3 &v1,
nuclear@0 227 const Vector3 &v2, const Vector3 &v3, scalar_t t);
nuclear@0 228
nuclear@0 229 /* 4D Vector */
nuclear@0 230 class Vector4 {
nuclear@0 231 public:
nuclear@0 232 scalar_t x, y, z, w;
nuclear@0 233
nuclear@0 234 Vector4(scalar_t x = 0.0, scalar_t y = 0.0, scalar_t z = 0.0, scalar_t w = 0.0);
nuclear@0 235 Vector4(const vec4_t &vec);
nuclear@0 236 Vector4(const Vector2 &vec);
nuclear@0 237 Vector4(const Vector3 &vec);
nuclear@0 238
nuclear@0 239 inline scalar_t &operator [](int elem);
nuclear@0 240 inline const scalar_t &operator [](int elem) const;
nuclear@0 241
nuclear@0 242 inline scalar_t length() const;
nuclear@0 243 inline scalar_t length_sq() const;
nuclear@0 244 void normalize();
nuclear@0 245 Vector4 normalized() const;
nuclear@0 246
nuclear@0 247 void transform(const Matrix4x4 &mat);
nuclear@0 248 Vector4 transformed(const Matrix4x4 &mat) const;
nuclear@0 249
nuclear@0 250 Vector4 reflection(const Vector4 &normal) const;
nuclear@0 251 Vector4 refraction(const Vector4 &normal, scalar_t src_ior, scalar_t dst_ior) const;
nuclear@0 252 };
nuclear@0 253
nuclear@0 254
nuclear@0 255 /* unary operations */
nuclear@0 256 inline Vector4 operator -(const Vector4 &vec);
nuclear@0 257
nuclear@0 258 /* binary vector (op) vector operations */
nuclear@0 259 inline scalar_t dot_product(const Vector4 &v1, const Vector4 &v2);
nuclear@0 260 inline Vector4 cross_product(const Vector4 &v1, const Vector4 &v2, const Vector4 &v3);
nuclear@0 261
nuclear@0 262 inline Vector4 operator +(const Vector4 &v1, const Vector4 &v2);
nuclear@0 263 inline Vector4 operator -(const Vector4 &v1, const Vector4 &v2);
nuclear@0 264 inline Vector4 operator *(const Vector4 &v1, const Vector4 &v2);
nuclear@0 265 inline Vector4 operator /(const Vector4 &v1, const Vector4 &v2);
nuclear@0 266 inline bool operator ==(const Vector4 &v1, const Vector4 &v2);
nuclear@0 267
nuclear@0 268 inline void operator +=(Vector4 &v1, const Vector4 &v2);
nuclear@0 269 inline void operator -=(Vector4 &v1, const Vector4 &v2);
nuclear@0 270 inline void operator *=(Vector4 &v1, const Vector4 &v2);
nuclear@0 271 inline void operator /=(Vector4 &v1, const Vector4 &v2);
nuclear@0 272
nuclear@0 273 /* binary vector (op) scalar and scalar (op) vector operations */
nuclear@0 274 inline Vector4 operator +(const Vector4 &vec, scalar_t scalar);
nuclear@0 275 inline Vector4 operator +(scalar_t scalar, const Vector4 &vec);
nuclear@0 276 inline Vector4 operator -(const Vector4 &vec, scalar_t scalar);
nuclear@0 277 inline Vector4 operator *(const Vector4 &vec, scalar_t scalar);
nuclear@0 278 inline Vector4 operator *(scalar_t scalar, const Vector4 &vec);
nuclear@0 279 inline Vector4 operator /(const Vector4 &vec, scalar_t scalar);
nuclear@0 280
nuclear@0 281 inline void operator +=(Vector4 &vec, scalar_t scalar);
nuclear@0 282 inline void operator -=(Vector4 &vec, scalar_t scalar);
nuclear@0 283 inline void operator *=(Vector4 &vec, scalar_t scalar);
nuclear@0 284 inline void operator /=(Vector4 &vec, scalar_t scalar);
nuclear@0 285
nuclear@0 286 std::ostream &operator <<(std::ostream &out, const Vector4 &vec);
nuclear@0 287
nuclear@0 288 inline Vector4 lerp(const Vector4 &v0, const Vector4 &v1, scalar_t t);
nuclear@0 289 inline Vector4 catmull_rom_spline(const Vector4 &v0, const Vector4 &v1,
nuclear@0 290 const Vector4 &v2, const Vector4 &v3, scalar_t t);
nuclear@0 291 inline Vector4 bspline(const Vector4 &v0, const Vector4 &v1,
nuclear@0 292 const Vector4 &v2, const Vector4 &v3, scalar_t t);
nuclear@0 293
nuclear@0 294 #endif /* __cplusplus */
nuclear@0 295
nuclear@0 296 #include "vector.inl"
nuclear@0 297
nuclear@0 298 #endif /* VMATH_VECTOR_H_ */