virtualx-engine/core/math/quaternion.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

236 lines
7.4 KiB
C++
Raw Normal View History

2014-02-10 02:10:30 +01:00
/*************************************************************************/
2021-01-20 08:02:02 +01:00
/* quaternion.h */
2014-02-10 02:10:30 +01:00
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
2014-02-10 02:10:30 +01:00
/*************************************************************************/
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
2014-02-10 02:10:30 +01:00
/* */
/* 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. */
/*************************************************************************/
2020-12-07 07:40:46 +01:00
#ifndef QUATERNION_H
#define QUATERNION_H
2014-02-10 02:10:30 +01:00
#include "core/math/math_funcs.h"
2021-05-19 16:09:21 +02:00
#include "core/math/vector3.h"
class String;
2014-02-10 02:10:30 +01:00
struct _NO_DISCARD_ Quaternion {
union {
struct {
real_t x;
real_t y;
real_t z;
real_t w;
};
real_t components[4] = { 0, 0, 0, 1.0 };
};
2014-02-10 02:10:30 +01:00
_FORCE_INLINE_ real_t &operator[](int idx) {
return components[idx];
}
_FORCE_INLINE_ const real_t &operator[](int idx) const {
return components[idx];
}
2014-02-10 02:10:30 +01:00
_FORCE_INLINE_ real_t length_squared() const;
2021-01-20 08:02:02 +01:00
bool is_equal_approx(const Quaternion &p_quaternion) const;
2014-02-10 02:10:30 +01:00
real_t length() const;
void normalize();
2021-01-20 08:02:02 +01:00
Quaternion normalized() const;
bool is_normalized() const;
2021-01-20 08:02:02 +01:00
Quaternion inverse() const;
Quaternion log() const;
Quaternion exp() const;
2021-01-20 08:02:02 +01:00
_FORCE_INLINE_ real_t dot(const Quaternion &p_q) const;
2020-12-07 07:40:46 +01:00
real_t angle_to(const Quaternion &p_to) const;
Vector3 get_euler_xyz() const;
Vector3 get_euler_yxz() const;
Vector3 get_euler() const { return get_euler_yxz(); };
2021-01-20 08:02:02 +01:00
Quaternion slerp(const Quaternion &p_to, const real_t &p_weight) const;
Quaternion slerpni(const Quaternion &p_to, const real_t &p_weight) const;
Quaternion spherical_cubic_interpolate(const Quaternion &p_b, const Quaternion &p_pre_a, const Quaternion &p_post_b, const real_t &p_weight) const;
Quaternion spherical_cubic_interpolate_in_time(const Quaternion &p_b, const Quaternion &p_pre_a, const Quaternion &p_post_b, const real_t &p_weight, const real_t &p_b_t, const real_t &p_pre_a_t, const real_t &p_post_b_t) const;
2014-02-10 02:10:30 +01:00
Vector3 get_axis() const;
real_t get_angle() const;
_FORCE_INLINE_ void get_axis_angle(Vector3 &r_axis, real_t &r_angle) const {
2014-02-10 02:10:30 +01:00
r_angle = 2 * Math::acos(w);
real_t r = ((real_t)1) / Math::sqrt(1 - w * w);
r_axis.x = x * r;
r_axis.y = y * r;
r_axis.z = z * r;
2014-02-10 02:10:30 +01:00
}
2021-01-20 08:02:02 +01:00
void operator*=(const Quaternion &p_q);
Quaternion operator*(const Quaternion &p_q) const;
_FORCE_INLINE_ Vector3 xform(const Vector3 &v) const {
#ifdef MATH_CHECKS
ERR_FAIL_COND_V_MSG(!is_normalized(), v, "The quaternion must be normalized.");
#endif
Vector3 u(x, y, z);
Vector3 uv = u.cross(v);
return v + ((uv * w) + u.cross(uv)) * ((real_t)2);
}
_FORCE_INLINE_ Vector3 xform_inv(const Vector3 &v) const {
return inverse().xform(v);
}
2021-01-20 08:02:02 +01:00
_FORCE_INLINE_ void operator+=(const Quaternion &p_q);
_FORCE_INLINE_ void operator-=(const Quaternion &p_q);
2014-02-10 02:10:30 +01:00
_FORCE_INLINE_ void operator*=(const real_t &s);
_FORCE_INLINE_ void operator/=(const real_t &s);
2021-01-20 08:02:02 +01:00
_FORCE_INLINE_ Quaternion operator+(const Quaternion &q2) const;
_FORCE_INLINE_ Quaternion operator-(const Quaternion &q2) const;
_FORCE_INLINE_ Quaternion operator-() const;
_FORCE_INLINE_ Quaternion operator*(const real_t &s) const;
_FORCE_INLINE_ Quaternion operator/(const real_t &s) const;
2014-02-10 02:10:30 +01:00
2021-01-20 08:02:02 +01:00
_FORCE_INLINE_ bool operator==(const Quaternion &p_quaternion) const;
_FORCE_INLINE_ bool operator!=(const Quaternion &p_quaternion) const;
2016-03-09 00:00:52 +01:00
2014-02-10 02:10:30 +01:00
operator String() const;
2016-03-09 00:00:52 +01:00
2021-01-20 08:02:02 +01:00
_FORCE_INLINE_ Quaternion() {}
2021-01-20 08:02:02 +01:00
_FORCE_INLINE_ Quaternion(real_t p_x, real_t p_y, real_t p_z, real_t p_w) :
x(p_x),
y(p_y),
z(p_z),
w(p_w) {
2014-02-10 02:10:30 +01:00
}
2021-01-20 08:02:02 +01:00
Quaternion(const Vector3 &p_axis, real_t p_angle);
2021-01-20 08:02:02 +01:00
Quaternion(const Vector3 &p_euler);
2021-01-20 08:02:02 +01:00
Quaternion(const Quaternion &p_q) :
2020-12-07 09:16:31 +01:00
x(p_q.x),
y(p_q.y),
z(p_q.z),
w(p_q.w) {
}
void operator=(const Quaternion &p_q) {
2020-12-07 09:16:31 +01:00
x = p_q.x;
y = p_q.y;
z = p_q.z;
w = p_q.w;
}
Quaternion(const Vector3 &v0, const Vector3 &v1) { // Shortest arc.
Vector3 c = v0.cross(v1);
real_t d = v0.dot(v1);
if (d < -1.0f + (real_t)CMP_EPSILON) {
x = 0;
y = 1;
z = 0;
w = 0;
} else {
real_t s = Math::sqrt((1.0f + d) * 2.0f);
real_t rs = 1.0f / s;
x = c.x * rs;
y = c.y * rs;
z = c.z * rs;
w = s * 0.5f;
}
}
2014-02-10 02:10:30 +01:00
};
2021-01-20 08:02:02 +01:00
real_t Quaternion::dot(const Quaternion &p_q) const {
2020-12-07 09:16:31 +01:00
return x * p_q.x + y * p_q.y + z * p_q.z + w * p_q.w;
2014-02-10 02:10:30 +01:00
}
2021-01-20 08:02:02 +01:00
real_t Quaternion::length_squared() const {
2014-02-10 02:10:30 +01:00
return dot(*this);
}
2021-01-20 08:02:02 +01:00
void Quaternion::operator+=(const Quaternion &p_q) {
2020-12-07 09:16:31 +01:00
x += p_q.x;
y += p_q.y;
z += p_q.z;
w += p_q.w;
2014-02-10 02:10:30 +01:00
}
2021-01-20 08:02:02 +01:00
void Quaternion::operator-=(const Quaternion &p_q) {
2020-12-07 09:16:31 +01:00
x -= p_q.x;
y -= p_q.y;
z -= p_q.z;
w -= p_q.w;
2014-02-10 02:10:30 +01:00
}
2021-01-20 08:02:02 +01:00
void Quaternion::operator*=(const real_t &s) {
2014-02-10 02:10:30 +01:00
x *= s;
y *= s;
z *= s;
w *= s;
}
2021-01-20 08:02:02 +01:00
void Quaternion::operator/=(const real_t &s) {
*this *= 1.0f / s;
2014-02-10 02:10:30 +01:00
}
2021-01-20 08:02:02 +01:00
Quaternion Quaternion::operator+(const Quaternion &q2) const {
const Quaternion &q1 = *this;
return Quaternion(q1.x + q2.x, q1.y + q2.y, q1.z + q2.z, q1.w + q2.w);
2014-02-10 02:10:30 +01:00
}
2021-01-20 08:02:02 +01:00
Quaternion Quaternion::operator-(const Quaternion &q2) const {
const Quaternion &q1 = *this;
return Quaternion(q1.x - q2.x, q1.y - q2.y, q1.z - q2.z, q1.w - q2.w);
2014-02-10 02:10:30 +01:00
}
2021-01-20 08:02:02 +01:00
Quaternion Quaternion::operator-() const {
const Quaternion &q2 = *this;
return Quaternion(-q2.x, -q2.y, -q2.z, -q2.w);
2014-02-10 02:10:30 +01:00
}
2021-01-20 08:02:02 +01:00
Quaternion Quaternion::operator*(const real_t &s) const {
return Quaternion(x * s, y * s, z * s, w * s);
2014-02-10 02:10:30 +01:00
}
2021-01-20 08:02:02 +01:00
Quaternion Quaternion::operator/(const real_t &s) const {
return *this * (1.0f / s);
2014-02-10 02:10:30 +01:00
}
2021-01-20 08:02:02 +01:00
bool Quaternion::operator==(const Quaternion &p_quaternion) const {
return x == p_quaternion.x && y == p_quaternion.y && z == p_quaternion.z && w == p_quaternion.w;
2014-02-10 02:10:30 +01:00
}
2021-01-20 08:02:02 +01:00
bool Quaternion::operator!=(const Quaternion &p_quaternion) const {
return x != p_quaternion.x || y != p_quaternion.y || z != p_quaternion.z || w != p_quaternion.w;
2014-02-10 02:10:30 +01:00
}
2021-01-20 08:02:02 +01:00
_FORCE_INLINE_ Quaternion operator*(const real_t &p_real, const Quaternion &p_quaternion) {
return p_quaternion * p_real;
}
2020-12-07 07:40:46 +01:00
#endif // QUATERNION_H