Rebel Fork Framework
Urho3D::Serializable Class Reference

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

#include <Urho3D/Scene/Serializable.h>

Inheritance diagram for Urho3D::Serializable:
Urho3D::Object Urho3D::RefCounted Urho3D::Actions::BaseAction Urho3D::Animatable Urho3D::AssetTransformer Urho3D::Component Urho3D::ParticleGraphLayer Urho3D::ParticleGraphNode Urho3D::Actions::FiniteTimeAction Urho3D::UIElement Urho3D::AnimationVelocityExtractor Urho3D::IKTargetExtractor Urho3D::AnimationStateSource Urho3D::Camera Urho3D::CameraOperator Urho3D::CollisionShape Urho3D::CollisionShape2D Urho3D::Constraint Urho3D::Constraint2D Urho3D::CrowdAgent Urho3D::CrowdManager Urho3D::DebugRenderer Urho3D::Drawable Urho3D::FreeFlyController Urho3D::GlobalIllumination Urho3D::IKSolverComponent Urho3D::KinematicCharacterController Urho3D::LightBaker Urho3D::LightProbeGroup Urho3D::LogicComponent Urho3D::MoveAndOrbitController Urho3D::NavArea Urho3D::Navigable Urho3D::NavigationMesh Urho3D::NetworkBehavior Urho3D::Obstacle Urho3D::Octree Urho3D::OffMeshConnection Urho3D::OutlineGroup Urho3D::ParticleGraphEmitter Urho3D::PhysicsWorld Urho3D::PhysicsWorld2D Urho3D::PrefabReference Urho3D::RaycastVehicleWheel Urho3D::RenderPipeline Urho3D::RigidBody Urho3D::RigidBody2D Urho3D::SoundListener Urho3D::SoundSource Urho3D::SplinePath Urho3D::Terrain Urho3D::TileMap2D Urho3D::TileMapLayer2D Urho3D::TrackedComponentBase Urho3D::TrackedComponentRegistryBase Urho3D::TriggerAnimator Urho3D::UIComponent Urho3D::UnknownComponent Urho3D::ParticleGraphNodes::TemplateNode< ApplyForceInstance, Vector3, Vector3, Vector3 > Urho3D::ParticleGraphNodes::TemplateNode< BounceInstance, Vector3, Vector3, Vector3, Vector3 > Urho3D::ParticleGraphNodes::TemplateNode< BoxInstance, Vector3, Vector3 > Urho3D::ParticleGraphNodes::TemplateNode< BurstTimerInstance, float, float > Urho3D::ParticleGraphNodes::TemplateNode< CircleInstance, Vector3, Vector3 > Urho3D::ParticleGraphNodes::TemplateNode< ConeInstance, Vector3, Vector3 > Urho3D::ParticleGraphNodes::TemplateNode< CurlNoise3DInstance, Vector3, Vector3 > Urho3D::ParticleGraphNodes::TemplateNode< DestroyInstance, bool > Urho3D::ParticleGraphNodes::TemplateNode< EffectTimeInstance, float > Urho3D::ParticleGraphNodes::TemplateNode< EmitInstance, float > Urho3D::ParticleGraphNodes::TemplateNode< EmitterPositionInstance, Vector3 > Urho3D::ParticleGraphNodes::TemplateNode< EmitterRotationInstance, Quaternion > Urho3D::ParticleGraphNodes::TemplateNode< EmitterScaleInstance, Vector3 > Urho3D::ParticleGraphNodes::TemplateNode< ExpireInstance, float, float > Urho3D::ParticleGraphNodes::TemplateNode< HemisphereInstance, Vector3, Vector3 > Urho3D::ParticleGraphNodes::TemplateNode< LimitVelocityInstance, Vector3, float, Vector3 > Urho3D::ParticleGraphNodes::TemplateNode< LocalToWorldInstance, Matrix3x4 > Urho3D::ParticleGraphNodes::TemplateNode< MoveInstance, Vector3, Vector3, Vector3 > Urho3D::ParticleGraphNodes::TemplateNode< Noise3DInstance, Vector3, float > Urho3D::ParticleGraphNodes::TemplateNode< NormalizedEffectTimeInstance, float > Urho3D::ParticleGraphNodes::TemplateNode< RenderBillboardInstance, Vector3, Vector2, float, Color, float, Vector3 > Urho3D::ParticleGraphNodes::TemplateNode< RenderMeshInstance, Matrix3x4 > Urho3D::ParticleGraphNodes::TemplateNode< SlerpInstance, Quaternion, Quaternion, float, Quaternion > Urho3D::ParticleGraphNodes::TemplateNode< SphereInstance, Vector3, Vector3 > Urho3D::ParticleGraphNodes::TemplateNode< TimeStepInstance, float > Urho3D::ParticleGraphNodes::TemplateNode< WorldToLocalInstance, Matrix3x4 > Urho3D::ParticleGraphNodes::Attribute Urho3D::ParticleGraphNodes::Constant Urho3D::ParticleGraphNodes::Curve Urho3D::ParticleGraphNodes::PatternMatchingNode Urho3D::ParticleGraphNodes::Print Urho3D::ParticleGraphNodes::Random Urho3D::ParticleGraphNodes::TemplateNode< Instance, Values > Urho3D::ParticleGraphNodes::Uniform

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.
 
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 ObjectReflectionGetReflection () const
 Return reflection used for serialization.
 
