gamekitnavtag.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: MAMU - secondary contact: 
#ifndef Navigation_GameKitNavTag_H
#define Navigation_GameKitNavTag_H

#include "gwnavruntime/database/navtag.h"
#include "gwnavruntime/visualsystem/visualcolor.h"
#include "gwnavruntime/kernel/SF_RefCount.h"

namespace Kaim
{


class GameKitNavTag : public RefCountBase<GameKitNavTag, MemStat_GameKit>
{
public:
    GameKitNavTag()
    {
        m_navTag.m_blindDataArray.Resize(4);
        m_navTag.m_blindDataArray[0] = KyUInt32MAXVAL;
        m_navTag.m_blindDataArray[1] = KyUInt32MAXVAL;
        m_navTag.m_blindDataArray[2] = KyUInt32MAXVAL;
        m_navTag.m_blindDataArray[3] = KyUInt32MAXVAL;
        m_navTag.SetColor(0, 0, 139);
    }

    KY_INLINE bool IsExclusive()     const { return m_navTag.IsExclusive(); }
    KY_INLINE bool HasSmartObject()  const { return GetSmartObjectID() != KyUInt32MAXVAL; }
    KY_INLINE bool HasLayer()        const { return GetLayerID() != KyUInt32MAXVAL; }

    KY_INLINE KyUInt32 GetLayerID()            const { return m_navTag.m_blindDataArray[0]; }
    KY_INLINE KyUInt32 GetSmartObjectID()      const { return m_navTag.m_blindDataArray[1]; }
    KY_INLINE KyUInt32 GetGameObjectUniqueID() const { return m_navTag.m_blindDataArray[2]; }
    KY_INLINE KyUInt32 GetUserDataID()         const { return m_navTag.m_blindDataArray[3]; }
    KY_INLINE Kaim::VisualColor GetColor()     const { return Kaim::VisualColor(m_navTag.m_colorR, m_navTag.m_colorG, m_navTag.m_colorB); }

    KY_INLINE void SetAsExclusive() { m_navTag.SetAsExclusive(); }
    KY_INLINE void SetLayerID(KyUInt32 layerID)                          { m_navTag.m_blindDataArray[0] = layerID; }
    KY_INLINE void SetSmartObjectID(KyUInt32 smartObjectID)              { m_navTag.m_blindDataArray[1] = smartObjectID; }
    KY_INLINE void SetGameObjectUniqueID(KyUInt32 gameObjectUniqueID)    { m_navTag.m_blindDataArray[2] = gameObjectUniqueID; }
    KY_INLINE void SetUserDataID(KyUInt32 userDataID)                    { m_navTag.m_blindDataArray[3] = userDataID; }
    KY_INLINE void SetColor(const Kaim::VisualColor& color)  { m_navTag.SetColor(color); }
    KY_INLINE void SetColor(KyUInt8 r, KyUInt8 g, KyUInt8 b) { m_navTag.SetColor(r,g,b); }

    KY_INLINE const Kaim::DynamicNavTag& GetDynamicNavTag() const { return m_navTag; }


    // ------ Initialization from non-GameKitNavTag  -----
    // NavTag not being exactly the size of a GameKitNavTag will be reinterpreted as follow:
    //  - If longer, trailing words will be ignored
    //  - If shorter, missing words will be considered being KyUInt32MAXVAL
    // Returned KyResult is here to help users detect such issues, not that in all cases the GameKitNavTag will be modified.

    KyResult InitFrom(const Kaim::DynamicNavTag& dynamicNavTag);
    KyResult InitFrom(const Kaim::NavTag& navTag);

private:
    Kaim::DynamicNavTag m_navTag;
};


}

#endif