Urho3D
Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Friends
Urho3D::Object Class Reference

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

#include <Object.h>

Inheritance diagram for Urho3D::Object:
Urho3D::RefCounted Urho3D::Audio Urho3D::Connection Urho3D::Console Urho3D::DebugHud Urho3D::Engine Urho3D::File Urho3D::FileSelector Urho3D::FileSystem Urho3D::FileWatcher Urho3D::Geometry Urho3D::Graphics Urho3D::IndexBuffer Urho3D::Input Urho3D::Log Urho3D::Network Urho3D::OcclusionBuffer Urho3D::PackageFile Urho3D::Profiler Urho3D::Renderer Urho3D::Resource Urho3D::ResourceCache Urho3D::Script Urho3D::Serializable Urho3D::Time Urho3D::UI Urho3D::VertexBuffer Urho3D::View Urho3D::Viewport Urho3D::WorkQueue

List of all members.

Public Member Functions

 Object (Context *context)
 Construct.
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
virtual ShortStringHash GetType () const =0
 Return type hash.
virtual const StringGetTypeName () const =0
 Return type name.
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
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.
ContextGetContext () const
 Return execution context.
ObjectGetSubsystem (ShortStringHash 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.
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
- 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.

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

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