Base class for objects with type identification, subsystem access and event sending/receiving capability. More...

#include <Object.h>

Inherits Urho3D::RefCounted.

Inherited by Urho3D::Application, Urho3D::Audio, Urho3D::Connection, Urho3D::Console, Urho3D::ConstantBuffer, Urho3D::Database, Urho3D::DbConnection, Urho3D::DbConnection, Urho3D::DebugHud, Urho3D::Engine, Urho3D::File, Urho3D::FileSelector, Urho3D::FileSystem, Urho3D::FileWatcher, Urho3D::FreeTypeLibrary, Urho3D::Geometry, Urho3D::Graphics, Urho3D::IndexBuffer, Urho3D::Input, Urho3D::Localization, Urho3D::Log, Urho3D::LuaScript, Urho3D::LuaScriptEventInvoker, Urho3D::MessageBox, Urho3D::Network, Urho3D::OcclusionBuffer, Urho3D::PackageFile, Urho3D::Profiler, Urho3D::Renderer, Urho3D::Resource, Urho3D::ResourceCache, Urho3D::ResourceRouter, Urho3D::Script, Urho3D::ScriptEventInvoker, Urho3D::Serializable, Urho3D::ShaderPrecache, Urho3D::Time, Urho3D::UI, Urho3D::VertexBuffer, Urho3D::View, Urho3D::Viewport, and Urho3D::WorkQueue.

Collaboration diagram for Urho3D::Object:
[legend]

Public Member Functions

 Object (Context *context)
 Construct.
 
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 Return type hash.
 
virtual const StringGetTypeName () const =0
 Return type name.
 
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.
 
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 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. More...
 
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
 
ContextGetContext () const
 Return execution context.
 
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
 Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
 
- 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.
 
void AddRef ()
 Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
 
void ReleaseRef ()
 Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
 
int Refs () const
 Return reference count.
 
int WeakRefs () const
 Return weak reference count.
 
RefCountRefCountPtr ()
 Return pointer to the reference count structure.
 

Static Public Member Functions

static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 
static bool IsTypeOf (StringHash type)
 Check current type is type of specified type.
 
static bool IsTypeOf (const TypeInfo *typeInfo)
 Check current type is type of specified type.
 
template<typename T >
static bool IsTypeOf ()
 Check current type is type of specified class.
 

Protected Attributes

Contextcontext_
 Execution context.
 

Private Member Functions

EventHandlerFindEventHandler (StringHash eventType, EventHandler **previous=0) const
 Find the first event handler with no specific sender.
 
EventHandlerFindSpecificEventHandler (Object *sender, EventHandler **previous=0) const
 Find the first event handler with specific sender.
 
EventHandlerFindSpecificEventHandler (Object *sender, StringHash eventType, EventHandler **previous=0) const
 Find the first event handler with specific sender and event type.
 
void RemoveEventSender (Object *sender)
 Remove event handlers related to a specific sender.
 

Private Attributes

LinkedList< EventHandlereventHandlers_
 Event handlers. Sender is null for non-specific handlers.
 

Friends

class Context
 

Detailed Description

Base class for objects with type identification, subsystem access and event sending/receiving capability.

Member Function Documentation

void Urho3D::Object::SendEvent ( StringHash  eventType,
VariantMap eventData 
)

Send event with parameters to all subscribers.

Todo:
This is not entirely foolproof, as a subscriber could have been added to make up for the removed one

Here is the call graph for this function:


The documentation for this class was generated from the following files:
  • /home/travis/build/urho3d/Urho3D/Source/Urho3D/Core/Object.h
  • /home/travis/build/urho3d/Urho3D/Source/Urho3D/Core/Object.cpp