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

// Authors: GUAL
#ifndef Navigation_VisualDebugRegistry_H
#define Navigation_VisualDebugRegistry_H


#include "gwnavruntime/base/memory.h"
#include "gwnavruntime/world/worldelementtype.h"
#include "gwnavruntime/kernel/SF_Hash.h"


namespace Kaim
{

class World;
class WorldElement;
class VisualDebugServer;

typedef Hash<KyUInt32, WorldElement*, FixedSizeHash<KyUInt32>, AllocatorGH<KyUInt32, MemStat_VisualDebugRegistry> > WorldElementHash;

// This class is used as a component of Kaim::World
// If KY_BUILD_SHIPPING is enabled, this class is not functional, and Kaim::World does not instanciate it.
class VisualDebugRegistry
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_VisualDebugRegistry)
    KY_CLASS_WITHOUT_COPY(VisualDebugRegistry)

public:
    VisualDebugRegistry(World* world) : m_world(world), m_nextVisualDebugId(0) {}
    
    ~VisualDebugRegistry();

    void Register(WorldElement* worldElement);

    void UnRegister(WorldElement* worldElement);

    KyUInt32 GetNewVisualDebugId();

    WorldElement* Get(KyUInt32 visualDebugId);

    WorldElement* GetAs(KyUInt32 visualDebugId, WorldElementType worldElementType);

    template<class T>
    T* GetAs(KyUInt32 visualDebugId);

    //const WorldElementHash& GetElements() const { return m_hash; }

    // Called every frame, this is where we send visual debug data associated to WorldElements
    void SendVisualDebug(VisualDebugServer& visualDebugServer);

    void OnConnection();

private:
    World* m_world; // allows to browse directly the WorldElement collections in SendVisualDebug() instead of browsing m_hash
    KyUInt32 m_nextVisualDebugId;
    WorldElementHash m_hash; // visualDebugId => WorldElement
};


#ifndef KY_BUILD_SHIPPING

template<class T>
KY_INLINE T* VisualDebugRegistry::GetAs(KyUInt32 visualDebugId) { return (T*)GetAs(visualDebugId, T::GetStaticType()); }

#else // VisualDebug disabled in shipping

KY_INLINE VisualDebugRegistry::~VisualDebugRegistry() {}
KY_INLINE void VisualDebugRegistry::Register(WorldElement*) {}
KY_INLINE void VisualDebugRegistry::UnRegister(WorldElement*) {} 
KY_INLINE KyUInt32 VisualDebugRegistry::GetNewVisualDebugId()  { return KyUInt32MAXVAL; }
KY_INLINE WorldElement* VisualDebugRegistry::Get(KyUInt32) { return KY_NULL; }
KY_INLINE WorldElement* VisualDebugRegistry::GetAs(KyUInt32, WorldElementType) { return KY_NULL; }
template<class T>
KY_INLINE T* VisualDebugRegistry::GetAs(KyUInt32) { return KY_NULL; }
KY_INLINE void VisualDebugRegistry::SendVisualDebug(VisualDebugServer&) {}
KY_INLINE void VisualDebugRegistry::OnConnection() {}

#endif

}

#endif