targetonpath.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.
*/

// primary contact: LAPA - secondary contact: NOBODY
#ifndef Navigation_TargetOnPath_H
#define Navigation_TargetOnPath_H

#include "gwnavruntime/path/positiononlivepath.h"
#include "gwnavruntime/database/database.h"
#include "gwnavruntime/world/bot.h"


namespace Kaim 
{

enum TargetOnPathStatus
{
    TargetOnPathNotInitialized = 0,

    TargetOnPathUnknownReachability,

    TargetOnPathInInvalidNavData,

    TargetOnPathNotReachable,

    TargetOnPathReachable
};
KY_INLINE const char* GetTargetOnPathStatusDescription(TargetOnPathStatus status)
{
    switch (status)
    {
    case TargetOnPathNotInitialized:      return "NotInitialized";
    case TargetOnPathUnknownReachability: return "UnknownReachability";
    case TargetOnPathInInvalidNavData:    return "InInvalidNavData";
    case TargetOnPathNotReachable:        return "NotReachable";
    case TargetOnPathReachable:           return "Reachable";
    }
    return "Undefined";
}

class TargetOnPath
{
public:
    TargetOnPath() { Clear(); }

    void Clear()
    {
        m_positionOnLivePath.Clear();
        m_status = TargetOnPathNotInitialized;
        m_marginMode = NoMargin;
        m_nextShortcutSqDistTrigger = -1.f;
    }

    bool IsTargetNotReachableOnNavMesh(const Bot* bot) const
    {
        return ((m_positionOnLivePath.GetPositionOnPathStatus() == PositionOnPathStatus_Undefined) ||
            ((m_status == TargetOnPathNotReachable) &&
            (m_positionOnLivePath.GetEdgeTypeToMoveOnBackward() == Kaim::PathEdgeType_OnNavMesh) &&
            (bot->GetNavTrianglePtr().IsValid() == true) &&
            (bot->GetProgressOnLivePathStatus() == ProgressOnPathOnNavMesh)));
    }

public:
    // ----- State members -----
    PositionOnLivePath m_positionOnLivePath;
    TargetOnPathStatus m_status;

    // ----- Computation members -----
    RayCanGoMarginMode m_marginMode; // margin to use to validate the TargetOnPath
    KyFloat32 m_nextShortcutSqDistTrigger; // distance used to trigger a new computation of the target, it is updated when recomputing the target
};

}

#endif