Make Basis look column-major while retaining a row-major representation
Per https://github.com/godotengine/godot/issues/14553: Godot stores Basis in row-major layout for more change for efficiently taking advantage of SIMD instructions, but in scripts Basis looks like and is accessible in a column-major format. This change modifies the C++ binding so that from the script's perspective Basis does look like if it was column-major while retaining a row-major in-memory representation. This is achieved using a set of helper template classes which allow accessing individual columns whose components are non-continues in memory as if it was a Vector3 type. This ensures script interface compatibility without needing to transpose the Basis every time it is passed over the script-engine boundary. Also made most of the Vector2 and Vector3 class interfaces inlined in the process for increased performance. While unrelated (but didn't want to file a separate PR for it), this change adds the necessary flags to have debug symbol information under MSVC. Fixes #241.
This commit is contained in:
Daniel Rakos
@@ -1,6 +1,8 @@
|
||||
#ifndef BASIS_H
|
||||
#define BASIS_H
|
||||
|
||||
#include <gdnative/basis.h>
|
||||
|
||||
#include "Defs.hpp"
|
||||
|
||||
#include "Vector3.hpp"
|
||||
@@ -10,12 +12,291 @@ namespace godot {
|
||||
class Quat;
|
||||
|
||||
class Basis {
|
||||
private:
|
||||
// This helper template is for mimicking the behavior difference between the engine
|
||||
// and script interfaces that logically script sees matrices as column major, while
|
||||
// the engine stores them in row major to efficiently take advantage of SIMD
|
||||
// instructions in case of matrix-vector multiplications.
|
||||
// With this helper template native scripts see the data as if it was column major
|
||||
// without actually transposing the basis matrix at the script-engine boundary.
|
||||
template <int column>
|
||||
class ColumnVector3 {
|
||||
private:
|
||||
template <int column, int component>
|
||||
class ColumnVectorComponent {
|
||||
private:
|
||||
Vector3 elements[3];
|
||||
|
||||
protected:
|
||||
inline ColumnVectorComponent<column, component> &operator=(const ColumnVectorComponent<column, component> &p_value) {
|
||||
return *this = real_t(p_value);
|
||||
}
|
||||
|
||||
inline ColumnVectorComponent(const ColumnVectorComponent<column, component> &p_value) {
|
||||
*this = real_t(p_value);
|
||||
}
|
||||
|
||||
inline ColumnVectorComponent<column, component> &operator=(const real_t &p_value) {
|
||||
element[component][column] = p_value;
|
||||
return *this;
|
||||
}
|
||||
|
||||
inline operator real_t() const {
|
||||
return element[component][column];
|
||||
}
|
||||
};
|
||||
|
||||
public:
|
||||
enum Axis {
|
||||
AXIS_X,
|
||||
AXIS_Y,
|
||||
AXIS_Z,
|
||||
};
|
||||
|
||||
union {
|
||||
ColumnVectorComponent<column, 0> x;
|
||||
ColumnVectorComponent<column, 1> y;
|
||||
ColumnVectorComponent<column, 2> z;
|
||||
|
||||
Vector3 elements[3]; // Not for direct access, use [] operator instead
|
||||
};
|
||||
|
||||
inline ColumnVector3<column> &operator=(const ColumnVector3<column> &p_value) {
|
||||
return *this = Vector3(p_value);
|
||||
}
|
||||
|
||||
inline ColumnVector3(const ColumnVector3<column> &p_value) {
|
||||
*this = Vector3(p_value);
|
||||
}
|
||||
|
||||
inline ColumnVector3<column> &operator=(const Vector3 &p_value) {
|
||||
elements[0][column] = p_value.x;
|
||||
elements[1][column] = p_value.y;
|
||||
elements[2][column] = p_value.z;
|
||||
return *this;
|
||||
}
|
||||
|
||||
inline operator Vector3() const {
|
||||
return Vector3(elements[0][column], elements[1][column], elements[2][column]);
|
||||
}
|
||||
|
||||
// Unfortunately, we also need to replicate the other interfaces of Vector3 in
|
||||
// order for being able to directly operate on these "meta-Vector3" objects without
|
||||
// an explicit cast or an intermediate assignment to a real Vector3 object.
|
||||
|
||||
inline const real_t &operator[](int p_axis) const {
|
||||
return elements[p_axis][column];
|
||||
}
|
||||
|
||||
inline real_t &operator[](int p_axis) {
|
||||
return elements[p_axis][column];
|
||||
}
|
||||
|
||||
inline ColumnVector3<column> &operator+=(const Vector3 &p_v) {
|
||||
return *this = *this + p_v;
|
||||
}
|
||||
|
||||
inline Vector3 operator+(const Vector3 &p_v) const {
|
||||
return Vector3(*this) + p_v;
|
||||
}
|
||||
|
||||
inline ColumnVector3<column> &operator-=(const Vector3 &p_v) {
|
||||
return *this = *this - p_v;
|
||||
}
|
||||
|
||||
inline Vector3 operator-(const Vector3 &p_v) const {
|
||||
return Vector3(*this) - p_v;
|
||||
}
|
||||
|
||||
inline ColumnVector3<column> &operator*=(const Vector3 &p_v) {
|
||||
return *this = *this * p_v;
|
||||
}
|
||||
|
||||
inline Vector3 operator*(const Vector3 &p_v) const {
|
||||
return Vector3(*this) * p_v;
|
||||
}
|
||||
|
||||
inline ColumnVector3<column> &operator/=(const Vector3 &p_v) {
|
||||
return *this = *this / p_v;
|
||||
}
|
||||
|
||||
inline Vector3 operator/(const Vector3 &p_v) const {
|
||||
return Vector3(*this) / p_v;
|
||||
}
|
||||
|
||||
inline ColumnVector3<column> &operator*=(real_t p_scalar) {
|
||||
return *this = *this * p_scalar;
|
||||
}
|
||||
|
||||
inline Vector3 operator*(real_t p_scalar) const {
|
||||
return Vector3(*this) * p_scalar;
|
||||
}
|
||||
|
||||
inline ColumnVector3<column> &operator/=(real_t p_scalar) {
|
||||
return *this = *this / p_scalar;
|
||||
}
|
||||
|
||||
inline Vector3 operator/(real_t p_scalar) const {
|
||||
return Vector3(*this) / p_scalar;
|
||||
}
|
||||
|
||||
inline Vector3 operator-() const {
|
||||
return -Vector3(*this);
|
||||
}
|
||||
|
||||
inline bool operator==(const Vector3 &p_v) const {
|
||||
return Vector3(*this) == p_v;
|
||||
}
|
||||
|
||||
inline bool operator!=(const Vector3 &p_v) const {
|
||||
return Vector3(*this) != p_v;
|
||||
}
|
||||
|
||||
inline bool operator<(const Vector3 &p_v) const {
|
||||
return Vector3(*this) < p_v;
|
||||
}
|
||||
|
||||
inline bool operator<=(const Vector3 &p_v) const {
|
||||
return Vector3(*this) <= p_v;
|
||||
}
|
||||
|
||||
inline Vector3 abs() const {
|
||||
return Vector3(*this).abs();
|
||||
}
|
||||
|
||||
inline Vector3 ceil() const {
|
||||
return Vector3(*this).ceil();
|
||||
}
|
||||
|
||||
inline Vector3 cross(const Vector3 &b) const {
|
||||
return Vector3(*this).cross(b);
|
||||
}
|
||||
|
||||
inline Vector3 linear_interpolate(const Vector3 &p_b, real_t p_t) const {
|
||||
return Vector3(*this).linear_interpolate(p_b, p_t);
|
||||
}
|
||||
|
||||
inline Vector3 cubic_interpolate(const Vector3 &b, const Vector3 &pre_a, const Vector3 &post_b, const real_t t) const {
|
||||
return Vector3(*this).cubic_interpolate(b, pre_a, post_b, t);
|
||||
}
|
||||
|
||||
inline Vector3 bounce(const Vector3 &p_normal) const {
|
||||
return Vector3(*this).bounce(p_normal);
|
||||
}
|
||||
|
||||
inline real_t length() const {
|
||||
return Vector3(*this).length();
|
||||
}
|
||||
|
||||
inline real_t length_squared() const {
|
||||
return Vector3(*this).length_squared();
|
||||
}
|
||||
|
||||
inline real_t distance_squared_to(const Vector3 &b) const {
|
||||
return Vector3(*this).distance_squared_to(b);
|
||||
}
|
||||
|
||||
inline real_t distance_to(const Vector3 &b) const {
|
||||
return Vector3(*this).distance_to(b);
|
||||
}
|
||||
|
||||
inline real_t dot(const Vector3 &b) const {
|
||||
return Vector3(*this).dot(b);
|
||||
}
|
||||
|
||||
inline real_t angle_to(const Vector3 &b) const {
|
||||
return Vector3(*this).angle_to(b);
|
||||
}
|
||||
|
||||
inline Vector3 floor() const {
|
||||
return Vector3(*this).floor();
|
||||
}
|
||||
|
||||
inline Vector3 inverse() const {
|
||||
return Vector3(*this).inverse();
|
||||
}
|
||||
|
||||
inline bool is_normalized() const {
|
||||
return Vector3(*this).is_normalized();
|
||||
}
|
||||
|
||||
inline Basis outer(const Vector3 &b) const {
|
||||
return Vector3(*this).outer(b);
|
||||
}
|
||||
|
||||
inline int max_axis() const {
|
||||
return Vector3(*this).max_axis();
|
||||
}
|
||||
|
||||
inline int min_axis() const {
|
||||
return Vector3(*this).min_axis();
|
||||
}
|
||||
|
||||
inline void normalize() {
|
||||
Vector3 v = *this;
|
||||
v.normalize();
|
||||
*this = v;
|
||||
}
|
||||
|
||||
inline Vector3 normalized() const {
|
||||
return Vector3(*this).normalized();
|
||||
}
|
||||
|
||||
inline Vector3 reflect(const Vector3 &by) const {
|
||||
return Vector3(*this).reflect(by);
|
||||
}
|
||||
|
||||
inline Vector3 rotated(const Vector3 &axis, const real_t phi) const {
|
||||
return Vector3(*this).rotated(axis, phi);
|
||||
}
|
||||
|
||||
inline void rotate(const Vector3 &p_axis, real_t p_phi) {
|
||||
Vector3 v = *this;
|
||||
v.rotate(p_axis, p_phi);
|
||||
*this = v;
|
||||
}
|
||||
|
||||
inline Vector3 slide(const Vector3 &by) const {
|
||||
return Vector3(*this).slide(by);
|
||||
}
|
||||
|
||||
inline void snap(real_t p_val) {
|
||||
Vector3 v = *this;
|
||||
v.snap(p_val);
|
||||
*this = v;
|
||||
}
|
||||
|
||||
inline Vector3 snapped(const float by) {
|
||||
return Vector3(*this).snapped(by);
|
||||
}
|
||||
|
||||
inline operator String() const {
|
||||
return String(Vector3(*this))
|
||||
}
|
||||
};
|
||||
|
||||
public:
|
||||
union {
|
||||
Vector3 elements[3];
|
||||
Vector3 x, y, z;
|
||||
ColumnVector3<0> x;
|
||||
ColumnVector3<1> y;
|
||||
ColumnVector3<2> z;
|
||||
|
||||
Vector3 elements[3]; // Not for direct access, use [] operator instead
|
||||
};
|
||||
|
||||
inline Basis(const Basis &p_basis) {
|
||||
elements[0] = p_basis.elements[0];
|
||||
elements[1] = p_basis.elements[1];
|
||||
elements[2] = p_basis.elements[2];
|
||||
}
|
||||
|
||||
inline Basis &operator=(const Basis &p_basis) {
|
||||
elements[0] = p_basis.elements[0];
|
||||
elements[1] = p_basis.elements[1];
|
||||
elements[2] = p_basis.elements[2];
|
||||
return *this;
|
||||
}
|
||||
|
||||
Basis(const Quat &p_quat); // euler
|
||||
Basis(const Vector3 &p_euler); // euler
|
||||
Basis(const Vector3 &p_axis, real_t p_phi);
|
||||
@@ -26,8 +307,16 @@ public:
|
||||
|
||||
Basis();
|
||||
|
||||
const Vector3 &operator[](int axis) const;
|
||||
Vector3 &operator[](int axis);
|
||||
const Vector3 &operator[](int axis) const {
|
||||
return get_axis(axis);
|
||||
}
|
||||
|
||||
ColumnVector3<0> &operator[](int axis) {
|
||||
// We need to do a little pointer magic to get this to work, because the
|
||||
// ColumnVector3 template takes the axis as a template parameter.
|
||||
// Don't touch this unless you're sure what you're doing!
|
||||
return (reinterpret_cast<Basis *>(reinterpret_cast<real_t *>(this) + axis))->x;
|
||||
}
|
||||
|
||||
void invert();
|
||||
|
||||
|
||||
Reference in New Issue
Block a user