gamekitcrowddispersiontraverselogic.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_GameKitCrowdDispersionTraverseLogic_H
#define Navigation_GameKitCrowdDispersionTraverseLogic_H


#include "gwnavgamekit/gamekitcrowddispersion.h"

#include "gwnavruntime/navmesh/traverselogic.h"
#include "gwnavruntime/containers/kyarray.h"
#include "gwnavruntime/kernel/SF_RefCount.h"



namespace Kaim
{

class Bot;
class ScopedDisplayList;
class PositionOnLivePath;

enum GameKitCrowdDispersionLogicAction
{
    GameKitCrowdDispersionLogic_NoAction                = 0, 
    GameKitCrowdDispersionLogic_RecomputePath           = 1, 
    GameKitCrowdDispersionLogic_CancelOutRecomputedPath = 2, 
};

class GameKitCrowdDispersionTraverseLogicData : public RefCountBase<GameKitCrowdDispersionTraverseLogicData, MemStat_GameKit>
{
public:
    GameKitCrowdDispersionTraverseLogicData(GameKitCrowdDispersionNavTagHashMap* crowdDispersionHashMap, KyFloat32 alternativePathCheckDistance, KyFloat32 consideredUsedDistance);
    ~GameKitCrowdDispersionTraverseLogicData();

    void SendVisualDebug(ScopedDisplayList& displayList);

    // Following functions are expected to be called from the logic of the game Bot
    // An example of these functions is made by CrowdDispersionBot::UpdateLogic() in Tutorial_GameKit.cpp

    // Globally update the Data, it _must_ be called each frame!
    GameKitCrowdDispersionLogicAction UpdateBotLogic(Bot* navBot);
    
    // Must be called before recomputing a Path to the same destination, typically when UpdateBotLogic returns GameKitCrowdDispersionLogic_RecomputePath, 
    // or if a followed target moved only slightly so that a new path should continue to consider the choice made so far in terms of dispersion
    void OnBotLogicRecomputePathToSimilarDestination() { UnregisterFromApproachingNavTag(); }
    
    // Must be called before recomputing a Path to a new destination, typically when a new Target is selected by your own Bot logic.
    void OnBotLogicComputePathToBrandNewDestination()  { Clear(); }


private:
    class ApproachingNavTagInfo
    {
    public:
        ApproachingNavTagInfo(const GameKitCrowdDispersionNavTagId& navTagId = GameKitCrowdDispersionNavTagId(), KyFloat32 squareDistance2d = 0.0f);

    public:
        GameKitCrowdDispersionNavTagId m_navTagId;
        KyFloat32 m_squareDistance2d;
    };

    ApproachingNavTagInfo GetApproachingNavTagID(const PositionOnLivePath& progressOnLivePath);

    KyResult RegisterToApproachingNavTag(const GameKitCrowdDispersionNavTagId& navTagID);

    void UseApproachingNavTag();

    void UnregisterFromApproachingNavTag();

    bool WasNavTagIdDiscarded(const GameKitCrowdDispersionNavTagId& navTagID);

    void Clear();

public:
    bool m_triggerAvoidance;
    Ptr<GameKitCrowdDispersionNavTagHashMap> m_crowdDispersionNavTagMap;
    KyFloat32 m_alternativePathCheckDistance;
    KyFloat32 m_consideredUsedDistance;
    GameKitCrowdDispersionInput m_input;
    GameKitCrowdDispersionInput m_registeredApproachingInput;
    GameKitCrowdDispersionNavTagId m_approachingNavTagID;
    bool m_isUsingApproachingNavTagID;
    KyArray<GameKitCrowdDispersionNavTagId> m_discardedNavTagIDs;

};



class GameKitCrowdDispersionTraverseLogic : public TraverseLogicWithCostMultiplerPerNavTag<LogicDoNotUseCanEnterNavTag>
{
public:
    static KyFloat32 GetHeuristicFromDistanceToDest(void* traverseLogicUserData, KyFloat32 distance3DToDestination);

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

};


}

#endif