tetrees/Plugins/Wwise/Source/AkAudio/Classes/GTE/Mathematics/Segment.h

// David Eberly, Geometric Tools, Redmond WA 98052
// Copyright (c) 1998-2020
// Distributed under the Boost Software License, Version 1.0.
// https://www.boost.org/LICENSE_1_0.txt
// https://www.geometrictools.com/License/Boost/LICENSE_1_0.txt
// Version: 4.0.2019.08.13

#pragma once

#include <Mathematics/Vector.h>

// The segment is represented by (1-t)*P0 + t*P1, where P0 and P1 are the
// endpoints of the segment and 0 <= t <= 1.  Some algorithms prefer a
// centered representation that is similar to how oriented bounding boxes are
// defined.  This representation is C + s*D, where C = (P0 + P1)/2 is the
// center of the segment, D = (P1 - P0)/|P1 - P0| is a unit-length direction
// vector for the segment, and |t| <= e.  The value e = |P1 - P0|/2 is the
// extent (or radius or half-length) of the segment.

namespace WwiseGTE
{
    template <int N, typename Real>
    class Segment
    {
    public:
        // Construction and destruction.  The default constructor sets p0 to
        // (-1,0,...,0) and p1 to (1,0,...,0).  NOTE:  If you set p0 and p1;
        // compute C, D, and e; and then recompute q0 = C-e*D and q1 = C+e*D,
        // numerical round-off errors can lead to q0 not exactly equal to p0
        // and q1 not exactly equal to p1.
        Segment()
        {
            p[1].MakeUnit(0);
            p[0] = -p[1];
        }

        Segment(Vector<N, Real> const& p0, Vector<N, Real> const& p1)
            :
            p{ p0, p1 }
        {
        }

        Segment(std::array<Vector<N, Real>, 2> const& inP)
            :
            p(inP)
        {
        }

        Segment(Vector<N, Real> const& center, Vector<N, Real> const& direction, Real extent)
        {
            SetCenteredForm(center, direction, extent);
        }

        // Manipulation via the centered form.
        void SetCenteredForm(Vector<N, Real> const& center,
            Vector<N, Real> const& direction, Real extent)
        {
            p[0] = center - extent * direction;
            p[1] = center + extent * direction;
        }

        void GetCenteredForm(Vector<N, Real>& center,
            Vector<N, Real>& direction, Real& extent) const
        {
            center = (Real)0.5 * (p[0] + p[1]);
            direction = p[1] - p[0];
            extent = (Real)0.5 * Normalize(direction);
        }

        // Public member access.
        std::array<Vector<N, Real>, 2> p;

    public:
        // Comparisons to support sorted containers.
        bool operator==(Segment const& segment) const
        {
            return p == segment.p;
        }

        bool operator!=(Segment const& segment) const
        {
            return p != segment.p;
        }

        bool operator< (Segment const& segment) const
        {
            return p < segment.p;
        }

        bool operator<=(Segment const& segment) const
        {
            return p <= segment.p;
        }

        bool operator> (Segment const& segment) const
        {
            return p > segment.p;
        }

        bool operator>=(Segment const& segment) const
        {
            return p >= segment.p;
        }
    };

    // Template aliases for convenience.
    template <typename Real>
    using Segment2 = Segment<2, Real>;

    template <typename Real>
    using Segment3 = Segment<3, Real>;
}