Add SoftObjectReference for lazy references to assets and objects

Source/Engine/Scripting/Object.cs

@@ -205,6 +205,11 @@ namespace FlaxEngine
             return obj?.__unmanagedPtr ?? IntPtr.Zero;
         }
 
+        internal static IntPtr GetUnmanagedPtr(SoftObjectReference reference)
+        {
+            return GetUnmanagedPtr(reference.Get<Object>());
+        }
+
         /// <inheritdoc />
         public override int GetHashCode()
         {

Source/Engine/Scripting/SoftObjectReference.cs

@@ -0,0 +1,80 @@
+// Copyright (c) 2012-2021 Wojciech Figat. All rights reserved.
+
+using System;
+
+namespace FlaxEngine
+{
+    /// <summary>
+    /// The scripting object soft reference. Objects gets referenced on use (ID reference is resolving it).
+    /// </summary>
+    public struct SoftObjectReference : IComparable, IComparable<SoftObjectReference>
+    {
+        private Guid _id;
+        private Object _object;
+
+        /// <summary>
+        /// Gets or sets the object identifier.
+        /// </summary>
+        public Guid ID
+        {
+            get => _id;
+            set
+            {
+                if (_id == value)
+                    return;
+                _id = value;
+                _object = null;
+            }
+        }
+
+        /// <summary>
+        /// Gets the object reference.
+        /// </summary>
+        /// <typeparam name="T">The object type.</typeparam>
+        /// <returns>The resolved object or null.</returns>
+        public T Get<T>() where T : Object
+        {
+            if (!_object)
+                _object = Object.Find(ref _id, typeof(T));
+            return _object as T;
+        }
+
+        /// <summary>
+        /// Sets the object reference.
+        /// </summary>
+        /// <param name="obj">The object.</param>
+        public void Set(Object obj)
+        {
+            _object = obj;
+            _id = obj?.ID ?? Guid.Empty;
+        }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            if (_object)
+                return _object.ToString();
+            return _id.ToString();
+        }
+
+        /// <inheritdoc />
+        public override int GetHashCode()
+        {
+            return _id.GetHashCode();
+        }
+
+        /// <inheritdoc />
+        public int CompareTo(object obj)
+        {
+            if (obj is SoftObjectReference other)
+                return CompareTo(other);
+            return 0;
+        }
+
+        /// <inheritdoc />
+        public int CompareTo(SoftObjectReference other)
+        {
+            return _id.CompareTo(other._id);
+        }
+    }
+}

Source/Engine/Scripting/SoftObjectReference.h

