localcostawaretraverselogic.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_LocalCostAwareTraverseLogic_H
#define Navigation_LocalCostAwareTraverseLogic_H


#include "gwnavruntime/database/navtag.h"
#include "gwnavruntime/containers/kyarray.h"
#include "gwnavruntime/kernel/SF_Types.h"


namespace Kaim
{


class LocalCostAwareTraverseLogicData
{
public:
    LocalCostAwareTraverseLogicData() { Clear(); }
    void Clear() { m_userTraverseLogicData = KY_NULL; m_localMaxCostMultiplierOnPath = 1.0f; }
public:
    void* m_userTraverseLogicData;
    KyFloat32 m_localMaxCostMultiplierOnPath; // Cost of most expensive NavTag on path around a given PositionOnPath.
};


template <class UserTraverseLogic>
class LocalCostAwareTraverseLogic
{
    KY_TRAVERSE_LOGIC(LocalCostAwareTraverseLogic, typename UserTraverseLogic::CostMultiplierUsage, typename UserTraverseLogic::CanEnterNavTagMode)
public:
    //--------------------- Wrapping functions ---------------------

    static bool CanTraverseNavTag(void* traverseLogicUserData, const NavTag& navTag);

    static bool CanTraverseNavTag(void* traverseLogicUserData, const NavTag& navTag, KyFloat32* costMultiplier);

    static bool CanTraverseNavTriangle(void* traverseLogicUserData, const NavTriangleRawPtr& triangle, KyFloat32* costmultiplier);
};


template <class UserTraverseLogic>
KY_INLINE bool LocalCostAwareTraverseLogic<UserTraverseLogic>::CanTraverseNavTag(void* traverseLogicUserData, const NavTag& navTag)
{
    // Call directly the "original" UserTraverseLogic::CanTraverseNavTag
    // because UserTraverseLogic::CostMultiplierUsage is LogicWithoutCostMultipler, so there is no cost per NavTag
    void* userTraverseLogicData = ((LocalCostAwareTraverseLogicData*)traverseLogicUserData)->m_userTraverseLogicData;
    return UserTraverseLogic::CanTraverseNavTag(userTraverseLogicData, navTag);
}

template <class UserTraverseLogic>
KY_INLINE bool LocalCostAwareTraverseLogic<UserTraverseLogic>::CanTraverseNavTag(void* traverseLogicUserData, const NavTag& navTag, KyFloat32* output_costMultiplier)
{
    LocalCostAwareTraverseLogicData* localCostAwareTraverseLogicData = (LocalCostAwareTraverseLogicData*)traverseLogicUserData;
    KyFloat32 localCostOnPath    = localCostAwareTraverseLogicData->m_localMaxCostMultiplierOnPath;
    void* userTraverseLogicData  = localCostAwareTraverseLogicData->m_userTraverseLogicData;

    // Call the "original" UserTraverseLogic::CanTraverseNavTag
    KyFloat32 costMultiplier = 1.0f;
    bool canTraverse = UserTraverseLogic::CanTraverseNavTag(userTraverseLogicData, navTag, &costMultiplier);
    if (output_costMultiplier)
        *output_costMultiplier = costMultiplier;

    if (canTraverse == false)
        return false; // if the user original CanTraverse returns false then cannot traverse

    if (costMultiplier > localCostOnPath)
        return false; // if the traversed cost is higher than the localCostOnPath then cannot traverse

    return true;
}

template <class UserTraverseLogic>
KY_INLINE bool LocalCostAwareTraverseLogic<UserTraverseLogic>::CanTraverseNavTriangle(void* traverseLogicUserData, const NavTriangleRawPtr& triangle, KyFloat32* costmultiplier)
{
    LocalCostAwareTraverseLogicData* customTraverseLogicData = (LocalCostAwareTraverseLogicData*)traverseLogicUserData;
    return UserTraverseLogic::CanTraverseNavTriangle(customTraverseLogicData->m_userTraverseLogicData, triangle, costmultiplier);
}

}

#endif