gamekitcrowddispersion.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_GameKitCrowdDispersion_H
#define Navigation_GameKitCrowdDispersion_H

#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 ScopedDisplayList;


class GameKitCrowdDispersionInput
{
public:
    GameKitCrowdDispersionInput() : m_speed(-1.f) {}

    GameKitCrowdDispersionInput(const Vec3f& position, KyFloat32 speed)
        : m_position(position), m_speed(speed) {}

public:
    Vec3f m_position;
    KyFloat32 m_speed;
};

class GameKitCrowdDispersionNavTag : public RefCountBase<GameKitCrowdDispersionNavTag, MemStat_GameKit>
{
    KY_CLASS_WITHOUT_COPY(GameKitCrowdDispersionNavTag)
public:
    GameKitCrowdDispersionNavTag(const Vec3f& refPos = Vec3f(), KyFloat32 length = 1.f, KyUInt32 expectedMaxCountPerSlot = 1, KyFloat32 intervalTimePerSlot = 0.5f);


    KyUInt32 GetTimeIntervaldxFromInputExisting(const GameKitCrowdDispersionInput& input);

    KyFloat32 GetAdditionalCostMultiplier(const GameKitCrowdDispersionInput& input);

    void Register(const GameKitCrowdDispersionInput& input);

    void Unregister(const GameKitCrowdDispersionInput& input);

    KyUInt32 GetTimeIntervalSize() { return m_count.GetCount(); }

    KyFloat32 GetFirstArrivalTime() { return m_firstArrivalTime; }
    KyUInt32 GetCountAtTimeInterval(KyUInt32 timeIntervalIdx) { return m_count[timeIntervalIdx]; }
    KyUInt32 GetThresholdCountPerInterval() { return m_thresholdCountPerInterval; }

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

private:
    KyUInt32 m_thresholdCountPerInterval;
    Vec3f m_referencePosition;
    KyFloat32 m_length;
    KyFloat32 m_intervalTimePerSlot;

    KyFloat32 m_firstArrivalTime; // gives the arrival time of the first interval (factor of intervalTimePerSlot)
    CircularArray<KyUInt32> m_count; // count of registrations per time interval

};


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

    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<GameKitCrowdDispersionNavTag> Get(const GameKitCrowdDispersionNavTagId& navTagId) const;
    Ptr<GameKitCrowdDispersionNavTag> Get(const GameKitCrowdDispersionNavTagId& navTagId);
    bool Get(const GameKitCrowdDispersionNavTagId& navTagId, Ptr<GameKitCrowdDispersionNavTag>* crowdDispersionNavTag) const;

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

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

    void Add(const NavData* navGraphOnlyNavData, KyUInt32 expectedMaxCountPerSlot = 1, KyFloat32 intervalTimePerSlot = 0.5f);
    
    KyResult Add(const GameKitCrowdDispersionNavTagId& navTagId, Ptr<GameKitCrowdDispersionNavTag> navTagCrowdDispersion);
    void Remove(const GameKitCrowdDispersionNavTagId& navTagId);

    void Clear();

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

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

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

}

#endif