U3D
Open-source, cross-platform 2D and 3D game engine built in C++
Loading...
Searching...
No Matches
Urho3D::Serializable Class Reference

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

#include </var/dev/u3d/stable/Source/Urho3D/Scene/Serializable.h>

Inheritance diagram for Urho3D::Serializable:
[legend]
Collaboration diagram for Urho3D::Serializable:
[legend]

Public Member Functions

 Serializable (Context *context)
 Construct.
 
 ~Serializable () override
 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. More...
 
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. More...
 
virtual const Vector< AttributeInfo > * GetAttributes () const
 Return attribute descriptions, or null if none defined. More...
 
virtual const Vector< AttributeInfo > * GetNetworkAttributes () const
 Return network replication attribute descriptions, or null if none defined.
 
virtual bool Load (Deserializer &source)
 Load from binary data. Return true if successful. More...
 
virtual bool Save (Serializer &dest) const
 Save as binary data. Return true if successful. More...
 
virtual bool LoadXML (const XMLElement &source)
 Load from XML data. Return true if successful. More...
 
virtual bool SaveXML (XMLElement &dest) const
 Save as XML data. Return true if successful. More...
 
virtual bool LoadJSON (const JSONValue &source)
 Load from JSON data. Return true if successful. More...
 
virtual bool SaveJSON (JSONValue &dest) const
 Save as JSON data. Return true if successful. More...
 
virtual void ApplyAttributes ()
 Apply attribute changes that can not be applied immediately. Called after scene load or a network update. More...
 
virtual bool SaveDefaultAttributes () const
 Return whether should save default-valued attributes into XML. Default false. More...
 
virtual void MarkNetworkUpdate ()
 Mark for attribute check on the next network update. More...
 
bool SetAttribute (unsigned index, const Variant &value)
 
bool SetAttribute (const String &name, const Variant &value)
 Set attribute by name. Return true if successfully set.
 
void SetInstanceDefault (bool enable)
 Set instance-level default flag.
 
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)
 
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
 
Variant GetAttribute (const String &name) const
 Return attribute value by name. Return empty if not found.
 
Variant GetAttributeDefault (unsigned index) const
 
Variant GetAttributeDefault (const String &name) const
 Return attribute default value by name. Return empty if not found.
 
unsigned GetNumAttributes () const
 
unsigned GetNumNetworkAttributes () const
 Return number of network replication attributes.
 
bool IsTemporary () const
 
bool GetInterceptNetworkUpdate (const String &attributeName) const
 Return whether an attribute's network updates are being intercepted.
 
NetworkStateGetNetworkState () const
 Return the network attribute state, if allocated.
 
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
 
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 
virtual const StringGetTypeName () const =0
 
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 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.
 
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
 
const VariantMapGetGlobalVars () const
 
