gamekitcrowddispersion.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 "gwnavgamekit/gamekitnavtag.h"

#include "gwnavruntime/math/vec3f.h"
#include "gwnavruntime/kernel/SF_RefCount.h"
#include "gwnavruntime/kernel/SF_Hash.h"
#include "gwnavruntime/containers/circulararray.h"

namespace Kaim
{

class NavGraphBlob;
class NavGraphEdgeRawPtr;
class TagVolume;
class GameKitNavTag;
class NavData;
class DisplayList;

class GameKitCrowdDispersionInput
{
public:
    GameKitCrowdDispersionInput() : m_botSpeed(-1.f) {}
    GameKitCrowdDispersionInput(const Vec3f& botPosition, KyFloat32 botSpeed) : m_botPosition(botPosition), m_botSpeed(botSpeed) {}
public:
    Vec3f m_botPosition;
    KyFloat32 m_botSpeed;
};

// Count the number of bots depending on their distance to a position
class GameKitCrowdDispersionNavTagInfo : public RefCountBase<GameKitCrowdDispersionNavTagInfo, MemStat_GameKit>
{
    KY_CLASS_WITHOUT_COPY(GameKitCrowdDispersionNavTagInfo)

public:
    GameKitCrowdDispersionNavTagInfo(const Vec3f& position = Vec3f(), KyFloat32 edgeLength = 1.0f, KyUInt32 maxConcurrentBotCount = 1, KyFloat32 m_slotDuration = 0.5f);

    KyUInt32 GetSlotIndex(const GameKitCrowdDispersionInput& input);

    KyFloat32 GetAdditionalCostMultiplier(const GameKitCrowdDispersionInput& input);

    void Register(const GameKitCrowdDispersionInput& input);

    void Unregister(const GameKitCrowdDispersionInput& input);

    KyUInt32 GetSlotCount() const { return m_botCountInSlots.GetCount(); }

    KyFloat32 GetFirstArrivalTime() const { return m_firstArrivalTime; }
    KyUInt32 GetBotCountInSlot(KyUInt32 slotIndex) const { return m_botCountInSlots[slotIndex]; }
    KyUInt32 GetMaxConcurrentBotCount() const { return m_maxConcurrentBotCount; }

    void SendVisualDebug(DisplayList& displayList, const GameKitCrowdDispersionInput& input);

private:
    KyUInt32 m_maxConcurrentBotCount;
    Vec3f m_position;
    KyFloat32 m_smartObjectLength; // only here to return a cost multiplier instead of a plain cost
    KyFloat32 m_slotDuration; // should be a distance

    KyFloat32 m_firstArrivalTime; // gives the arrival time of the first interval (factor of m_slotDuration)
    CircularArray<KyUInt32> m_botCountInSlots;
};


class GameKitCrowdDispersionNavTagId
{
public:
    GameKitCrowdDispersionNavTagId(const GameKitNavTag& navTag = GameKitNavTag());
    GameKitCrowdDispersionNavTagId(const NavTag& navTag);
    GameKitCrowdDispersionNavTagId(const DynamicNavTag& navTag);

    bool operator==(const GameKitCrowdDispersionNavTagId& other) const { return m_layerIndex == other.m_layerIndex && m_smartObjectID == other.m_smartObjectID;}
    bool operator!=(const GameKitCrowdDispersionNavTagId& other) const { return (*this == other) == false;}

    bool IsValid() const { return *this != GameKitCrowdDispersionNavTagId(); }

public:
    KyUInt32 m_layerIndex;
    KyUInt32 m_smartObjectID;
};

class GameKitCrowdDispersionNavTagHashMap : public RefCountBase<GameKitCrowdDispersionNavTagHashMap, MemStat_GameKit>
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_GameKit)

public:
    const Ptr<GameKitCrowdDispersionNavTagInfo> Get(const GameKitCrowdDispersionNavTagId& navTagId) const;
    Ptr<GameKitCrowdDispersionNavTagInfo> Get(const GameKitCrowdDispersionNavTagId& navTagId);
    bool Get(const GameKitCrowdDispersionNavTagId& navTagId, Ptr<GameKitCrowdDispersionNavTagInfo>* crowdDispersionNavTag) const;

    KyResult Add(const TagVolume* tagVolume, Vec3f expectedTraversedPoints[2], KyUInt32 maxConcurrentBotCount = 1, KyFloat32 m_slotDuration = 0.5f);

    KyResult Add(const TagVolume* tagVolume, KyFloat32 length, KyUInt32 maxConcurrentBotCount = 1, KyFloat32 m_slotDuration = 0.5f);

    KyResult Add(const NavGraphEdgeRawPtr& graphEdge, KyUInt32 maxConcurrentBotCount = 1, KyFloat32 m_slotDuration = 0.5f);

    void Add(const NavData* navGraphOnlyNavData, KyUInt32 maxConcurrentBotCount = 1, KyFloat32 m_slotDuration = 0.5f);

    KyResult Add(const GameKitCrowdDispersionNavTagId& navTagId, Ptr<GameKitCrowdDispersionNavTagInfo> navTagCrowdDispersion);
    void Remove(const GameKitCrowdDispersionNavTagId& navTagId);

    void Clear();

public: // internal
    void Add(const NavGraphBlob* navGraphBlob, KyUInt32 maxConcurrentBotCount = 1, KyFloat32 m_slotDuration = 0.5f);

    typedef Hash<GameKitCrowdDispersionNavTagId, Ptr<GameKitCrowdDispersionNavTagInfo> >::ConstIterator ConstIterator;
    ConstIterator Begin() const;
    ConstIterator End() const;

private:
    Hash<GameKitCrowdDispersionNavTagId, Ptr<GameKitCrowdDispersionNavTagInfo> > m_hash;
};

}