funnel.h

Go to the documentation of this file.

/*
* Copyright 2015 Autodesk, Inc. All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
* or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
*/

#ifndef Navigation_Funnel_H
#define Navigation_Funnel_H

#include "gwnavruntime/math/vec2f.h"


namespace Kaim
{

enum FunnelDirection
{
    ForwardFunnel,
    BackwardFunnel
};

enum FunnelResult
{
    FunnelError,           // The funnel failed to update with the last provided corner.
    FunnelIgnored,         // The last provided corner has been ignored (e.g. it lays inside the apex bubble).
    FunnelUnchanged,       // The last provided corner did not change the funnel (e.g. a right corner on the right of the current left-most right corner).
    FunnelTightened,       // The last provided corner has tighten the funnel (e.g. a right corner that lay on the left of the former left-most right corner and on the right of the current right-most left corner, that is now the new left-most right corner).
    FunnelClosedOverRight, // The last provided corner has closed the funnel over its left-most right corner.
    FunnelClosedOverLeft   // The last provided corner has closed the funnel over its right-most left corner.
};
KY_INLINE static bool IsClosureCase(FunnelResult result) { return ((result == FunnelClosedOverRight) || (result == FunnelClosedOverLeft)); }

enum FunnelSide
{
    UndefinedFunnelSide,
    FunnelLeft,
    FunnelRight,
    FunnelBothSides // start and end corners are collapsed and impact both sides of the funnel.
};


class Funnel
{
public:
    Funnel()
        : m_apexIdx(0)
        , m_leftCornerIdx(0)
        , m_rightCornerIdx(0)
        , m_apexSide(UndefinedFunnelSide)
        , m_funnelDirection(ForwardFunnel)
        , m_previousResult(FunnelUnchanged)
        , m_isLeftBorderInitialized(false)
        , m_isRightBorderInitialized(false)
    {}

    void Initialize(KyUInt32 apexIdx, FunnelSide apexSide, FunnelDirection funnelDirection = ForwardFunnel);
    FunnelResult Update(const Vec2f& vecToCorner, KyUInt32 idx, FunnelSide side);

    FunnelDirection GetFunnelDirection() const { return m_funnelDirection; }
    KyUInt32        GetApexIdx()         const { return m_apexIdx;         }
    FunnelSide      GetApexSide()        const { return m_apexSide;        }
    KyUInt32        GetLeftCornerIdx()   const { return m_leftCornerIdx;   }
    KyUInt32        GetRightCornerIdx()  const { return m_rightCornerIdx;  }
    FunnelResult    GetPreviousResult()  const { return m_previousResult;  }

private:
    void TightenLeftBorder(const Vec2f& vecToCorner, KyUInt32 cornerIdx);
    void TightenRightBorder(const Vec2f& vecToCorner, KyUInt32 cornerIdx);

    bool IsOutsideOnLeft(const Vec2f& axis2d) const;
    bool IsOutsideOnRight(const Vec2f& axis2d) const;

    void ResolveActualClosureCase(FunnelResult naturalClosure);


private:
    Vec2f m_vec2dToLeft;
    Vec2f m_vec2dToRight;

    KyUInt32 m_apexIdx;
    KyUInt32 m_leftCornerIdx;
    KyUInt32 m_rightCornerIdx;

    FunnelSide m_apexSide;
    FunnelDirection m_funnelDirection;

    FunnelResult m_previousResult;

    bool m_isLeftBorderInitialized;
    bool m_isRightBorderInitialized;
};


} // namespace Kaim

#endif // Navigation_Funnel_H