void SetGlobalVar (StringHash key, const Variant &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
 
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 ()
 
void ReleaseRef ()
 
int Refs () const
 
int WeakRefs () const
 
RefCountRefCountPtr ()
 Return pointer to the reference count structure.
 

Protected Attributes

UniquePtr< NetworkStatenetworkState_
 Network attribute state.
 
- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 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

UniquePtr< VariantMapinstanceDefaultValues_
 Attribute default value at each instance level.
 
bool setInstanceDefault_
 When true, store the attribute value as instance's default value (internal use only).
 
bool temporary_
 Temporary flag.
 

Additional Inherited Members

- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 

Detailed Description

Base class for objects with automatic serialization through attributes.

Member Function Documentation

◆ ApplyAttributes()

virtual void Urho3D::Serializable::ApplyAttributes ( )
inlinevirtual

Apply attribute changes that can not be applied immediately. Called after scene load or a network update.

Reimplemented in Urho3D::ScriptInstance, Urho3D::AnimatedModel, Urho3D::DecalSet, Urho3D::StaticModelGroup, Urho3D::Terrain, Urho3D::LuaScriptInstance, Urho3D::CrowdAgent, Urho3D::CrowdManager, Urho3D::OffMeshConnection, Urho3D::CollisionShape, Urho3D::Constraint, Urho3D::RaycastVehicle, Urho3D::RigidBody, Urho3D::Constraint2D, Urho3D::Node, Urho3D::SplinePath, Urho3D::DropDownList, Urho3D::LineEdit, Urho3D::ScrollBar, Urho3D::ScrollView, Urho3D::Text, Urho3D::Text3D, and Urho3D::UIElement.

Here is the caller graph for this function:

◆ GetAttribute()

Variant Urho3D::Serializable::GetAttribute ( unsigned  index) const

Return attribute value by index. Return empty if illegal index.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetAttributeDefault()

Variant Urho3D::Serializable::GetAttributeDefault ( unsigned  index) const

Return attribute default value by index. Return empty if illegal index.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetAttributes()

const Vector< AttributeInfo > * Urho3D::Serializable::GetAttributes ( ) const
virtual

Return attribute descriptions, or null if none defined.

Reimplemented in Urho3D::ScriptInstance, Urho3D::LuaScriptInstance, and Urho3D::UnknownComponent.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetNumAttributes()

unsigned Urho3D::Serializable::GetNumAttributes ( ) const

Return number of attributes.

Here is the call graph for this function:

◆ IsTemporary()

bool Urho3D::Serializable::IsTemporary ( ) const
inline

Return whether is temporary.

Here is the caller graph for this function:

◆ Load()

bool Urho3D::Serializable::Load ( Deserializer source)
virtual

Load from binary data. Return true if successful.

Reimplemented in Urho3D::AnimatedModel, Urho3D::Node, Urho3D::Scene, and Urho3D::UnknownComponent.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LoadJSON()

bool Urho3D::Serializable::LoadJSON ( const JSONValue source)
virtual

Load from JSON data. Return true if successful.

Reimplemented in Urho3D::AnimatedModel, Urho3D::Animatable, Urho3D::Node, Urho3D::Scene, and Urho3D::UnknownComponent.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LoadXML()

bool Urho3D::Serializable::LoadXML ( const XMLElement source)
virtual

Load from XML data. Return true if successful.

Reimplemented in Urho3D::AnimatedModel, Urho3D::Animatable, Urho3D::Node, Urho3D::Scene, Urho3D::UnknownComponent, Urho3D::Menu, and Urho3D::UIElement.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ MarkNetworkUpdate()

virtual void Urho3D::Serializable::MarkNetworkUpdate ( )
inlinevirtual

Mark for attribute check on the next network update.

Reimplemented in Urho3D::Component, Urho3D::Node, and Urho3D::Scene.

Here is the caller graph for this function:

◆ OnGetAttribute()

void Urho3D::Serializable::OnGetAttribute ( const AttributeInfo attr,
Variant dest 
) const
virtual

Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.

Reimplemented in Urho3D::ScriptInstance, and Urho3D::LuaScriptInstance.

Here is the caller graph for this function:

◆ OnSetAttribute()

void Urho3D::Serializable::OnSetAttribute ( const AttributeInfo attr,
const Variant src 
)
virtual

Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.

Reimplemented in Urho3D::ScriptInstance, and Urho3D::LuaScriptInstance.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Save()

bool Urho3D::Serializable::Save ( Serializer dest) const
virtual

Save as binary data. Return true if successful.

Reimplemented in Urho3D::Component, Urho3D::Node, Urho3D::Scene, and Urho3D::UnknownComponent.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SaveDefaultAttributes()

virtual bool Urho3D::Serializable::SaveDefaultAttributes ( ) const
inlinevirtual

Return whether should save default-valued attributes into XML. Default false.

Reimplemented in Urho3D::Node.

Here is the caller graph for this function:

◆ SaveJSON()

bool Urho3D::Serializable::SaveJSON ( JSONValue dest) const
virtual

Save as JSON data. Return true if successful.

Reimplemented in Urho3D::Animatable, Urho3D::Component, Urho3D::Node, Urho3D::Scene, and Urho3D::UnknownComponent.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SaveXML()

bool Urho3D::Serializable::SaveXML ( XMLElement dest) const
virtual

Save as XML data. Return true if successful.

Reimplemented in Urho3D::Animatable, Urho3D::Component, Urho3D::Node, Urho3D::Scene, Urho3D::UnknownComponent, Urho3D::Menu, Urho3D::Menu, and Urho3D::UIElement.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetAttribute()

bool Urho3D::Serializable::SetAttribute ( unsigned  index,
const Variant value 
)

Set attribute by index. Return true if successfully set.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetTemporary()

void Urho3D::Serializable::SetTemporary ( bool  enable)

Set temporary flag. Temporary objects will not be saved.

Here is the call graph for this function:
Here is the caller graph for this function:

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