gamekitnavtaglayercosttable.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.
*/


// primary contact: BRGR - secondary contact: 
#ifndef Navigation_GameKitNavTagLayerCollection_H
#define Navigation_GameKitNavTagLayerCollection_H

#include "gwnavruntime/containers/kyarray.h"
#include "gwnavruntime/base/memory.h"
#include "gwnavruntime/kernel/SF_Hash.h"
#include "gwnavruntime/kernel/SF_RefCount.h"

namespace Kaim
{

// INTERNAL CLASS: Implementation details of GameKitNavTagLayerCostInternal
class GameKitNavTagLayerCost;

// INTERNAL CLASS: Implementation details of GameKitNavTagLayerCostTable
// This class ensures by encapsulation that m_traversableLayerMask is always updated 
// when cost multipliers are modified via SetLayerCostMultiplier()
class GameKitNavTagLayerCostInternal
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_GameKit)
public: // internal
    // ----- only used by GameKitNavTagLayerCostable -----
    GameKitNavTagLayerCostInternal();
    GameKitNavTagLayerCostInternal(const GameKitNavTagLayerCostInternal& other);
    ~GameKitNavTagLayerCostInternal();
    void operator=(const GameKitNavTagLayerCostInternal& other);

    // Negative value means the layer is deactivated and its absolute value gives the original cost multiplier, so layer can be de/activated without losing the original cost
    // Cost should always be changed via this function since it maintains m_traversableLayerMask
    void SetLayerCostMultiplier(KyUInt32 layerID, KyFloat32 costMultiplier);
    const KyFloat32* GetLayerCostMultiplier(KyUInt32 layerID) const;

    KyUInt32 GetTraversableLayerMask() const { return m_traversableLayerMask; }

    void Clear();

private:
    KyFloat32* GetCostMultiplier(KyUInt32 layerID);

private:
    KyUInt32 m_traversableLayerMask; // guarantees O(1) lookup to check traversability of layerIDs < 32
    KyArray<GameKitNavTagLayerCost> m_layersAndCosts; // layerID
};


class GameKitNavTagLayerCostTable : public RefCountBase<GameKitNavTagLayerCostTable, MemStat_GameKit>
{
public:
    void SetLayerCostMultiplier(KyUInt32 layerID, KyFloat32 costMultiplier);

    void AllowLayer(KyUInt32 layerID);

    void ForbidLayer(KyUInt32 layerID);

    void Clear() { m_navTagLayers.Clear(); }

public: // internal
    bool CanTraverseLayer(KyUInt32 layerID, KyFloat32* costMultiplier) const;
    
    // For testing purpose only
    KyUInt32 GetTraversableLayerMask() const { return m_navTagLayers.GetTraversableLayerMask(); }

private:
    GameKitNavTagLayerCostInternal m_navTagLayers;
};

}

#endif