@@ -0,0 +1,327 @@
+// Copyright (c) 2012-2021 Wojciech Figat. All rights reserved.
+
+#pragma once
+
+#include "Engine/Scripting/ScriptingObject.h"
+
+// Don't include Scripting.h but just FindObject method
+extern FLAXENGINE_API ScriptingObject* FindObject(const Guid& id, MClass* type);
+
+/// <summary>
+/// The scripting object soft reference. Objects gets referenced on use (ID reference is resolving it).
+/// </summary>
+class FLAXENGINE_API SoftObjectReferenceBase
+{
+public:
+
+    typedef Delegate<> EventType;
+
+protected:
+
+    ScriptingObject* _object = nullptr;
+    Guid _id = Guid::Empty;
+
+public:
+
+    /// <summary>
+    /// Action fired when reference gets changed.
+    /// </summary>
+    EventType Changed;
+
+public:
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SoftObjectReferenceBase"/> class.
+    /// </summary>
+    SoftObjectReferenceBase()
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SoftObjectReferenceBase"/> class.
+    /// </summary>
+    /// <param name="obj">The object to link.</param>
+    SoftObjectReferenceBase(ScriptingObject* obj)
+    {
+        OnSet(obj);
+    }
+
+    /// <summary>
+    /// Finalizes an instance of the <see cref="SoftObjectReference"/> class.
+    /// </summary>
+    ~SoftObjectReferenceBase()
+    {
+        if (_object)
+            _object->Deleted.Unbind<SoftObjectReferenceBase, &SoftObjectReferenceBase::OnDeleted>(this);
+    }
+
+public:
+
+    /// <summary>
+    /// Gets the object ID.
+    /// </summary>
+    /// <returns>The object ID or Guid::Empty if nothing assigned.</returns>
+    Guid GetID() const
+    {
+        return _object ? _object->GetID() : _id;
+    }
+
+protected:
+
+    /// <summary>
+    /// Sets the object.
+    /// </summary>
+    /// <param name="object">The object.</param>
+    void OnSet(ScriptingObject* object)
+    {
+        auto e = _object;
+        if (e != object)
+        {
+            if (e)
+                e->Deleted.Unbind<SoftObjectReferenceBase, &SoftObjectReferenceBase::OnDeleted>(this);
+            _object = e = object;
+            _id = e ? e->GetID() : Guid::Empty;
+            if (e)
+                e->Deleted.Bind<SoftObjectReferenceBase, &SoftObjectReferenceBase::OnDeleted>(this);
+            Changed();
+        }
+    }
+
+    void OnDeleted(ScriptingObject* obj)
+    {
+        ASSERT(_object == obj);
+        _object->Deleted.Unbind<SoftObjectReferenceBase, &SoftObjectReferenceBase::OnDeleted>(this);
+        _object = nullptr;
+        Changed();
+    }
+};
+
+/// <summary>
+/// The scripting object soft reference. Objects gets referenced on use (ID reference is resolving it).
+/// </summary>
+template<typename T>
+API_CLASS(InBuild) class SoftObjectReference : public SoftObjectReferenceBase
+{
+public:
+
+    typedef SoftObjectReference<T> Type;
+
+public:
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SoftObjectReference"/> class.
+    /// </summary>
+    SoftObjectReference()
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SoftObjectReference"/> class.
+    /// </summary>
+    /// <param name="obj">The object to link.</param>
+    SoftObjectReference(T* obj)
+        : SoftObjectReferenceBase(obj)
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SoftObjectReference"/> class.
+    /// </summary>
+    /// <param name="other">The other property.</param>
+    SoftObjectReference(const SoftObjectReference& other)
+        : SoftObjectReferenceBase(other.Get())
+    {
+    }
+
+    /// <summary>
+    /// Finalizes an instance of the <see cref="SoftObjectReference"/> class.
+    /// </summary>
+    ~SoftObjectReference()
+    {
+    }
+
+public:
+
+    /// <summary>
+    /// Compares the property value with the given object.
+    /// </summary>
+    /// <param name="other">The other.</param>
+    /// <returns>True if property object equals the given value.</returns>
+    FORCE_INLINE bool operator==(T* other)
+    {
+        return Get() == other;
+    }
+
+    /// <summary>
+    /// Compares the property value with the other property value.
+    /// </summary>
+    /// <param name="other">The other property.</param>
+    /// <returns>True if properties are equal.</returns>
+    FORCE_INLINE bool operator==(const SoftObjectReference& other)
+    {
+        return _id == other._id;
+    }
+
+    /// <summary>
+    /// Compares the property value with the given object.
+    /// </summary>
+    /// <param name="other">The other.</param>
+    /// <returns>True if property object not equals the given value.</returns>
+    FORCE_INLINE bool operator!=(T* other)
+    {
+        return Get() != other;
+    }
+
+    /// <summary>
+    /// Compares the property value with the other property value.
+    /// </summary>
+    /// <param name="other">The other property.</param>
+    /// <returns>True if properties are not equal.</returns>
+    FORCE_INLINE bool operator!=(const SoftObjectReference& other)
+    {
+        return _id != other._id;
+    }
+
+    /// <summary>
+    /// Sets the property to the given property value.
+    /// </summary>
+    /// <param name="other">The other property.</param>
+    /// <returns>The reference to this property.</returns>
+    SoftObjectReference& operator=(const SoftObjectReference& other)
+    {
+        if (this != &other)
+            OnSet(other.Get());
+        return *this;
+    }
+
+    /// <summary>
+    /// Sets the property to the given value.
+    /// </summary>
+    /// <param name="other">The object.</param>
+    /// <returns>The reference to this property.</returns>
+    FORCE_INLINE SoftObjectReference& operator=(const T& other)
+    {
+        OnSet(&other);
+        return *this;
+    }
+
+    /// <summary>
+    /// Sets the property to the given value.
+    /// </summary>
+    /// <param name="other">The object.</param>
+    /// <returns>The reference to this property.</returns>
+    FORCE_INLINE SoftObjectReference& operator=(T* other)
+    {
+        OnSet(other);
+        return *this;
+    }
+
+    /// <summary>
+    /// Sets the property to the object of the given ID.
+    /// </summary>
+    /// <param name="id">The object ID.</param>
+    /// <returns>The reference to this property.</returns>
+    FORCE_INLINE SoftObjectReference& operator=(const Guid& id)
+    {
+        Set(id);
+        return *this;
+    }
+
+    /// <summary>
+    /// Implicit conversion to the object.
+    /// </summary>
+    /// <returns>The object reference.</returns>
+    FORCE_INLINE operator T*() const
+    {
+        return (T*)Get();
+    }
+
+    /// <summary>
+    /// Implicit conversion to boolean value.
+    /// </summary>
+    /// <returns>True if object has been assigned, otherwise false</returns>
+    FORCE_INLINE operator bool() const
+    {
+        return _object != nullptr || _id.IsValid();
+    }
+
+    /// <summary>
+    /// Object accessor.
+    /// </summary>
+    /// <returns>The object reference.</returns>
+    FORCE_INLINE T* operator->() const
+    {
+        return (T*)Get();
+    }
+
+    /// <summary>
+    /// Gets the object pointer.
+    /// </summary>
+    /// <returns>The object reference.</returns>
+    T* Get() const
+    {
+        if (!_object)
+            const_cast<SoftObjectReference*>(this)->OnSet(FindObject(_id, T::GetStaticClass()));
+        return (T*)_object;
+    }
+
+    /// <summary>
+    /// Gets the object as a given type (static cast).
+    /// </summary>
+    /// <returns>Asset</returns>
+    template<typename U>
+    FORCE_INLINE U* As() const
+    {
+        return static_cast<U*>(Get());
+    }
+
+public:
+
+    /// <summary>
+    /// Gets managed instance object (or null if no object linked).
+    /// </summary>
+    /// <returns>The managed object instance.</returns>
+    MonoObject* GetManagedInstance() const
+    {
+        auto object = Get();
+        return object ? object->GetOrCreateManagedInstance() : nullptr;
+    }
+
+    /// <summary>
+    /// Determines whether object is assigned and managed instance of the object is alive.
+    /// </summary>
+    /// <returns>True if managed object has been created and exists, otherwise false.</returns>
+    bool HasManagedInstance() const
+    {
+        auto object = Get();
+        return object && object->HasManagedInstance();
+    }
+
+    /// <summary>
+    /// Gets the managed instance object or creates it if missing or null if not assigned.
+    /// </summary>
+    /// <returns>The Mono managed object.</returns>
+    MonoObject* GetOrCreateManagedInstance() const
+    {
+        auto object = Get();
+        return object ? object->GetOrCreateManagedInstance() : nullptr;
+    }
+
+    /// <summary>
+    /// Sets the object.
+    /// </summary>
+    /// <param name="id">The object ID. Uses Scripting to find the registered object of the given ID.</param>
+    FORCE_INLINE void Set(const Guid& id)
+    {
+        Set(static_cast<T*>(FindObject(id, T::GetStaticClass())));
+    }
+
+    /// <summary>
+    /// Sets the object.
+    /// </summary>
+    /// <param name="object">The object.</param>
+    FORCE_INLINE void Set(T* object)
+    {
+        OnSet(object);
+    }
+};

