pathfinderquerytrycangomode.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/base/types.h"

namespace Kaim {

class LogicWithNoCustomCost;
class LogicWithCostPerNavTag;
class LogicWithCostPerTriangle;

enum PathFinderQueryTryCanGoMode
{
    PATHFINDER_TRY_RAYCANGO_IF_NO_COST = 0,

    PATHFINDER_NEVER_TRY_RAYCANGO = 1,

    // This will give different results than a regular propagation when the TraverseLogic uses costs. When in doubt use PATHFINDER_TRY_RAYCANGO_IF_NO_COST.
    PATHFINDER_ALWAYS_TRY_RAYCANGO = 2,
};

inline bool ShouldTryCanGo(const PathFinderQueryTryCanGoMode& mode, bool traverse_logic_try_can_go)
{
KY_PUSH_ERROR_ON_MISSING_EXPLICIT_CASE_LABEL
    switch (mode)
    {
    case PATHFINDER_NEVER_TRY_RAYCANGO:
        return false;

    case PATHFINDER_ALWAYS_TRY_RAYCANGO:
        return true;

    case PATHFINDER_TRY_RAYCANGO_IF_NO_COST:
        return traverse_logic_try_can_go;

    default:
        return traverse_logic_try_can_go;
    }
KY_POP_ERROR_ON_MISSING_EXPLICIT_CASE_LABEL
}
inline bool ShouldTryCanGo(const PathFinderQueryTryCanGoMode& mode, const LogicWithNoCustomCost&)         { return ShouldTryCanGo(mode, true); }
inline bool ShouldTryCanGo(const PathFinderQueryTryCanGoMode& mode, const LogicWithCostPerNavTag&)   { return ShouldTryCanGo(mode, false); }
inline bool ShouldTryCanGo(const PathFinderQueryTryCanGoMode& mode, const LogicWithCostPerTriangle&) { return ShouldTryCanGo(mode, false); }

typedef KY_DEPRECATED(PathFinderQueryTryCanGoMode AStarQueryTryCanGoMode); // AStarQueryTryCanGoMode is deprecated since 2.17.0, use PathFinderQueryTryCanGoMode instead
typedef KY_DEPRECATED(PathFinderQueryTryCanGoMode MultiDestinationPathFinderTryCanGoMode); // MultiDestinationPathFinderTryCanGoMode is deprecated since 2.17.0, use PathFinderQueryTryCanGoMode instead


}