SqMod/module/Base/AABB.cpp

// ------------------------------------------------------------------------------------------------
#include "Base/AABB.hpp"
#include "Base/Sphere.hpp"
#include "Base/DynArg.hpp"
#include "Core/Buffer.hpp"
#include "Core/Utility.hpp"

// ------------------------------------------------------------------------------------------------
namespace SqMod {

// ------------------------------------------------------------------------------------------------
SQMOD_DECL_TYPENAME(Typename, _SC("AABB"))

// ------------------------------------------------------------------------------------------------
const AABB AABB::NIL = AABB(0, 0);
const AABB AABB::MIN = AABB(-1, -1, -1, 1, 1, 1);
const AABB AABB::MAX = AABB(HUGE_VALF, -HUGE_VALF);

// ------------------------------------------------------------------------------------------------
SQChar AABB::Delim = ',';

// ------------------------------------------------------------------------------------------------
AABB::AABB(Value mins, Value maxs) noexcept
    : min(mins), max(maxs)
{
    /* ... */
}

// ------------------------------------------------------------------------------------------------
AABB::AABB(Value xv, Value yv, Value zv) noexcept
    : min(xv, yv, zv)
    , max(xv, yv, zv)
{
    /* ... */
}

// ------------------------------------------------------------------------------------------------
AABB::AABB(Value xmin, Value ymin, Value zmin, Value xmax, Value ymax, Value zmax) noexcept
    : min(xmin, ymin, zmin), max(xmax, ymax, zmax)
{
    /* ... */
}

// ------------------------------------------------------------------------------------------------
AABB::AABB(const Vector3 & vmin, const Vector3 & vmax) noexcept
    : min(vmin), max(vmax)
{
    /* ... */
}

// ------------------------------------------------------------------------------------------------
AABB & AABB::operator = (const Vector3 & v)
{
    DefineVector3(v);
    return *this;
}

// ------------------------------------------------------------------------------------------------
AABB & AABB::operator += (const AABB & b)
{
    min += b.min;
    max += b.max;
    return *this;
}

// ------------------------------------------------------------------------------------------------
AABB & AABB::operator -= (const AABB & b)
{
    min -= b.min;
    max -= b.max;
    return *this;
}

// ------------------------------------------------------------------------------------------------
AABB & AABB::operator *= (const AABB & b)
{
    min *= b.min;
    max *= b.max;
    return *this;
}

// ------------------------------------------------------------------------------------------------
AABB & AABB::operator /= (const AABB & b)
{
    min /= b.min;
    max /= b.max;
    return *this;
}

// ------------------------------------------------------------------------------------------------
AABB & AABB::operator %= (const AABB & b)
{
    min %= b.min;
    max %= b.max;
    return *this;
}

// ------------------------------------------------------------------------------------------------
AABB & AABB::operator += (Value s)
{
    min += s;
    max += s;
    return *this;
}

// ------------------------------------------------------------------------------------------------
AABB & AABB::operator -= (Value s)
{
    min -= s;
    max -= s;
    return *this;
}

// ------------------------------------------------------------------------------------------------
AABB & AABB::operator *= (Value s)
{
    min *= s;
    max *= s;
    return *this;
}

// ------------------------------------------------------------------------------------------------
AABB & AABB::operator /= (Value s)
{
    min /= s;
    max /= s;
    return *this;
}

// ------------------------------------------------------------------------------------------------
AABB & AABB::operator %= (Value s)
{
    min %= s;
    max %= s;
    return *this;
}

// ------------------------------------------------------------------------------------------------
AABB & AABB::operator ++ ()
{
    ++min;
    ++max;
    return *this;
}

// ------------------------------------------------------------------------------------------------
AABB & AABB::operator -- ()
{
    --min;
    --max;
    return *this;
}

// ------------------------------------------------------------------------------------------------
AABB AABB::operator ++ (int) // NOLINT(cert-dcl21-cpp)
{
    AABB state(*this);
    ++min;
    ++max;
    return state;
}

// ------------------------------------------------------------------------------------------------
AABB AABB::operator -- (int) // NOLINT(cert-dcl21-cpp)
{
    AABB state(*this);
    --min;
    --max;
    return state;
}

// ------------------------------------------------------------------------------------------------
AABB AABB::operator + (const AABB & b) const
{
    return {min + b.min, max + b.max};
}

// ------------------------------------------------------------------------------------------------
AABB AABB::operator - (const AABB & b) const
{
    return AABB{min - b.min, max - b.max};
}

// ------------------------------------------------------------------------------------------------
AABB AABB::operator * (const AABB & b) const
{
    return AABB{min * b.min, max * b.max};
}

// ------------------------------------------------------------------------------------------------
AABB AABB::operator / (const AABB & b) const
{
    return AABB{min / b.min, max / b.max};
}

// ------------------------------------------------------------------------------------------------
AABB AABB::operator % (const AABB & b) const
{
    return AABB{min % b.min, max % b.max};
}

// ------------------------------------------------------------------------------------------------
AABB AABB::operator + (Value s) const
{
    return AABB{min + s, max + s};
}

// ------------------------------------------------------------------------------------------------
AABB AABB::operator - (Value s) const
{
    return AABB{min - s, max - s};
}

// ------------------------------------------------------------------------------------------------
AABB AABB::operator * (Value s) const
{
    return AABB{min * s, max * s};
}

// ------------------------------------------------------------------------------------------------
AABB AABB::operator / (Value s) const
{
    return AABB{min / s, max / s};
}

// ------------------------------------------------------------------------------------------------
AABB AABB::operator % (Value s) const
{
    return AABB{min % s, max % s};
}

// ------------------------------------------------------------------------------------------------
AABB AABB::operator + () const
{
    return AABB{min.Abs(), max.Abs()};
}

// ------------------------------------------------------------------------------------------------
AABB AABB::operator - () const
{
    return AABB{-min, -max};
}

// ------------------------------------------------------------------------------------------------
bool AABB::operator == (const AABB & b) const
{
    return (min == b.min) && (max == b.max);
}

// ------------------------------------------------------------------------------------------------
bool AABB::operator != (const AABB & b) const
{
    return (min != b.min) || (max != b.max);
}

// ------------------------------------------------------------------------------------------------
bool AABB::operator < (const AABB & b) const
{
    return (min < b.min) && (max < b.max);
}

// ------------------------------------------------------------------------------------------------
bool AABB::operator > (const AABB & b) const
{
    return (min > b.min) && (max > b.max);
}

// ------------------------------------------------------------------------------------------------
bool AABB::operator <= (const AABB & b) const
{
    return (min <= b.min) && (max <= b.max);
}

// ------------------------------------------------------------------------------------------------
bool AABB::operator >= (const AABB & b) const
{
    return (min >= b.min) && (max >= b.max);
}

// ------------------------------------------------------------------------------------------------
int32_t AABB::Cmp(const AABB & o) const
{
    if (*this == o)
    {
        return 0;
    }
    else if (*this > o)
    {
        return 1;
    }
    else
    {
        return -1;
    }
}

// ------------------------------------------------------------------------------------------------
String AABB::ToString() const
{
    return fmt::format("{},{},{},{},{},{}", min.x, min.y, min.z, max.x, max.y, max.z);
}

// ------------------------------------------------------------------------------------------------
void AABB::SetStr(SQChar delim, StackStrF & values)
{
    DefineAABB(AABB::GetEx(delim, values));
}

// ------------------------------------------------------------------------------------------------
void AABB::Clear()
{
    min.SetVector3Ex(HUGE_VALF, HUGE_VALF, HUGE_VALF);
    max.SetVector3Ex(-HUGE_VALF, -HUGE_VALF, -HUGE_VALF);
}

// ------------------------------------------------------------------------------------------------
void AABB::DefineScalar(Value mins, Value maxs)
{
    min.SetVector3Ex(mins, mins, mins);
    max.SetVector3Ex(maxs, maxs, maxs);
}

// ------------------------------------------------------------------------------------------------
void AABB::DefineVector3(const Vector3 & point)
{
    min = max = point;
}

// ------------------------------------------------------------------------------------------------
void AABB::DefineVector3Ex(Value x, Value y, Value z)
{
    min.SetVector3Ex(x, y, z);
    max.SetVector3Ex(x, y, z);
}

// ------------------------------------------------------------------------------------------------
void AABB::DefineAllVector3(const Vector3 & nmin, const Vector3 & nmax)
{
    min = nmin;
    max = nmax;
}

// ------------------------------------------------------------------------------------------------
void AABB::DefineAllVector3Ex(Value xmin, Value ymin, Value zmin, Value xmax, Value ymax, Value zmax)
{
    min.SetVector3Ex(xmin, ymin, zmin);
    max.SetVector3Ex(xmax, ymax, zmax);
}

// ------------------------------------------------------------------------------------------------
void AABB::DefineAABB(const AABB & box)
{
    min = box.min;
    max = box.max;
}

// ------------------------------------------------------------------------------------------------
void AABB::DefineSphere(const Sphere & sphere)
{
    min = sphere.pos + Vector3(-sphere.rad);
    max = sphere.pos + Vector3(sphere.rad);
}

// ------------------------------------------------------------------------------------------------
void AABB::DefineSphereEx(Value x, Value y, Value z, Value r)
{
    DefineSphere(Sphere(x, y, z, r));
}

// ------------------------------------------------------------------------------------------------
void AABB::MergeVector3(const Vector3 & point)
{
    MergeVector3Ex(point.x, point.y, point.z);
}

// ------------------------------------------------------------------------------------------------
void AABB::MergeVector3Ex(Value x, Value y, Value z)
{
    if (x < min.x)
    {
        min.x = x;
    }
    if (y < min.y)
    {
        min.y = y;
    }
    if (z < min.z)
    {
        min.z = z;
    }
    if (x > max.x)
    {
        max.x = x;
    }
    if (y > max.y)
    {
        max.y = y;
    }
    if (z > max.z)
    {
        max.z = z;
    }
}

// ------------------------------------------------------------------------------------------------
void AABB::MergeAABB(const AABB & box)
{
    if (box.min.x < min.x)
    {
        min.x = box.min.x;
    }
    if (box.min.y < min.y)
    {
        min.y = box.min.y;
    }
    if (box.min.z < min.z)
    {
        min.z = box.min.z;
    }
    if (box.max.x > max.x)
    {
        max.x = box.max.x;
    }
    if (box.max.y > max.y)
    {
        max.y = box.max.y;
    }
    if (box.max.z > max.z)
    {
        max.z = box.max.z;
    }
}

// ------------------------------------------------------------------------------------------------
void AABB::MergeAABBEx(Value xmin, Value ymin, Value zmin, Value xmax, Value ymax, Value zmax)
{
    if (xmin < min.x)
    {
        min.x = xmin;
    }
    if (ymin < min.y)
    {
        min.y = ymin;
    }
    if (zmin < min.z)
    {
        min.z = zmin;
    }
    if (xmax > max.x)
    {
        max.x = xmax;
    }
    if (ymax > max.y)
    {
        max.y = ymax;
    }
    if (zmax > max.z)
    {
        max.z = zmax;
    }
}

// ------------------------------------------------------------------------------------------------
void AABB::MergeSphere(const Sphere & sphere)
{
    MergeVector3(sphere.pos + Vector3(sphere.rad));
    MergeVector3(sphere.pos + Vector3(-sphere.rad));
}

// ------------------------------------------------------------------------------------------------
void AABB::MergeSphereEx(Value x, Value y, Value z, Value r)
{
    MergeSphere(Sphere(x, y, z, r));
}

// ------------------------------------------------------------------------------------------------
bool AABB::Empty() const
{
    return (min == max);
}

// ------------------------------------------------------------------------------------------------
bool AABB::Defined() const
{
    return min.x != HUGE_VALF;
}

// ------------------------------------------------------------------------------------------------
Vector3 AABB::Center() const
{
    return (max + min) * 0.5f;
}

// ------------------------------------------------------------------------------------------------
Vector3 AABB::Size() const
{
    return max - min;
}

// ------------------------------------------------------------------------------------------------
Vector3 AABB::HalfSize() const
{
    return (max - min) * 0.5f;
}

// ------------------------------------------------------------------------------------------------
AABB::Value AABB::Radius() const
{
    return Size().GetLength() / Value(2);
}

// ------------------------------------------------------------------------------------------------
AABB::Value AABB::Volume() const
{
    const Vector3 v = Size();
    return static_cast< Value >(v.x * v.y * v.z);
}

// ------------------------------------------------------------------------------------------------
AABB::Value AABB::Area() const
{
    const Vector3 v = Size();
    return static_cast< Value >(Value(2) * (v.x * v.y + v.x * v.z + v.y * v.z));
}

// ------------------------------------------------------------------------------------------------
int32_t AABB::IsVector3Inside(const Vector3 & point) const
{
    return (point.x < min.x || point.x > max.x ||
            point.y < min.y || point.y > max.y ||
            point.z < min.z || point.z > max.z) ? SQMODI_OUTSIDE : SQMODI_INSIDE;
}

// ------------------------------------------------------------------------------------------------
int32_t AABB::IsVector3InsideEx(Value x, Value y, Value z) const
{
    return (x < min.x || x > max.x ||
            y < min.y || y > max.y ||
            z < min.z || z > max.z) ? SQMODI_OUTSIDE : SQMODI_INSIDE;
}

// ------------------------------------------------------------------------------------------------
int32_t AABB::IsAABBInside(const AABB & box) const
{
    if (box.max.x < min.x || box.min.x > max.x ||
        box.max.y < min.y || box.min.y > max.y ||
        box.max.z < min.z || box.min.z > max.z)
    {
        return SQMODI_OUTSIDE;
    }
    else if (box.min.x < min.x || box.max.x > max.x ||
             box.min.y < min.y || box.max.y > max.y ||
             box.min.z < min.z || box.max.z > max.z)
    {
        return SQMODI_INTERSECTS;
    }
    else
    {
        return SQMODI_INSIDE;
    }
}

// ------------------------------------------------------------------------------------------------
int32_t AABB::IsAABBInsideEx(Value xmin, Value ymin, Value zmin, Value xmax, Value ymax, Value zmax) const
{
    if (xmax < min.x || xmin > max.x ||
        ymax < min.y || ymin > max.y ||
        zmax < min.z || zmin > max.z)
    {
        return SQMODI_OUTSIDE;
    }
    else if (xmin < min.x || xmax > max.x ||
             ymin < min.y || ymax > max.y ||
             zmin < min.z || zmax > max.z)
    {
        return SQMODI_INTERSECTS;
    }
    else
    {
        return SQMODI_INSIDE;
    }
}

// ------------------------------------------------------------------------------------------------
int32_t AABB::IsAABBInsideFast(const AABB & box) const
{
    if (box.max.x < min.x || box.min.x > max.x ||
        box.max.y < min.y || box.min.y > max.y ||
        box.max.z < min.z || box.min.z > max.z)
    {
        return SQMODI_OUTSIDE;
    }
    else
    {
        return SQMODI_INSIDE;
    }
}

// ------------------------------------------------------------------------------------------------
int32_t AABB::IsAABBInsideFastEx(Value xmin, Value ymin, Value zmin, Value xmax, Value ymax, Value zmax) const
{
    if (xmax < min.x || xmin > max.x ||
        ymax < min.y || ymin > max.y ||
        zmax < min.z || zmin > max.z)
    {
        return SQMODI_OUTSIDE;
    }
    else
    {
        return SQMODI_INSIDE;
    }
}

// ------------------------------------------------------------------------------------------------
int32_t AABB::IsSphereInside(const Sphere & sphere) const
{
    Value dist_squared = 0, temp;
    const Vector3 & center = sphere.pos;

    if (center.x < min.x)
    {
        temp = center.x - min.x;
        dist_squared += temp * temp;
    }
    else if (center.x > max.x)
    {
        temp = center.x - max.x;
        dist_squared += temp * temp;
    }
    if (center.y < min.y)
    {
        temp = center.y - min.y;
        dist_squared += temp * temp;
    }
    else if (center.y > max.y)
    {
        temp = center.y - max.y;
        dist_squared += temp * temp;
    }
    if (center.z < min.z)
    {
        temp = center.z - min.z;
        dist_squared += temp * temp;
    }
    else if (center.z > max.z)
    {
        temp = center.z - max.z;
        dist_squared += temp * temp;
    }

    const Value radius = sphere.rad;

    if (dist_squared >= radius * radius)
    {
        return SQMODI_OUTSIDE;
    }
    else if (center.x - radius < min.x || center.x + radius > max.x || center.y - radius < min.y ||
             center.y + radius > max.y || center.z - radius < min.z || center.z + radius > max.z)
    {
        return SQMODI_INTERSECTS;
    }
    else
    {
        return SQMODI_INSIDE;
    }
}

// ------------------------------------------------------------------------------------------------
int32_t AABB::IsSphereInsideEx(Value x, Value y, Value z, Value r) const
{
    return IsSphereInside(Sphere(x, y, z, r));
}


// ------------------------------------------------------------------------------------------------
int32_t AABB::IsSphereInsideFast(const Sphere & sphere) const
{
    Value dist_squared = 0, temp;
    const Vector3& center = sphere.pos;

    if (center.x < min.x)
    {
        temp = center.x - min.x;
        dist_squared += temp * temp;
    }
    else if (center.x > max.x)
    {
        temp = center.x - max.x;
        dist_squared += temp * temp;
    }
    if (center.y < min.y)
    {
        temp = center.y - min.y;
        dist_squared += temp * temp;
    }
    else if (center.y > max.y)
    {
        temp = center.y - max.y;
        dist_squared += temp * temp;
    }
    if (center.z < min.z)
    {
        temp = center.z - min.z;
        dist_squared += temp * temp;
    }
    else if (center.z > max.z)
    {
        temp = center.z - max.z;
        dist_squared += temp * temp;
    }

    const Value radius = sphere.rad;

    if (dist_squared >= radius * radius)
    {
        return SQMODI_OUTSIDE;
    }
    else
    {
        return SQMODI_INSIDE;
    }
}

// ------------------------------------------------------------------------------------------------
int32_t AABB::IsSphereInsideFastEx(Value x, Value y, Value z, Value r) const
{
    return IsSphereInsideFast(Sphere(x, y, z, r));
}

// ------------------------------------------------------------------------------------------------
String AABB::Format(StackStrF & str) const
{
    return fmt::format(fmt::runtime(str.ToStr())
        , fmt::arg("min_x", min.x)
        , fmt::arg("min_y", min.y)
        , fmt::arg("min_z", min.z)
        , fmt::arg("max_x", max.x)
        , fmt::arg("max_y", max.y)
        , fmt::arg("max_z", max.z)
    );
}

// ------------------------------------------------------------------------------------------------
const AABB & AABB::Get(StackStrF & str)
{
    return AABB::GetEx(AABB::Delim, str);
}

// ------------------------------------------------------------------------------------------------
const AABB & AABB::GetEx(SQChar delim, StackStrF & str)
{
    static AABB box;
    // Clear previous values, if any
    box.Clear();
    // Is the specified string empty?
    if (str.mLen <= 0)
    {
        return box; // Return the value as is!
    }
    // The format specifications that will be used to scan the string
    SQChar fs[] = _SC(" %f , %f , %f , %f , %f , %f ");
    // Assign the specified delimiter
    fs[4] = delim;
    fs[9] = delim;
    fs[14] = delim;
    fs[19] = delim;
    fs[24] = delim;
    // Attempt to extract the component values from the specified string
    std::sscanf(str.mPtr, fs, &box.min.x, &box.min.y, &box.min.z, &box.max.x, &box.max.y, &box.max.z);
    // Return the resulted value
    return box;
}

// ================================================================================================
void Register_AABB(HSQUIRRELVM vm)
{
    typedef AABB::Value Val;

    RootTable(vm).Bind(Typename::Str,
        Class< AABB >(vm, Typename::Str)
        // Constructors
        .Ctor()
        .Ctor< const AABB & >()
        .Ctor< Val, Val, Val >()
        .Ctor< Val, Val, Val, Val, Val, Val >()
        .Ctor< const Vector3 &, const Vector3 & >()
        // Member Variables
        .Var(_SC("min"), &AABB::min)
        .Var(_SC("max"), &AABB::max)
        .Var(_SC("Min"), &AABB::min)
        .Var(_SC("Max"), &AABB::max)
        // Core Meta-methods
        .SquirrelFunc(_SC("cmp"), &SqDynArgFwd< SqDynArgCmpFn< AABB >, SQFloat, SQInteger, bool, std::nullptr_t, AABB >)
        .SquirrelFunc(_SC("_typename"), &Typename::Fn)
        .Func(_SC("_tostring"), &AABB::ToString)
        // Meta-methods
        .SquirrelFunc(_SC("_add"), &SqDynArgFwd< SqDynArgAddFn< AABB >, SQFloat, SQInteger, bool, std::nullptr_t, AABB >)
        .SquirrelFunc(_SC("_sub"), &SqDynArgFwd< SqDynArgSubFn< AABB >, SQFloat, SQInteger, bool, std::nullptr_t, AABB >)
        .SquirrelFunc(_SC("_mul"), &SqDynArgFwd< SqDynArgMulFn< AABB >, SQFloat, SQInteger, bool, std::nullptr_t, AABB >)
        .SquirrelFunc(_SC("_div"), &SqDynArgFwd< SqDynArgDivFn< AABB >, SQFloat, SQInteger, bool, std::nullptr_t, AABB >)
        .SquirrelFunc(_SC("_modulo"), &SqDynArgFwd< SqDynArgModFn< AABB >, SQFloat, SQInteger, bool, std::nullptr_t, AABB >)
        .Func< AABB (AABB::*)(void) const >(_SC("_unm"), &AABB::operator -)
        // Properties
        .Prop(_SC("Empty"), &AABB::Empty)
        .Prop(_SC("Defined"), &AABB::Defined)
        .Prop(_SC("Center"), &AABB::Center)
        .Prop(_SC("Size"), &AABB::Size)
        .Prop(_SC("Extent"), &AABB::Size)
        .Prop(_SC("HalfSize"), &AABB::HalfSize)
        .Prop(_SC("HalfExtent"), &AABB::HalfSize)
        .Prop(_SC("Radius"), &AABB::Radius)
        .Prop(_SC("Volume"), &AABB::Volume)
        .Prop(_SC("Area"), &AABB::Area)
        // Member Methods
        .FmtFunc(_SC("SetStr"), &AABB::SetStr)
        .Func(_SC("Clear"), &AABB::Clear)
        .FmtFunc(_SC("Format"), &AABB::Format)
        .Func(_SC("DefineScalar"), &AABB::DefineScalar)
        .Func(_SC("DefineVector3"), &AABB::DefineVector3)
        .Func(_SC("DefineVector3Ex"), &AABB::DefineVector3Ex)
        .Func(_SC("DefineAllVector3"), &AABB::DefineAllVector3)
        .Func(_SC("DefineAllVector3Ex"), &AABB::DefineAllVector3Ex)
        .Func(_SC("DefineAABB"), &AABB::DefineAABB)
        .Func(_SC("DefineSphere"), &AABB::DefineSphere)
        .Func(_SC("DefineSphereEx"), &AABB::DefineSphereEx)
        .Func(_SC("MergeVector3"), &AABB::MergeVector3)
        .Func(_SC("MergeVector3Ex"), &AABB::MergeVector3Ex)
        .Func(_SC("MergeAABB"), &AABB::MergeAABB)
        .Func(_SC("MergeAABBEx"), &AABB::MergeAABBEx)
        .Func(_SC("MergeSphere"), &AABB::MergeSphere)
        .Func(_SC("MergeSphereEx"), &AABB::MergeSphereEx)
        .Func(_SC("IsVector3Inside"), &AABB::IsVector3Inside)
        .Func(_SC("IsVector3InsideEx"), &AABB::IsVector3InsideEx)
        .Func(_SC("IsAABBInside"), &AABB::IsAABBInside)
        .Func(_SC("IsAABBInsideEx"), &AABB::IsAABBInsideEx)
        .Func(_SC("IsAABBInsideFast"), &AABB::IsAABBInsideFast)
        .Func(_SC("IsAABBInsideFastEx"), &AABB::IsAABBInsideFastEx)
        .Func(_SC("IsSphereInside"), &AABB::IsSphereInside)
        .Func(_SC("IsSphereInsideEx"), &AABB::IsSphereInsideEx)
        .Func(_SC("IsSphereInsideFast"), &AABB::IsSphereInsideFast)
        .Func(_SC("IsSphereInsideFastEx"), &AABB::IsSphereInsideFastEx)
        // Static Functions
        .StaticFunc(_SC("GetDelimiter"), &SqGetDelimiter< AABB >)
        .StaticFunc(_SC("SetDelimiter"), &SqSetDelimiter< AABB >)
        .StaticFmtFunc(_SC("FromStr"), &AABB::Get)
        .StaticFmtFunc(_SC("FromStrEx"), &AABB::GetEx)
    );
}

} // Namespace:: SqMod