Urho3D
Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Friends | List of all members
Urho3D::Object Class Referenceabstract

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

#include </home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/Core/Object.h>

Inheritance diagram for Urho3D::Object:
Urho3D::RefCounted Urho3D::Application Urho3D::Audio Urho3D::Connection Urho3D::Console Urho3D::ConstantBuffer Urho3D::Database Urho3D::DbConnection Urho3D::DebugHud Urho3D::Engine Urho3D::File Urho3D::FileSelector Urho3D::FileSystem Urho3D::FileWatcher Urho3D::Geometry Urho3D::Graphics Urho3D::IndexBuffer Urho3D::Input Urho3D::Localization Urho3D::Log Urho3D::MessageBox Urho3D::NamedPipe Urho3D::Network Urho3D::OcclusionBuffer Urho3D::PackageFile Urho3D::Profiler Urho3D::Renderer Urho3D::Resource Urho3D::ResourceCache Urho3D::ResourceRouter Urho3D::Serializable Urho3D::ShaderPrecache Urho3D::SpriteBatchBase Urho3D::Time Urho3D::UI Urho3D::VertexBuffer Urho3D::View Urho3D::Viewport Urho3D::WorkQueue

Public Member Functions

 Object (Context *context)
 Construct.
 
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 Return type hash. More...
 
virtual const StringGetTypeName () const =0
 Return type name. More...
 
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 Vector< 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
 Return global variable based on key.
 
const VariantMapGetGlobalVars () const
 Return all global variables.
 
void SetGlobalVar (StringHash key, const Variant &value)
 Set global variable with the respective key and 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
 Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
 
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 ()
 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.
 

Protected Attributes

Contextcontext_
 Execution context.
 

Private Member Functions

EventHandlerFindEventHandler (StringHash eventType, EventHandler **previous=nullptr) const
 Find the first event handler with no specific sender.
 
EventHandlerFindSpecificEventHandler (Object *sender, EventHandler **previous=nullptr) const
 Find the first event handler with specific sender.
 
EventHandlerFindSpecificEventHandler (Object *sender, StringHash eventType, EventHandler **previous=nullptr) 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.
 
bool blockEvents_
 Block object from sending and receiving any events.
 

Friends

class Context
 

Detailed Description

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

Member Function Documentation

◆ GetType()

virtual StringHash Urho3D::Object::GetType ( ) const
pure virtual

Return type hash.

Implemented in Urho3D::UnknownComponent.

◆ GetTypeName()

virtual const String & Urho3D::Object::GetTypeName ( ) const
pure virtual

Return type name.

Implemented in Urho3D::UnknownComponent.


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