soft-math.hh

Go to the documentation of this file.

/*
 
MIT License
 
Copyright (c) 2023 PCSX-Redux authors
 
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.
 
*/
 
#pragma once
 
#include "fixed-point.hh"
#include "psyqo/matrix.hh"
#include "psyqo/trigonometry.hh"
#include "psyqo/vector.hh"
 
namespace psyqo {
 
namespace SoftMath {
 
enum class Axis { X, Y, Z };
void generateRotationMatrix33(Matrix33 *m, Angle t, Axis a, const Trig<> &trig);
[[deprecated("Use the reference version instead")]] static inline void generateRotationMatrix33(Matrix33 *m, Angle t,
                                                                                                Axis a,
                                                                                                const Trig<> *trig) {
    generateRotationMatrix33(m, t, a, *trig);
}
 
[[nodiscard]] Matrix33 generateRotationMatrix33(Angle t, Axis a, const Trig<> &trig);
[[nodiscard]] [[deprecated("Use the reference version instead")]] static inline Matrix33 generateRotationMatrix33(
    Angle t, Axis a, const Trig<> *trig) {
    return generateRotationMatrix33(t, a, *trig);
}
 
void multiplyMatrix33(const Matrix33 &m1, const Matrix33 &m2, Matrix33 *out);
[[deprecated("Use the reference version instead")]] static inline void multiplyMatrix33(const Matrix33 *m1,
                                                                                        const Matrix33 *m2,
                                                                                        Matrix33 *out) {
    multiplyMatrix33(*m1, *m2, out);
}
 
[[nodiscard]] Matrix33 multiplyMatrix33(const Matrix33 &m1, const Matrix33 &m2);
[[nodiscard]] [[deprecated("Use the reference version instead")]] static inline Matrix33 multiplyMatrix33(
    const Matrix33 *m1, const Matrix33 *m2) {
    return multiplyMatrix33(*m1, *m2);
}
 
void scaleMatrix33(Matrix33 *m, FixedPoint<> s);
 
void matrixVecMul3(const Matrix33 &m, const Vec3 &v, Vec3 *out);
[[deprecated("Use the reference version instead")]] static inline void matrixVecMul3(const Matrix33 *m, const Vec3 *v,
                                                                                     Vec3 *out) {
    matrixVecMul3(*m, *v, out);
}
 
void matrixVecMul3xy(const Matrix33 &m, const Vec3 &v, Vec2 *out);
[[deprecated("Use the reference version instead")]] static inline void matrixVecMul3xy(const Matrix33 *m, const Vec3 *v,
                                                                                       Vec2 *out) {
    matrixVecMul3xy(*m, *v, out);
}
 
[[nodiscard]] FixedPoint<> matrixVecMul3z(const Matrix33 &m, const Vec3 &v);
[[nodiscard]] [[deprecated("Use the reference version instead")]] static inline FixedPoint<> matrixVecMul3z(
    const Matrix33 *m, const Vec3 *v) {
    return matrixVecMul3z(*m, *v);
}
 
void crossProductVec3(const Vec3 &v1, const Vec3 &v2, Vec3 *out);
[[deprecated("Use the reference version instead")]] static inline void crossProductVec3(const Vec3 *v1, const Vec3 *v2,
                                                                                        Vec3 *out) {
    crossProductVec3(*v1, *v2, out);
}
 
[[nodiscard]] Vec3 crossProductVec3(const Vec3 &v1, const Vec3 &v2);
[[nodiscard]] [[deprecated("Use the reference version instead")]] static inline Vec3 crossProductVec3(const Vec3 *v1,
                                                                                                      const Vec3 *v2) {
    return crossProductVec3(*v1, *v2);
}
 
[[nodiscard]] FixedPoint<> matrixDeterminant3(const Matrix33 &m);
[[nodiscard]] [[deprecated("Use the reference version instead")]] static inline FixedPoint<> matrixDeterminant3(
    const Matrix33 *m) {
    return matrixDeterminant3(*m);
}
 
[[nodiscard]] FixedPoint<> squareRoot(FixedPoint<> x, FixedPoint<> y);
 
[[nodiscard]] static inline FixedPoint<> squareRoot(FixedPoint<> x) { return squareRoot(x, x / 2); }
 
[[nodiscard]] FixedPoint<> inverseSquareRoot(FixedPoint<> x, FixedPoint<> y);
 
[[nodiscard]] static inline FixedPoint<> inverseSquareRoot(FixedPoint<> x) { return inverseSquareRoot(x, x * 2); }
 
[[nodiscard]] FixedPoint<> normOfVec3(const Vec3 &v);
[[nodiscard]] [[deprecated("Use the reference version instead")]] static inline FixedPoint<> normOfVec3(const Vec3 *v) {
    return normOfVec3(*v);
}
 
void normalizeVec3(Vec3 *v);
 
void fastNormalizeVec3(Vec3 *v);
 
void project(const Vec3 *v, FixedPoint<> h, Vec2 *out);
 
}  // namespace SoftMath
 
}  // namespace psyqo