targetonpath.h

Go to the documentation of this file.

/*
* Copyright 2016 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.
*/

#pragma once

#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)));
    }

    // shortcut to m_positionOnLivePath to make code more readable
    PositionOnLivePath&       PosLive()       { return m_positionOnLivePath; }
    const PositionOnLivePath& PosLive() const { return m_positionOnLivePath; }

    void BindToPathEventList(PathEventList* pathEventList) { m_positionOnLivePath.BindToPathEventList(pathEventList); }

    PathEventList* GetPathEventList() const                      { return m_positionOnLivePath.GetPathEventList(); }

    Path*                 GetPath()                              { return m_positionOnLivePath.GetPath(); }
    const Path*           GetPath() const                        { return m_positionOnLivePath.GetPath(); }
    const Vec3f&          GetPosition() const                    { return m_positionOnLivePath.GetPosition(); }
    const PositionOnPath& GetPositionOnPath() const              { return m_positionOnLivePath.GetPositionOnPath(); }
    PositionOnPathStatus  GetPositionOnPathStatus() const        { return m_positionOnLivePath.GetPositionOnPathStatus(); }
    PathEdgeType          GetPathEdgeType()  const               { return m_positionOnLivePath.GetPathEdgeType(); }
    bool IsAtFirstNodeOfPath() const                             { return m_positionOnLivePath.IsAtFirstNodeOfPath(); }
    bool IsAtLastNodeOfPath()  const                             { return m_positionOnLivePath.IsAtLastNodeOfPath();  }
    bool IsAtFirstEdgeOfPath() const                             { return m_positionOnLivePath.IsAtFirstEdgeOfPath(); }
    bool IsAtLastEdgeOfPath()  const                             { return m_positionOnLivePath.IsAtLastEdgeOfPath();  }
    KyUInt32 GetPathEdgeIndex() const                            { return m_positionOnLivePath.GetPathEdgeIndex(); }
    KyUInt32 GetEdgeIdxToMoveOnForward()  const                  { return m_positionOnLivePath.GetEdgeIdxToMoveOnForward();   }
    PathEdgeType GetEdgeTypeToMoveOnForward()  const             { return m_positionOnLivePath.GetEdgeTypeToMoveOnForward(); }
    PathEdgeType GetEdgeTypeToMoveOnBackward() const             { return m_positionOnLivePath.GetEdgeTypeToMoveOnBackward(); }
    KyUInt32 GetEdgeIdxToMoveOnBackward() const                  { return m_positionOnLivePath.GetEdgeIdxToMoveOnBackward(); }

    OnEventListStatus GetOnEventListStatus() const               { return m_positionOnLivePath.GetOnEventListStatus(); }
    KyUInt32 GetOnEventListIndex() const                         { return m_positionOnLivePath.GetOnEventListIndex(); }

    bool IsAtUpperBoundOfLivePath() const                        { return m_positionOnLivePath.IsAtUpperBoundOfLivePath(); }
    bool IsAtACheckPoint() const                                 { return m_positionOnLivePath.IsAtACheckPoint(); }

    void MoveForward_StopAtCheckPoint(KyFloat32 distanceMove) { m_positionOnLivePath.MoveForward_StopAtCheckPoint(distanceMove); }

    bool IsAtLowerBoundOfLivePath() const { return m_positionOnLivePath.IsAtLowerBoundOfLivePath(); }
    void SetNewPositionOnPathBackward(const PositionOnPath& posPath) { m_positionOnLivePath.SetNewPositionOnPathBackward(posPath); }

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
};

}