Source/Engine/Serialization/JsonSerializer.cs

@@ -87,6 +87,38 @@ namespace FlaxEngine.Json
         }
     }
 
+    /// <summary>
+    /// Serialize SoftObjectReference as Guid in internal format.
+    /// </summary>
+    /// <seealso cref="Newtonsoft.Json.JsonConverter" />
+    internal class SoftObjectReferenceConverter : JsonConverter
+    {
+        /// <inheritdoc />
+        public override unsafe void WriteJson(JsonWriter writer, object value, Newtonsoft.Json.JsonSerializer serializer)
+        {
+            var id = ((SoftObjectReference)value).ID;
+            writer.WriteValue(JsonSerializer.GetStringID(&id));
+        }
+
+        /// <inheritdoc />
+        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, Newtonsoft.Json.JsonSerializer serializer)
+        {
+            var result = new SoftObjectReference();
+            if (reader.TokenType == JsonToken.String)
+            {
+                JsonSerializer.ParseID((string)reader.Value, out var id);
+                result.ID = id;
+            }
+            return result;
+        }
+
+        /// <inheritdoc />
+        public override bool CanConvert(Type objectType)
+        {
+            return objectType == typeof(SoftObjectReference);
+        }
+    }
+
     /*
     /// <summary>
     /// Serialize Guid values using `N` format
@@ -184,6 +216,7 @@ namespace FlaxEngine.Json
                 ObjectConverter = new FlaxObjectConverter();
             settings.Converters.Add(ObjectConverter);
             settings.Converters.Add(new SceneReferenceConverter());
+            settings.Converters.Add(new SoftObjectReferenceConverter());
             settings.Converters.Add(new VersionConverter());
             //settings.Converters.Add(new GuidConverter());
             return settings;

Source/Engine/Serialization/Serialization.h

@@ -9,6 +9,7 @@
 #include "Engine/Core/Collections/Array.h"
 #include "Engine/Core/Collections/Dictionary.h"
 #include "Engine/Scripting/ScriptingObjectReference.h"
+#include "Engine/Scripting/SoftObjectReference.h"
 #include "Engine/Content/AssetReference.h"
 #include "Engine/Content/WeakAssetReference.h"
 
@@ -457,6 +458,27 @@ namespace Serialization
         v = id;
     }
 
+    // Soft Object Reference
+
+    template<typename T>
+    inline bool ShouldSerialize(const SoftObjectReference<T>& v, const void* otherObj)
+    {
+        return !otherObj || v.Get() != ((SoftObjectReference<T>*)otherObj)->Get();
+    }
+    template<typename T>
+    inline void Serialize(ISerializable::SerializeStream& stream, const SoftObjectReference<T>& v, const void* otherObj)
+    {
+        stream.Guid(v.GetID());
+    }
+    template<typename T>
+    inline void Deserialize(ISerializable::DeserializeStream& stream, SoftObjectReference<T>& v, ISerializeModifier* modifier)
+    {
+        Guid id;
+        Deserialize(stream, id, modifier);
+		modifier->IdsMapping.TryGet(id, id);
+        v = id;
+    }
+
     // Asset Reference
 
     template<typename T>

Source/Tools/Flax.Build/Bindings/BindingsGenerator.CSharp.cs

@@ -132,8 +132,8 @@ namespace Flax.Build.Bindings
                 return result;
             }
 
-            // ScriptingObjectReference or AssetReference or WeakAssetReference
+            // ScriptingObjectReference or AssetReference or WeakAssetReference or SoftObjectReference
-            if ((typeInfo.Type == "ScriptingObjectReference" || typeInfo.Type == "AssetReference" || typeInfo.Type == "WeakAssetReference") && typeInfo.GenericArgs != null)
+            if ((typeInfo.Type == "ScriptingObjectReference" || typeInfo.Type == "AssetReference" || typeInfo.Type == "WeakAssetReference" || typeInfo.Type == "SoftObjectReference") && typeInfo.GenericArgs != null)
                 return typeInfo.GenericArgs[0].Type.Replace("::", ".");
 
             // Array or Span
@@ -188,8 +188,8 @@ namespace Flax.Build.Bindings
                     return "IntPtr";
             }
 
-            // ScriptingObjectReference or AssetReference or WeakAssetReference
+            // ScriptingObjectReference or AssetReference or WeakAssetReference or SoftObjectReference
-            if ((typeInfo.Type == "ScriptingObjectReference" || typeInfo.Type == "AssetReference" || typeInfo.Type == "WeakAssetReference") && typeInfo.GenericArgs != null)
+            if ((typeInfo.Type == "ScriptingObjectReference" || typeInfo.Type == "AssetReference" || typeInfo.Type == "WeakAssetReference" || typeInfo.Type == "SoftObjectReference") && typeInfo.GenericArgs != null)
                 return "IntPtr";
 
             return GenerateCSharpNativeToManaged(buildData, typeInfo, caller);
@@ -231,8 +231,8 @@ namespace Flax.Build.Bindings
                         return "FlaxEngine.Object.GetUnmanagedPtr";
                 }
 
-                // ScriptingObjectReference or AssetReference or WeakAssetReference
+                // ScriptingObjectReference or AssetReference or WeakAssetReference or SoftObjectReference
-                if ((typeInfo.Type == "ScriptingObjectReference" || typeInfo.Type == "AssetReference" || typeInfo.Type == "WeakAssetReference") && typeInfo.GenericArgs != null)
+                if ((typeInfo.Type == "ScriptingObjectReference" || typeInfo.Type == "AssetReference" || typeInfo.Type == "WeakAssetReference" || typeInfo.Type == "SoftObjectReference") && typeInfo.GenericArgs != null)
                     return "FlaxEngine.Object.GetUnmanagedPtr";
 
                 // Default

Source/Tools/Flax.Build/Bindings/BindingsGenerator.Cpp.cs

@@ -100,7 +100,7 @@ namespace Flax.Build.Bindings
                 return value;
             if (typeInfo.Type == "String")
                 return $"Variant(StringView({value}))";
-            if (typeInfo.Type == "AssetReference" || typeInfo.Type == "WeakAssetReference" || typeInfo.Type == "ScriptingObjectReference")
+            if (typeInfo.Type == "AssetReference" || typeInfo.Type == "WeakAssetReference" || typeInfo.Type == "ScriptingObjectReference" || typeInfo.Type == "SoftObjectReference")
                 return $"Variant({value}.Get())";
             if (typeInfo.IsArray)
             {
@@ -149,7 +149,7 @@ namespace Flax.Build.Bindings
                 return $"((StringView){value}).GetText()";
             if (typeInfo.Type == "AssetReference" || typeInfo.Type == "WeakAssetReference")
                 return $"ScriptingObject::Cast<{typeInfo.GenericArgs[0].Type}>((Asset*){value})";
-            if (typeInfo.Type == "ScriptingObjectReference")
+            if (typeInfo.Type == "ScriptingObjectReference" || typeInfo.Type == "SoftObjectReference")
                 return $"ScriptingObject::Cast<{typeInfo.GenericArgs[0].Type}>((ScriptingObject*){value})";
             if (typeInfo.IsArray)
                 throw new Exception($"Not supported type to convert from the Variant to fixed-size array '{typeInfo}[{typeInfo.ArraySize}]'.");
@@ -340,8 +340,8 @@ namespace Flax.Build.Bindings
                     }
                 }
 
-                // ScriptingObjectReference or AssetReference or WeakAssetReference
+                // ScriptingObjectReference or AssetReference or WeakAssetReference or SoftObjectReference
-                if ((typeInfo.Type == "ScriptingObjectReference" || typeInfo.Type == "AssetReference" || typeInfo.Type == "WeakAssetReference") && typeInfo.GenericArgs != null)
+                if ((typeInfo.Type == "ScriptingObjectReference" || typeInfo.Type == "AssetReference" || typeInfo.Type == "WeakAssetReference" || typeInfo.Type == "SoftObjectReference") && typeInfo.GenericArgs != null)
                 {
                     type = "MonoObject*";
                     return "{0}.GetManagedInstance()";
@@ -448,8 +448,8 @@ namespace Flax.Build.Bindings
                 type = "MonoReflectionType*";
                 return "MUtils::UnboxVariantType({0})";
             default:
-                // ScriptingObjectReference or AssetReference or WeakAssetReference
+                // ScriptingObjectReference or AssetReference or WeakAssetReference or SoftObjectReference
-                if ((typeInfo.Type == "ScriptingObjectReference" || typeInfo.Type == "AssetReference" || typeInfo.Type == "WeakAssetReference") && typeInfo.GenericArgs != null)
+                if ((typeInfo.Type == "ScriptingObjectReference" || typeInfo.Type == "AssetReference" || typeInfo.Type == "WeakAssetReference" || typeInfo.Type == "SoftObjectReference") && typeInfo.GenericArgs != null)
                 {
                     // For non-pod types converting only, other API converts managed to unmanaged object in C# wrapper code)
                     if (CppNonPodTypesConvertingGeneration)