GteDistAlignedBox3OrientedBox3.h

Go to the documentation of this file.

// David Eberly, Geometric Tools, Redmond WA 98052
// Copyright (c) 1998-2017
// Distributed under the Boost Software License, Version 1.0.
// http://www.boost.org/LICENSE_1_0.txt
// http://www.geometrictools.com/License/Boost/LICENSE_1_0.txt
// File Version: 3.5.0 (2016/11/26)

#pragma once

#include <Mathematics/GteDCPQuery.h>
#include <Mathematics/GteLCPSolver.h>
#include <Mathematics/GteAlignedBox.h>
#include <Mathematics/GteOrientedBox.h>
#include <Mathematics/GteVector3.h>
#include <Mathematics/GteFunctions.h>

namespace gte
{

template <typename Real>
class DCPQuery<Real, AlignedBox3<Real>, OrientedBox3<Real>>
{
public:
    struct Result
    {
        bool queryIsSuccessful;

        // These members are valid only when queryIsSuccessful is true;
        // otherwise, they are all set to zero.
        Real distance, sqrDistance;
        std::array<Real, 3> box0Parameter, box1Parameter;
        Vector3<Real> closestPoint[2];

        // The number of iterations used by LCPSolver regardless of whether
        // the query is successful.
        int numLCPIterations;
    };

    // The default maximum iterations is 144 (n = 12, maxIterations = n*n).  If
    // the solver fails to converge, try increasing the maximum number of
    // iterations.
    void SetMaxLCPIterations(int maxLCPIterations);

    Result operator()(AlignedBox3<Real> const& box0, OrientedBox3<Real> const& box1);

private:
    LCPSolver<Real, 12> mLCP;
};


template <typename Real>
void DCPQuery<Real, AlignedBox3<Real>, OrientedBox3<Real>>::SetMaxLCPIterations(int maxLCPIterations)
{
    mLCP.SetMaxIterations(maxLCPIterations);
}

template <typename Real>
typename DCPQuery<Real, AlignedBox3<Real>, OrientedBox3<Real>>::Result
    DCPQuery<Real, AlignedBox3<Real>, OrientedBox3<Real>>::operator()(
        AlignedBox3<Real> const& box0, OrientedBox3<Real> const& box1)
{
    Result result;

    // Translate the boxes so that the aligned box becomes a canonical box.
    // Modify the oriented box coefficients to be nonnegative.
    Vector3<Real> K = box0.max - box0.min;
    Vector3<Real> delta = box1.center - box0.min;
    for (int i = 0; i < 3; ++i)
    {
        delta -= box1.extent[i] * box1.axis[i];
    }

    Vector3<Real> rotDelta;
    for (int i = 0; i < 3; ++i)
    {
        rotDelta[i] = Dot(box1.axis[i], delta);
    }

    Vector3<Real> twoExtent = box1.extent * (Real)2;

    // The LCP has 6 variables and 6 (nontrivial) inequality constraints.
    std::array<Real, 12> q =
    {
        -delta[0], -delta[1], -delta[2], rotDelta[0], rotDelta[1], rotDelta[2],
        K[0], K[1], K[2], twoExtent[0], twoExtent[1], twoExtent[2]
    };

    std::array<std::array<Real, 12>, 12> M;
    {
        Real const z = (Real)0;
        Real const p = (Real)1;
        Real const m = (Real)-1;
        Vector3<Real> const& U0 = box1.axis[0];
        Vector3<Real> const& U1 = box1.axis[1];
        Vector3<Real> const& U2 = box1.axis[2];
        M[ 0] = { p, z, z, -U0[0], -U1[0], -U1[2], p, z, z, z, z, z };
        M[ 1] = { z, p, z, -U0[1], -U1[1], -U1[1], z, p, z, z, z, z };
        M[ 2] = { z, z, p, -U0[2], -U1[2], -U1[2], z, z, p, z, z, z };
        M[ 3] = { -U0[0], -U0[1], -U0[2], p, z, z, z, z, z, p, z, z };
        M[ 4] = { -U1[0], -U1[1], -U1[2], z, p, z, z, z, z, z, p, z };
        M[ 5] = { -U2[0], -U2[1], -U2[2], z, z, p, z, z, z, z, z, p };
        M[ 6] = { m, z, z, z, z, z, z, z, z, z, z, z };
        M[ 7] = { z, m, z, z, z, z, z, z, z, z, z, z };
        M[ 8] = { z, z, m, z, z, z, z, z, z, z, z, z };
        M[ 9] = { z, z, z, m, z, z, z, z, z, z, z, z };
        M[10] = { z, z, z, z, m, z, z, z, z, z, z, z };
        M[11] = { z, z, z, z, z, m, z, z, z, z, z, z };
    }

    std::array<Real, 12> w, z;
    if (mLCP.Solve(q, M, w, z))
    {
        result.queryIsSuccessful = true;

        for (int i = 0; i < 3; ++i)
        {
            result.box0Parameter[i] = z[i] + box0.min[i];
            result.closestPoint[0][i] = result.box0Parameter[i];
        }

        result.closestPoint[1] = box1.center;
        for (int i = 0, j = 3; i < 3; ++i, ++j)
        {
            result.box1Parameter[i] = z[j] - box1.extent[i];
            result.closestPoint[1] += result.box1Parameter[i] * box1.axis[i];
        }

        Vector3<Real> diff = result.closestPoint[1] - result.closestPoint[0];
        result.sqrDistance = Dot(diff, diff);
        result.distance = Function<Real>::Sqrt(result.sqrDistance);
    }
    else
    {
        // If you reach this case, the maximum number of iterations was not
        // specified to be large enough or there is a problem due to
        // floating-point rounding errors.  If you believe the latter is
        // true, file a bug report.
        result.queryIsSuccessful = false;

        for (int i = 0; i < 3; ++i)
        {
            result.box0Parameter[i] = (Real)0;
            result.box1Parameter[i] = (Real)0;
            result.closestPoint[0][i] = (Real)0;
            result.closestPoint[1][i] = (Real)0;
        }
        result.distance = (Real)0;
        result.sqrDistance = (Real)0;
    }

    result.numLCPIterations = mLCP.GetNumIterations();
    return result;
}

}