Urho3D::Serializable Class Reference
Public Member Functions |
Protected Attributes |
Private Member Functions |
Private Attributes |
List of all members
Urho3D::Serializable Class Reference
Base class for objects with automatic serialization through attributes. More...
#include <Urho3D/Scene/Serializable.h>
Inheritance diagram for Urho3D::Serializable:
Collaboration diagram for Urho3D::Serializable:
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) const |
Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor. | |
virtual const Vector < AttributeInfo > * | GetAttributes () const |
Return attribute descriptions, or null if none defined. | |
virtual const Vector < AttributeInfo > * | GetNetworkAttributes () const |
Return network replication attribute descriptions, or null if none defined. | |
virtual bool | Load (Deserializer &source, bool setInstanceDefault=false) |
Load from binary data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful. | |
virtual bool | Save (Serializer &dest) const |
Save as binary data. Return true if successful. | |
virtual bool | LoadXML (const XMLElement &source, bool setInstanceDefault=false) |
Load from XML data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful. | |
virtual bool | SaveXML (XMLElement &dest) const |
Save as XML data. Return true if successful. | |
virtual bool | LoadJSON (const JSONValue &source, bool setInstanceDefault=false) |
Load from JSON data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful. | |
virtual bool | SaveJSON (JSONValue &dest) const |
Save as JSON 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. | |
virtual bool | SaveDefaultAttributes () const |
Return whether should save default-valued attributes into XML. Default false. | |
virtual void | MarkNetworkUpdate () |
Mark for attribute check on the next 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 | ResetToDefault () |
Reset all editable attributes to their default values. | |
void | RemoveInstanceDefault () |
Remove instance's default values if they are set previously. | |
void | SetTemporary (bool enable) |
Set temporary flag. Temporary objects will not be saved. | |
void | SetInterceptNetworkUpdate (const String &attributeName, bool enable) |
Enable interception of an attribute from network updates. Intercepted attributes are sent as events instead of applying directly. This can be used to implement client side prediction. | |
void | AllocateNetworkState () |
Allocate network attribute state. | |
void | WriteInitialDeltaUpdate (Serializer &dest, unsigned char timeStamp) |
Write initial delta network update. | |
void | WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits, unsigned char timeStamp) |
Write a delta network update according to dirty attribute bits. | |
void | WriteLatestDataUpdate (Serializer &dest, unsigned char timeStamp) |
Write a latest data network update. | |
bool | ReadDeltaUpdate (Deserializer &source) |
Read and apply a network delta update. Return true if attributes were changed. | |
bool | ReadLatestDataUpdate (Deserializer &source) |
Read and apply a network latest data update. Return true if attributes were changed. | |
Variant | GetAttribute (unsigned index) const |
Return attribute value by index. Return empty if illegal index. | |
Variant | GetAttribute (const String &name) const |
Return attribute value by name. Return empty if not found. | |
Variant | GetAttributeDefault (unsigned index) const |
Return attribute default value by index. Return empty if illegal index. | |
Variant | GetAttributeDefault (const String &name) const |
Return attribute default value by name. Return empty if not found. | |
unsigned | GetNumAttributes () const |
Return number of attributes. | |
unsigned | GetNumNetworkAttributes () const |
Return number of network replication attributes. | |
bool | IsTemporary () const |
Return whether is temporary. | |
bool | GetInterceptNetworkUpdate (const String &attributeName) const |
Return whether an attribute's network updates are being intercepted. | |
NetworkState * | GetNetworkState () const |
Return the network attribute state, if allocated. | |
![]() | |
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 String & | GetTypeName () const =0 |
Return type name. | |
virtual const TypeInfo * | GetTypeInfo () 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... | |
VariantMap & | GetEventDataMap () const |
Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps. | |
Context * | GetContext () const |
Return execution context. | |
const Variant & | GetGlobalVar (StringHash key) const |
Return global variable based on key. | |
const VariantMap & | GetGlobalVars () const |
Return all global variables. | |
void | SetGlobalVar (StringHash key, const Variant &value) |
Set global variable with the respective key and value. | |
Object * | GetSubsystem (StringHash type) const |
Return subsystem by type. | |
Object * | GetEventSender () const |
Return active event sender. Null outside event handling. | |
EventHandler * | GetEventHandler () 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 String & | GetCategory () const |
Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered. | |
![]() | |
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. | |
RefCount * | RefCountPtr () |
Return pointer to the reference count structure. | |
Protected Attributes | |
NetworkState * | networkState_ |
Network attribute state. | |
![]() | |
Context * | context_ |
Execution context. | |
Private Member Functions | |
URHO3D_OBJECT (Serializable, Object) | |
void | SetInstanceDefault (const String &name, const Variant &defaultValue) |
Set instance-level default value. Allocate the internal data structure as necessary. | |
Variant | GetInstanceDefault (const String &name) const |
Get instance-level default value. | |
Private Attributes | |
VariantMap * | instanceDefaultValues_ |
Attribute default value at each instance level. | |
bool | temporary_ |
Temporary flag. | |
Additional Inherited Members | |
![]() | |
static const TypeInfo * | GetTypeInfoStatic () |
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. | |
Detailed Description
Base class for objects with automatic serialization through attributes.
The documentation for this class was generated from the following files:
- Source/Urho3D/Scene/Serializable.h
- Source/Urho3D/Scene/Serializable.cpp