istereo

annotate libs/vmath/vector.h @ 39:ff055bff6a15

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