Urho3D
Public Member Functions | Protected Attributes | Private Member Functions
Urho3D::Serializable Class Reference

Base class for objects with automatic serialization through attributes. More...

#include <Serializable.h>

Inheritance diagram for Urho3D::Serializable:
Urho3D::Object Urho3D::RefCounted Urho3D::Component Urho3D::Node Urho3D::UIElement Urho3D::AnimationController Urho3D::Camera Urho3D::CollisionShape Urho3D::Constraint Urho3D::DebugRenderer Urho3D::Drawable Urho3D::NetworkPriority Urho3D::Octree Urho3D::PhysicsWorld Urho3D::RigidBody Urho3D::ScriptInstance Urho3D::SmoothedTransform Urho3D::SoundListener Urho3D::SoundSource Urho3D::Terrain Urho3D::Scene Urho3D::BorderImage Urho3D::ScrollBar Urho3D::ScrollView Urho3D::Text

List of all members.

Public Member Functions

 Serializable (Context *context)
 Construct.
virtual ~Serializable ()
 Destruct.
virtual void OnSetAttribute (const AttributeInfo &attr, const Variant &src)
 Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.
virtual void OnGetAttribute (const AttributeInfo &attr, Variant &dest)
 Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
virtual bool Load (Deserializer &source)
 Load from binary data. Return true if successful.
virtual bool Save (Serializer &dest)
 Save as binary data. Return true if successful.
virtual bool LoadXML (const XMLElement &source)
 Load from XML data. Return true if successful.
virtual bool SaveXML (XMLElement &dest)
 Save as XML data. Return true if successful.
virtual void ApplyAttributes ()
 Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
bool SetAttribute (unsigned index, const Variant &value)
 Set attribute by index. Return true if successfully set.
bool SetAttribute (const String &name, const Variant &value)
 Set attribute by name. Return true if successfully set.
void AllocateNetworkState ()
 Allocate network attribute state.
void WriteInitialDeltaUpdate (Serializer &dest)
 Write initial delta network update.
void WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits)
 Write a delta network update according to dirty attribute bits.
void WriteLatestDataUpdate (Serializer &dest)
 Write a latest data network update.
void ReadDeltaUpdate (Deserializer &source)
 Read and apply a network delta update.
void ReadLatestDataUpdate (Deserializer &source)
 Read and apply a network latest data update.
Variant GetAttribute (unsigned index)
 Return attribute value by index. Return empty if illegal index.
Variant GetAttribute (const String &name)
 Return attribute value by name. Return empty if not found.
unsigned GetNumAttributes () const
 Return number of attributes.
unsigned GetNumNetworkAttributes () const
 Return number of network replication attributes.
const Vector< AttributeInfo > * GetAttributes () const
 Return attribute descriptions, or null if none defined.
const Vector< AttributeInfo > * GetNetworkAttributes () const
 Return network replication attribute descriptions, or null if none defined.
- Public Member Functions inherited from Urho3D::Object
 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

NetworkStatenetworkState_
 Network attribute state.
- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 Execution context.

Private Member Functions

 OBJECT (Serializable)

Detailed Description

Base class for objects with automatic serialization through attributes.


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