U3D
Open-source, cross-platform 2D and 3D game engine built in C++
Loading...
Searching...
No Matches
Urho3D::ResourceWithMetadata Class Reference

Base class for resources that support arbitrary metadata stored. Metadata serialization shall be implemented in derived classes. More...

#include </var/dev/u3d/stable/Source/Urho3D/Resource/Resource.h>

Inheritance diagram for Urho3D::ResourceWithMetadata:
[legend]
Collaboration diagram for Urho3D::ResourceWithMetadata:
[legend]

Public Member Functions

 ResourceWithMetadata (Context *context)
 Construct.
 
void AddMetadata (const String &name, const Variant &value)
 
void RemoveMetadata (const String &name)
 Remove metadata variable.
 
void RemoveAllMetadata ()
 Remove all metadata variables.
 
const VariantGetMetadata (const String &name) const
 
bool HasMetadata () const
 
- Public Member Functions inherited from Urho3D::Resource
 Resource (Context *context)
 Construct.
 
bool Load (Deserializer &source)
 Load resource synchronously. Call both BeginLoad() & EndLoad() and return true if both succeeded.
 
virtual bool BeginLoad (Deserializer &source)
 Load resource from stream. May be called from a worker thread. Return true if successful. More...
 
virtual bool EndLoad ()
 Finish resource loading. Always called from the main thread. Return true if successful. More...
 
virtual bool Save (Serializer &dest) const
 Save resource. Return true if successful. More...
 
bool LoadFile (const String &fileName)
 
virtual bool SaveFile (const String &fileName) const
 
void SetName (const String &name)
 
void SetMemoryUse (unsigned size)
 Set memory use in bytes, possibly approximate.
 
void ResetUseTimer ()
 Reset last used timer.
 
void SetAsyncLoadState (AsyncLoadState newState)
 Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user.
 
const StringGetName () const
 
StringHash GetNameHash () const
 Return name hash.
 
unsigned GetMemoryUse () const
 
unsigned GetUseTimer ()
 
AsyncLoadState GetAsyncLoadState () const
 Return the asynchronous loading state.
 
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
 
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 
virtual const StringGetTypeName () const =0
 
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
bool IsInstanceOf (StringHash type) const
 Check current instance is type of specified type.
 
bool IsInstanceOf (const TypeInfo *typeInfo) const
 Check current instance is type of specified type.
 
template<typename T >
bool IsInstanceOf () const
 Check current instance is type of specified class.
 
template<typename T >
T * Cast ()
 Cast the object to specified most derived class.
 
template<typename T >
const T * Cast () const
 Cast the object to specified most derived class.
 
void SubscribeToEvent (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
 
void SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 Subscribe to a specific sender's event.
 
void UnsubscribeFromEvent (StringHash eventType)
 Unsubscribe from an event.
 
void UnsubscribeFromEvent (Object *sender, StringHash eventType)
 Unsubscribe from a specific sender's event.
 
void UnsubscribeFromEvents (Object *sender)
 Unsubscribe from a specific sender's events.
 
void UnsubscribeFromAllEvents ()
 Unsubscribe from all events.
 
void UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData)
 Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events).
 
void SendEvent (StringHash eventType)
 Send event to all subscribers.
 
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
 
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
 
template<typename... Args>
void SendEvent (StringHash eventType, Args... args)
 Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 
const VariantMapGetGlobalVars () const
 
void SetGlobalVar (StringHash key, const Variant &value)
 
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
 
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandlerGetEventHandler () const
 Return active event handler. Null outside event handling.
 
bool HasSubscribedToEvent (StringHash eventType) const
 Return whether has subscribed to an event without specific sender.
 
bool HasSubscribedToEvent (Object *sender, StringHash eventType) const
 Return whether has subscribed to a specific sender's event.
 
bool HasEventHandlers () const
 Return whether has subscribed to any event.
 
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
 
const StringGetCategory () const
 
void SetBlockEvents (bool block)
 Block object from sending and receiving events.
 
bool GetBlockEvents () const
 Return sending and receiving events blocking status.
 
- Public Member Functions inherited from Urho3D::RefCounted
 RefCounted ()
 Construct. Allocate the reference count structure and set an initial self weak reference.
 
virtual ~RefCounted ()
 Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
 
 RefCounted (const RefCounted &rhs)=delete
 Prevent copy construction.
 
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
 
void AddRef ()
 
void ReleaseRef ()
 
int Refs () const
 
int WeakRefs () const
 
RefCountRefCountPtr ()
 Return pointer to the reference count structure.
 

Protected Member Functions

void LoadMetadataFromXML (const XMLElement &source)
 Load metadata from <metadata> children of XML element.
 
void LoadMetadataFromJSON (const JSONArray &array)
 Load metadata from JSON array.
 
void SaveMetadataToXML (XMLElement &destination) const
 Save as <metadata> children of XML element.
 
void CopyMetadata (const ResourceWithMetadata &source)
 Copy metadata from another resource.
 

Private Member Functions

 URHO3D_OBJECT (ResourceWithMetadata, Resource)
 

Private Attributes

VariantMap metadata_
 Animation metadata variables.
 
StringVector metadataKeys_
 Animation metadata keys.
 

Additional Inherited Members

- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 
- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 Execution context.
 

Detailed Description

Base class for resources that support arbitrary metadata stored. Metadata serialization shall be implemented in derived classes.

Member Function Documentation

◆ AddMetadata()

void Urho3D::ResourceWithMetadata::AddMetadata ( const String name,
const Variant value 
)

Add new metadata variable or overwrite old value.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetMetadata()

const Urho3D::Variant & Urho3D::ResourceWithMetadata::GetMetadata ( const String name) const

Return metadata variable.

Here is the caller graph for this function:

◆ HasMetadata()

bool Urho3D::ResourceWithMetadata::HasMetadata ( ) const

Return whether the resource has metadata.

Here is the call graph for this function:
Here is the caller graph for this function:

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