virtual const ea::vector< AttributeInfo > * GetAttributes () const
 Return attribute descriptions, or null if none defined.
 
void SerializeInBlock (Archive &archive) override
 Serialize content from/to archive. May throw ArchiveException.
 
void SerializeInBlock (Archive &archive, bool serializeTemporary)
 
virtual bool Load (Deserializer &source)
 Load from binary data. Return true if successful.
 
virtual bool Save (Serializer &dest) const
 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) const
 Save as XML data. Return true if successful.
 
virtual bool LoadJSON (const JSONValue &source)
 Load from JSON data. Return true if successful.
 
virtual bool SaveJSON (JSONValue &dest) const
 Save as JSON data. Return true if successful.
 
virtual bool Load (const ea::string &resourceName)
 Load from binary resource.
 
virtual bool LoadXML (const ea::string &resourceName)
 Load from XML resource.
 
virtual bool LoadJSON (const ea::string &resourceName)
 Load from JSON resource.
 
virtual bool LoadFile (const ea::string &resourceName)
 Load from resource of automatically detected type.
 
virtual void ApplyAttributes ()
 Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
 
virtual bool SaveDefaultAttributes (const AttributeInfo &attr) const
 Return whether should save default-valued attributes into XML. Default false.
 
bool SetAttribute (unsigned index, const Variant &value)
 
bool SetAttribute (const ea::string &name, const Variant &value)
 Set attribute by name. Return true if successfully set.
 
void SetInstanceDefault (bool enable)
 (Internal use) Set instance-level default flag.
 
void SetInstanceDefault (const ea::string &name, const Variant &defaultValue)
 (Internal use) Set instance-level default value. Allocate the internal data structure as necessary.
 
virtual Variant GetInstanceDefault (const ea::string &name) const
 (Internal use) Get instance-level default value.
 
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)
 
Variant GetAttribute (unsigned index) const
 
Variant GetAttribute (const ea::string &name) const
 Return attribute value by name. Return empty if not found.
 
Variant GetAttributeDefault (unsigned index) const
 
Variant GetAttributeDefault (const ea::string &name) const
 Return attribute default value by name. Return empty if not found.
 
unsigned GetNumAttributes () const
 
void CopyAttributes (const Serializable *source, bool resetToDefault=true)
 Copy all attributes from another serializable.
 
bool IsTemporary () const
 
- 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 ea::string & GetTypeName () const =0
 
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual bool IsInstanceOf (StringHash type) const =0
 Check whether current instance implements specified type.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
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 SubscribeToEventManual (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
 
template<class T >
void SubscribeToEvent (StringHash eventType, T handler)
 Subscribe to an event that can be sent by any sender.
 
template<class T >
void SubscribeToEvent (Object *sender, StringHash eventType, T 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 ea::vector< StringHash > &exceptions)
 Unsubscribe from all events except those listed.
 
void UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
 Unsubscribe from all events except those with listed senders.
 
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, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
 
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 ea::string & GetCategory () const
 
void SendEvent (StringHash eventType, const VariantMap &eventData)
 Send event with parameters to all subscribers.
 
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.
 
int AddRef ()
 
int ReleaseRef ()
 
int Refs () const
 
int WeakRefs () const
 
RefCountRefCountPtr () const
 Return pointer to the reference count structure.
 
bool HasScriptObject () const
 Return true if script runtime object wrapping this native object exists.
 
bool IsScriptStrongRef () const
 Return true if script reference is strong.
 

Protected Attributes

ea::unique_ptr< 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.
 
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.
 

Private Member Functions

 URHO3D_OBJECT (Serializable, Object)
 

Additional Inherited Members

- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 
- Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 > TypeHierarchy {}
 

Detailed Description

Base class for objects with automatic serialization through attributes.

Member Function Documentation

◆ GetAttribute()

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

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

◆ GetAttributeDefault()

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

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

◆ GetNumAttributes()

unsigned Urho3D::Serializable::GetNumAttributes ( ) const

Return number of attributes.

◆ IsTemporary()

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

Return whether is temporary.

◆ SetAttribute()

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

Set attribute by index. Return true if successfully set.

◆ SetTemporary()

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

Set temporary flag. Temporary objects will not be saved.


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