ezEngine  Release 25.03
ezTagRegistry Class Reference

The tag registry for tags in tag sets. More...

#include <TagRegistry.h>

Public Member Functions

const ezTagRegisterTag (ezStringView sTagString)
 Ensures the tag with the given name exists and returns a pointer to it.
 
const ezTagRegisterTag (const ezHashedString &sTagString)
 Ensures the tag with the given name exists and returns a pointer to it.
 
const ezTagGetTagByName (const ezTempHashedString &sTagString) const
 Searches for a tag with the given name and returns a pointer to it.
 
const ezTagGetTagByMurmurHash (ezUInt32 uiMurmurHash) const
 Searches for a tag with the given murmur hash. This function is only for backwards compatibility.
 
const ezTagGetTagByIndex (ezUInt32 uiIndex) const
 Returns the tag with the given index.
 
ezUInt32 GetNumTags () const
 Returns the number of registered tags.
 
ezResult Load (ezStreamReader &inout_stream)
 Loads the saved state and integrates it into this registry. Does not discard previously registered tag information. This function is only for backwards compatibility.
 

Static Public Member Functions

static ezTagRegistryGetGlobalRegistry ()
 

Protected Attributes

ezMutex m_TagRegistryMutex
 
ezMap< ezTempHashedString, ezTagm_RegisteredTags
 
ezDeque< ezTag * > m_TagsByIndex
 

Detailed Description

The tag registry for tags in tag sets.

Normal usage of the tag registry is to get the global tag registry instance via ezTagRegistry::GetGlobalRegistry() and to use this instance to register and get tags. Certain special cases (e.g. tests) may actually need their own instance of the tag registry. Note however that tags which were registered with one registry shouldn't be used with tag sets filled with tags from another registry since there may be conflicting tag assignments. The tag registry registration and tag retrieval functions are thread safe due to a mutex.


The documentation for this class was generated from the following files: