diff --git a/Source/Editor/CustomEditors/CustomEditorsUtil.cs b/Source/Editor/CustomEditors/CustomEditorsUtil.cs
index 476219960..2323333e2 100644
--- a/Source/Editor/CustomEditors/CustomEditorsUtil.cs
+++ b/Source/Editor/CustomEditors/CustomEditorsUtil.cs
@@ -58,11 +58,13 @@ namespace FlaxEditor.CustomEditors
if (targetType.Type == typeof(object) && values.Count > 0 && values[0] != null && !values.HasDifferentTypes)
return CreateEditor(TypeUtils.GetObjectType(values[0]), canUseRefPicker);
- // Special case if property is interface but the value is implemented as Scripting Object that should use reference picker
- if (targetType.IsInterface && canUseRefPicker && values.Count > 0 && values[0] is FlaxEngine.Object)
- return new DummyEditor();
-
// Use editor for the property type
+ if (canUseRefPicker &&
+ targetType.IsInterface &&
+ values.GetAttributes().Any(x => x is ScriptingObjectInterfaceReferenceAttribute || x is SoftObjectInterfaceReferenceAttribute))
+ {
+ return new FlaxObjectRefEditor();
+ }
return CreateEditor(targetType, canUseRefPicker);
}
diff --git a/Source/Editor/CustomEditors/Editors/FlaxObjectRefEditor.cs b/Source/Editor/CustomEditors/Editors/FlaxObjectRefEditor.cs
index d7ab6d12b..289c7ec90 100644
--- a/Source/Editor/CustomEditors/Editors/FlaxObjectRefEditor.cs
+++ b/Source/Editor/CustomEditors/Editors/FlaxObjectRefEditor.cs
@@ -48,7 +48,7 @@ namespace FlaxEditor.CustomEditors.Editors
public IPresenterOwner PresenterContext;
///
- /// Gets or sets the allowed objects type (given type and all subclasses). Must be type of any subclass.
+ /// Gets or sets the allowed objects type (given type and all subclasses). Must be type of any subclass or a scripting interface.
///
public ScriptType Type
{
@@ -57,11 +57,12 @@ namespace FlaxEditor.CustomEditors.Editors
{
if (_type == value)
return;
- if (value == ScriptType.Null || (value.Type != typeof(Object) && !value.IsSubclassOf(ScriptType.Object)))
+ if (value == ScriptType.Null || (!value.IsInterface && value.Type != typeof(Object) && !value.IsSubclassOf(ScriptType.Object)))
throw new ArgumentException(string.Format("Invalid type for FlaxObjectRefEditor. Input type: {0}", value != ScriptType.Null ? value.TypeName : "null"));
_type = value;
- _supportsPickDropDown = new ScriptType(typeof(Actor)).IsAssignableFrom(value) ||
+ _supportsPickDropDown = value.IsInterface ||
+ new ScriptType(typeof(Actor)).IsAssignableFrom(value) ||
new ScriptType(typeof(Script)).IsAssignableFrom(value);
// Deselect value if it's not valid now
@@ -149,13 +150,22 @@ namespace FlaxEditor.CustomEditors.Editors
protected virtual bool IsValid(Object obj)
{
var type = TypeUtils.GetObjectType(obj);
- return obj == null || _type.IsAssignableFrom(type) && (CheckValid == null || CheckValid(obj, type));
+ return obj == null || (!_type.IsInterface || obj is SceneObject) && _type.IsAssignableFrom(type) && (CheckValid == null || CheckValid(obj, type));
}
private void ShowDropDownMenu()
{
Focus();
- if (new ScriptType(typeof(Actor)).IsAssignableFrom(_type))
+ if (_type.IsInterface)
+ {
+ SceneObjectSearchPopup.Show(this, new Float2(0, Height), IsValid, obj =>
+ {
+ Value = obj;
+ RootWindow.Focus();
+ Focus();
+ }, PresenterContext);
+ }
+ else if (new ScriptType(typeof(Actor)).IsAssignableFrom(_type))
{
ActorSearchPopup.Show(this, new Float2(0, Height), IsValid, actor =>
{
diff --git a/Source/Editor/GUI/Popups/SceneObjectSearchPopup.cs b/Source/Editor/GUI/Popups/SceneObjectSearchPopup.cs
new file mode 100644
index 000000000..4868dd049
--- /dev/null
+++ b/Source/Editor/GUI/Popups/SceneObjectSearchPopup.cs
@@ -0,0 +1,146 @@
+// Copyright (c) Wojciech Figat. All rights reserved.
+
+using System;
+using FlaxEditor.Windows;
+using FlaxEditor.Windows.Assets;
+using FlaxEngine;
+using FlaxEngine.GUI;
+using FlaxEngine.Utilities;
+
+namespace FlaxEditor.GUI
+{
+ ///
+ /// Popup that shows the list of scene objects to pick. Supports searching and basic type filtering.
+ ///
+ ///
+ public class SceneObjectSearchPopup : ItemsListContextMenu
+ {
+ ///
+ /// The scene object item.
+ ///
+ ///
+ public class SceneObjectItemView : Item
+ {
+ private SceneObject _object;
+
+ ///
+ /// Gets the scene object.
+ ///
+ public SceneObject Object => _object;
+
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The object.
+ public SceneObjectItemView(SceneObject obj)
+ {
+ _object = obj;
+ Category = obj is Actor ? "Actors" : "Scripts";
+ if (obj is Script script)
+ {
+ var type = TypeUtils.GetObjectType(script);
+ Name = script.Actor ? $"{type.Name} ({script.Actor.Name})" : type.Name;
+ }
+ else if (obj is Actor actor)
+ {
+ Name = actor.Name;
+ }
+ else
+ {
+ Name = obj.ToString();
+ }
+ TooltipText = Utilities.Utils.GetTooltip(obj);
+ }
+
+ ///
+ public override void OnDestroy()
+ {
+ _object = null;
+ base.OnDestroy();
+ }
+ }
+
+ ///
+ /// Validates if the given scene object item can be used to pick it.
+ ///
+ /// The scene object.
+ /// True if is valid.
+ public delegate bool IsValidDelegate(SceneObject obj);
+
+ private IsValidDelegate _isValid;
+ private Action _selected;
+
+ private SceneObjectSearchPopup(IsValidDelegate isValid, Action selected, CustomEditors.IPresenterOwner context)
+ {
+ _isValid = isValid;
+ _selected = selected;
+
+ ItemClicked += OnItemClicked;
+
+ if (context is PropertiesWindow || context == null)
+ {
+ // TODO: use async thread to search scenes
+ for (int i = 0; i < Level.ScenesCount; i++)
+ {
+ Find(Level.GetScene(i));
+ }
+ }
+ else if (context is PrefabWindow prefabWindow)
+ {
+ Find(prefabWindow.Graph.MainActor);
+ }
+
+ SortItems();
+ }
+
+ private void OnItemClicked(Item item)
+ {
+ _selected(((SceneObjectItemView)item).Object);
+ }
+
+ private void Find(Actor actor)
+ {
+ if (!actor)
+ return;
+
+ if (_isValid(actor))
+ AddItem(new SceneObjectItemView(actor));
+
+ for (int i = 0; i < actor.ScriptsCount; i++)
+ {
+ var script = actor.GetScript(i);
+ if (_isValid(script))
+ AddItem(new SceneObjectItemView(script));
+ }
+
+ for (int i = 0; i < actor.ChildrenCount; i++)
+ {
+ Find(actor.GetChild(i));
+ }
+ }
+
+ ///
+ /// Shows the popup.
+ ///
+ /// The show target.
+ /// The show target location.
+ /// Event called to check if a given scene object item is valid to be used.
+ /// Event called on scene object item pick.
+ /// The presenter owner context (i.e. PrefabWindow, PropertiesWindow).
+ /// The dialog.
+ public static SceneObjectSearchPopup Show(Control showTarget, Float2 showTargetLocation, IsValidDelegate isValid, Action selected, CustomEditors.IPresenterOwner context)
+ {
+ var popup = new SceneObjectSearchPopup(isValid, selected, context);
+ popup.Show(showTarget, showTargetLocation);
+ return popup;
+ }
+
+ ///
+ public override void OnDestroy()
+ {
+ _isValid = null;
+ _selected = null;
+ base.OnDestroy();
+ }
+ }
+}
diff --git a/Source/Engine/Scripting/Attributes/Editor/ScriptingObjectInterfaceReferenceAttribute.cs b/Source/Engine/Scripting/Attributes/Editor/ScriptingObjectInterfaceReferenceAttribute.cs
new file mode 100644
index 000000000..720497b2c
--- /dev/null
+++ b/Source/Engine/Scripting/Attributes/Editor/ScriptingObjectInterfaceReferenceAttribute.cs
@@ -0,0 +1,14 @@
+// Copyright (c) Wojciech Figat. All rights reserved.
+
+using System;
+
+namespace FlaxEngine
+{
+ ///
+ /// Marks a generated interface property as a native scripting object interface reference.
+ ///
+ [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
+ public sealed class ScriptingObjectInterfaceReferenceAttribute : Attribute
+ {
+ }
+}
diff --git a/Source/Engine/Scripting/Attributes/Editor/SoftObjectInterfaceReferenceAttribute.cs b/Source/Engine/Scripting/Attributes/Editor/SoftObjectInterfaceReferenceAttribute.cs
new file mode 100644
index 000000000..ec106412f
--- /dev/null
+++ b/Source/Engine/Scripting/Attributes/Editor/SoftObjectInterfaceReferenceAttribute.cs
@@ -0,0 +1,14 @@
+// Copyright (c) Wojciech Figat. All rights reserved.
+
+using System;
+
+namespace FlaxEngine
+{
+ ///
+ /// Marks a generated interface property as a native soft object interface reference.
+ ///
+ [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
+ public sealed class SoftObjectInterfaceReferenceAttribute : Attribute
+ {
+ }
+}
diff --git a/Source/Engine/Scripting/Internal/InternalCalls.h b/Source/Engine/Scripting/Internal/InternalCalls.h
index 4535952ea..d179fd8fd 100644
--- a/Source/Engine/Scripting/Internal/InternalCalls.h
+++ b/Source/Engine/Scripting/Internal/InternalCalls.h
@@ -37,7 +37,7 @@ struct FLAXENGINE_API VTableFunctionInjector
#if USE_NETCORE
#define ADD_INTERNAL_CALL(fullName, method)
-#define DEFINE_INTERNAL_CALL(returnType) extern "C" DLLEXPORT returnType
+#define DEFINE_INTERNAL_CALL(returnType) extern "C" DLLEXPORT USED returnType
#else
extern "C" FLAXENGINE_API void mono_add_internal_call(const char* name, const void* method);
#define ADD_INTERNAL_CALL(fullName, method) mono_add_internal_call(fullName, (const void*)method)
diff --git a/Source/Engine/Scripting/ManagedCLR/MUtils.h b/Source/Engine/Scripting/ManagedCLR/MUtils.h
index 5598dbee0..aed0c48c5 100644
--- a/Source/Engine/Scripting/ManagedCLR/MUtils.h
+++ b/Source/Engine/Scripting/ManagedCLR/MUtils.h
@@ -278,6 +278,10 @@ struct MConverter::Val
// Converter for ScriptingObject References.
template
class ScriptingObjectReference;
+template
+class ScriptingObjectInterfaceReference;
+template
+class SoftObjectInterfaceReference;
template
struct MConverter>
@@ -311,6 +315,50 @@ struct MConverter>
}
};
+template
+struct MInterfaceReferenceConverter
+{
+ MObject* Box(const TReference& data, const MClass* klass)
+ {
+ return data.GetManagedInstance();
+ }
+
+ void Unbox(TReference& result, MObject* data)
+ {
+ result = ScriptingObject::ToInterface(ScriptingObject::ToNative(data));
+ }
+
+ void ToManagedArray(MArray* result, const Span& data)
+ {
+ if (data.Length() == 0)
+ return;
+ MObject** objects = (MObject**)Allocator::Allocate(data.Length() * sizeof(MObject*));
+ for (int32 i = 0; i < data.Length(); i++)
+ objects[i] = data[i].GetManagedInstance();
+ MCore::GC::WriteArrayRef(result, Span(objects, data.Length()));
+ Allocator::Free(objects);
+ }
+
+ void ToNativeArray(Span& result, const MArray* data)
+ {
+ MObject** dataPtr = MCore::Array::GetAddress(data);
+ for (int32 i = 0; i < result.Length(); i++)
+ result.Get()[i] = ScriptingObject::ToInterface(ScriptingObject::ToNative(dataPtr[i]));
+ }
+};
+
+// Converter for Scripting Interface References.
+template
+struct MConverter> : MInterfaceReferenceConverter, T>
+{
+};
+
+// Converter for Soft Object Interface References.
+template
+struct MConverter> : MInterfaceReferenceConverter, T>
+{
+};
+
// Converter for Asset References.
template
class AssetReference;
diff --git a/Source/Engine/Scripting/ScriptingObjectInterfaceReference.h b/Source/Engine/Scripting/ScriptingObjectInterfaceReference.h
new file mode 100644
index 000000000..65c479075
--- /dev/null
+++ b/Source/Engine/Scripting/ScriptingObjectInterfaceReference.h
@@ -0,0 +1,195 @@
+// Copyright (c) Wojciech Figat. All rights reserved.
+
+#pragma once
+
+#include "Engine/Scripting/ScriptingObjectInterfaceReferenceUtils.h"
+
+///
+/// The scene object interface reference.
+///
+/// The type of the scripting interface.
+template
+API_CLASS(InBuild) class ScriptingObjectInterfaceReference : public ScriptingObjectReferenceBase
+{
+ typedef ScriptingObjectInterfaceReferenceHelper Helper;
+
+public:
+ typedef ScriptingObjectInterfaceReference Type;
+
+public:
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ ScriptingObjectInterfaceReference()
+ {
+ }
+
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The object to link.
+ ScriptingObjectInterfaceReference(SceneObject* obj)
+ : ScriptingObjectReferenceBase(Helper::IsValidObject(obj) ? obj : nullptr)
+ {
+ }
+
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The interface object to link.
+ ScriptingObjectInterfaceReference(T* interfaceObj)
+ : ScriptingObjectReferenceBase(Helper::GetSceneObject(interfaceObj))
+ {
+ }
+
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The other property.
+ ScriptingObjectInterfaceReference(const ScriptingObjectInterfaceReference& other)
+ : ScriptingObjectReferenceBase(other._object)
+ {
+ }
+
+ ScriptingObjectInterfaceReference(ScriptingObjectInterfaceReference&& other) noexcept
+ : ScriptingObjectReferenceBase(MoveTemp(other))
+ {
+ }
+
+ ///
+ /// Finalizes an instance of the class.
+ ///
+ ~ScriptingObjectInterfaceReference()
+ {
+ }
+
+public:
+ FORCE_INLINE bool operator==(SceneObject* other) const
+ {
+ return _object == other;
+ }
+
+ FORCE_INLINE bool operator!=(SceneObject* other) const
+ {
+ return _object != other;
+ }
+
+ FORCE_INLINE bool operator==(T* other) const
+ {
+ return Get() == other;
+ }
+
+ FORCE_INLINE bool operator!=(T* other) const
+ {
+ return Get() != other;
+ }
+
+ FORCE_INLINE bool operator==(const ScriptingObjectInterfaceReference& other) const
+ {
+ return _object == other._object;
+ }
+
+ FORCE_INLINE bool operator!=(const ScriptingObjectInterfaceReference& other) const
+ {
+ return _object != other._object;
+ }
+
+ FORCE_INLINE ScriptingObjectInterfaceReference& operator=(SceneObject* other)
+ {
+ OnSet(Helper::IsValidObject(other) ? other : nullptr);
+ return *this;
+ }
+
+ FORCE_INLINE ScriptingObjectInterfaceReference& operator=(T* other)
+ {
+ OnSet(Helper::GetSceneObject(other));
+ return *this;
+ }
+
+ ScriptingObjectInterfaceReference& operator=(const ScriptingObjectInterfaceReference& other)
+ {
+ OnSet(other._object);
+ return *this;
+ }
+
+ ScriptingObjectInterfaceReference& operator=(ScriptingObjectInterfaceReference&& other) noexcept
+ {
+ ScriptingObjectReferenceBase::operator=(MoveTemp(other));
+ return *this;
+ }
+
+ FORCE_INLINE ScriptingObjectInterfaceReference& operator=(const Guid& id)
+ {
+ OnSet(Helper::FindSceneObject(id));
+ return *this;
+ }
+
+ ///
+ /// Implicit conversion to the interface.
+ ///
+ FORCE_INLINE operator T*() const
+ {
+ return Get();
+ }
+
+ ///
+ /// Implicit conversion to boolean value.
+ ///
+ FORCE_INLINE operator bool() const
+ {
+ return _object != nullptr;
+ }
+
+ ///
+ /// Interface accessor.
+ ///
+ FORCE_INLINE T* operator->() const
+ {
+ return Get();
+ }
+
+ ///
+ /// Gets the interface pointer.
+ ///
+ FORCE_INLINE T* Get() const
+ {
+ return ScriptingObject::ToInterface(_object);
+ }
+
+ ///
+ /// Gets the referenced object.
+ ///
+ FORCE_INLINE SceneObject* GetObject() const
+ {
+ return static_cast(_object);
+ }
+
+ ///
+ /// Copies the object ID into the raw storage.
+ ///
+ FORCE_INLINE void CopyID(uint32 id[4]) const
+ {
+ memset(id, 0, sizeof(uint32) * 4);
+ if (_object)
+ {
+ const Guid value = GetID();
+ memcpy(id, &value, sizeof(uint32) * 4);
+ }
+ }
+
+ ///
+ /// Gets the object as a given type (static cast).
+ ///
+ template
+ FORCE_INLINE U* As() const
+ {
+ return static_cast(_object);
+ }
+
+};
+
+template
+uint32 GetHash(const ScriptingObjectInterfaceReference& key)
+{
+ return GetHash(key.GetID());
+}
diff --git a/Source/Engine/Scripting/ScriptingObjectInterfaceReferenceUtils.h b/Source/Engine/Scripting/ScriptingObjectInterfaceReferenceUtils.h
new file mode 100644
index 000000000..d18df3d80
--- /dev/null
+++ b/Source/Engine/Scripting/ScriptingObjectInterfaceReferenceUtils.h
@@ -0,0 +1,30 @@
+// Copyright (c) Wojciech Figat. All rights reserved.
+
+#pragma once
+
+#include "Engine/Scripting/ScriptingObjectReference.h"
+#include "Engine/Level/SceneObject.h"
+
+///
+/// Utility methods for scene object interface references.
+///
+/// The type of the scripting interface.
+template
+struct ScriptingObjectInterfaceReferenceHelper
+{
+ FORCE_INLINE static bool IsValidObject(const SceneObject* obj)
+ {
+ return !obj || obj->GetType().GetInterface(T::TypeInitializer) != nullptr;
+ }
+
+ FORCE_INLINE static SceneObject* GetSceneObject(T* interfaceObj)
+ {
+ return ScriptingObject::Cast(ScriptingObject::FromInterface(interfaceObj));
+ }
+
+ FORCE_INLINE static SceneObject* FindSceneObject(const Guid& id)
+ {
+ SceneObject* obj = static_cast(FindObject(id, SceneObject::GetStaticClass()));
+ return IsValidObject(obj) ? obj : nullptr;
+ }
+};
diff --git a/Source/Engine/Scripting/SoftObjectInterfaceReference.h b/Source/Engine/Scripting/SoftObjectInterfaceReference.h
new file mode 100644
index 000000000..0814f4927
--- /dev/null
+++ b/Source/Engine/Scripting/SoftObjectInterfaceReference.h
@@ -0,0 +1,258 @@
+// Copyright (c) Wojciech Figat. All rights reserved.
+
+#pragma once
+
+#include "Engine/Scripting/SoftObjectReference.h"
+#include "Engine/Scripting/ScriptingObjectInterfaceReferenceUtils.h"
+
+///
+/// The scene object soft interface reference. Objects gets referenced on use (ID reference is resolving it).
+///
+/// The type of the scripting interface.
+template
+API_CLASS(InBuild) class SoftObjectInterfaceReference : public SoftObjectReferenceBase
+{
+ typedef ScriptingObjectInterfaceReferenceHelper Helper;
+
+public:
+ typedef SoftObjectInterfaceReference Type;
+
+public:
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ SoftObjectInterfaceReference()
+ {
+ }
+
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The object to link.
+ SoftObjectInterfaceReference(SceneObject* obj)
+ {
+ OnSet(Helper::IsValidObject(obj) ? obj : nullptr);
+ }
+
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The interface object to link.
+ SoftObjectInterfaceReference(T* interfaceObj)
+ {
+ OnSet(Helper::GetSceneObject(interfaceObj));
+ }
+
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The other property.
+ SoftObjectInterfaceReference(const SoftObjectInterfaceReference& other)
+ {
+ OnSet(other.GetID());
+ }
+
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The other property.
+ SoftObjectInterfaceReference(SoftObjectInterfaceReference&& other)
+ {
+ OnSet(other.GetID());
+ other.OnSet(nullptr);
+ }
+
+ ///
+ /// Finalizes an instance of the class.
+ ///
+ ~SoftObjectInterfaceReference()
+ {
+ }
+
+public:
+ FORCE_INLINE bool operator==(SceneObject* other)
+ {
+ return GetObject() == other;
+ }
+
+ FORCE_INLINE bool operator!=(SceneObject* other)
+ {
+ return GetObject() != other;
+ }
+
+ FORCE_INLINE bool operator==(T* other)
+ {
+ return Get() == other;
+ }
+
+ FORCE_INLINE bool operator!=(T* other)
+ {
+ return Get() != other;
+ }
+
+ FORCE_INLINE bool operator==(const SoftObjectInterfaceReference& other)
+ {
+ return GetID() == other.GetID();
+ }
+
+ FORCE_INLINE bool operator!=(const SoftObjectInterfaceReference& other)
+ {
+ return GetID() != other.GetID();
+ }
+
+ SoftObjectInterfaceReference& operator=(const SoftObjectInterfaceReference& other)
+ {
+ if (this != &other)
+ OnSet(other.GetID());
+ return *this;
+ }
+
+ SoftObjectInterfaceReference& operator=(SoftObjectInterfaceReference&& other)
+ {
+ if (this != &other)
+ {
+ OnSet(other.GetID());
+ other.OnSet(nullptr);
+ }
+ return *this;
+ }
+
+ FORCE_INLINE SoftObjectInterfaceReference& operator=(SceneObject* other)
+ {
+ OnSet(Helper::IsValidObject(other) ? other : nullptr);
+ return *this;
+ }
+
+ FORCE_INLINE SoftObjectInterfaceReference& operator=(T* other)
+ {
+ OnSet(Helper::GetSceneObject(other));
+ return *this;
+ }
+
+ FORCE_INLINE SoftObjectInterfaceReference& operator=(const Guid& id)
+ {
+ OnSet(id);
+ return *this;
+ }
+
+ ///
+ /// Implicit conversion to the interface.
+ ///
+ FORCE_INLINE operator T*() const
+ {
+ return Get();
+ }
+
+ ///
+ /// Implicit conversion to boolean value.
+ ///
+ FORCE_INLINE operator bool() const
+ {
+ return Get() != nullptr;
+ }
+
+ ///
+ /// Interface accessor.
+ ///
+ FORCE_INLINE T* operator->() const
+ {
+ return Get();
+ }
+
+ ///
+ /// Gets the object as a given type (static cast).
+ ///
+ template
+ FORCE_INLINE U* As() const
+ {
+ return static_cast(GetObject());
+ }
+
+public:
+ ///
+ /// Gets the interface pointer.
+ ///
+ FORCE_INLINE T* Get() const
+ {
+ return ScriptingObject::ToInterface(GetObject());
+ }
+
+ ///
+ /// Gets the referenced object.
+ ///
+ SceneObject* GetObject() const
+ {
+ if (!_object)
+ const_cast(this)->OnResolve(SceneObject::GetStaticClass());
+ return Helper::IsValidObject(static_cast(_object)) ? static_cast(_object) : nullptr;
+ }
+
+ ///
+ /// Gets managed instance object (or null if no object linked).
+ ///
+ MObject* GetManagedInstance() const
+ {
+ auto object = GetObject();
+ return object ? object->GetOrCreateManagedInstance() : nullptr;
+ }
+
+ ///
+ /// Determines whether object is assigned and managed instance of the object is alive.
+ ///
+ bool HasManagedInstance() const
+ {
+ auto object = GetObject();
+ return object && object->HasManagedInstance();
+ }
+
+ ///
+ /// Gets the managed instance object or creates it if missing or null if not assigned.
+ ///
+ MObject* GetOrCreateManagedInstance() const
+ {
+ auto object = GetObject();
+ return object ? object->GetOrCreateManagedInstance() : nullptr;
+ }
+
+ ///
+ /// Copies the object ID into the raw storage.
+ ///
+ FORCE_INLINE void CopyID(uint32 id[4]) const
+ {
+ const Guid value = GetID();
+ memcpy(id, &value, sizeof(uint32) * 4);
+ }
+
+ ///
+ /// Sets the object.
+ ///
+ /// The object ID. Uses Scripting to find the registered object of the given ID.
+ FORCE_INLINE void Set(const Guid& id)
+ {
+ OnSet(id);
+ }
+
+ ///
+ /// Sets the object.
+ ///
+ /// The object.
+ FORCE_INLINE void Set(SceneObject* object)
+ {
+ OnSet(Helper::IsValidObject(object) ? object : nullptr);
+ }
+
+ ///
+ /// Sets the object.
+ ///
+ /// The interface object.
+ FORCE_INLINE void Set(T* interfaceObj)
+ {
+ OnSet(Helper::GetSceneObject(interfaceObj));
+ }
+};
+
+template
+uint32 GetHash(const SoftObjectInterfaceReference& key)
+{
+ return GetHash(key.GetID());
+}
diff --git a/Source/Engine/Serialization/ReadStream.h b/Source/Engine/Serialization/ReadStream.h
index cc2b7e73b..d8868c67e 100644
--- a/Source/Engine/Serialization/ReadStream.h
+++ b/Source/Engine/Serialization/ReadStream.h
@@ -133,6 +133,14 @@ public:
v = ptr;
}
+ template
+ FORCE_INLINE void Read(ScriptingObjectInterfaceReference& v)
+ {
+ uint32 id[4];
+ ReadBytes(id, sizeof(id));
+ v = *(Guid*)id;
+ }
+
template
FORCE_INLINE void Read(SoftObjectReference& v)
{
@@ -141,6 +149,14 @@ public:
v.Set(*(Guid*)id);
}
+ template
+ FORCE_INLINE void Read(SoftObjectInterfaceReference& v)
+ {
+ uint32 id[4];
+ ReadBytes(id, sizeof(id));
+ v.Set(*(Guid*)id);
+ }
+
template
FORCE_INLINE void Read(AssetReference& v)
{
diff --git a/Source/Engine/Serialization/Serialization.h b/Source/Engine/Serialization/Serialization.h
index 9af6d7be1..4031ba2ba 100644
--- a/Source/Engine/Serialization/Serialization.h
+++ b/Source/Engine/Serialization/Serialization.h
@@ -14,8 +14,12 @@ struct VariantType;
template
class ScriptingObjectReference;
template
+class ScriptingObjectInterfaceReference;
+template
class SoftObjectReference;
template
+class SoftObjectInterfaceReference;
+template
class AssetReference;
template
class WeakAssetReference;
@@ -454,7 +458,6 @@ namespace Serialization
}
FLAXENGINE_API bool ShouldSerializeRef(const SceneObject* v, const SceneObject* other);
-
template
inline typename TEnableIf, TNot>>::Value, bool>::Type ShouldSerialize(const T* v, const void* otherObj)
{
@@ -470,7 +473,7 @@ namespace Serialization
{
Guid id;
Deserialize(stream, id, modifier);
- modifier->IdsMapping.TryGet(id, id);
+ modifier->IdsMapping.TryGet(id, id);
v = (T*)::FindObject(id, T::GetStaticClass());
}
@@ -497,7 +500,28 @@ namespace Serialization
{
Guid id;
Deserialize(stream, id, modifier);
- modifier->IdsMapping.TryGet(id, id);
+ modifier->IdsMapping.TryGet(id, id);
+ v = id;
+ }
+
+ // Scripting Interface Reference
+
+ template
+ inline bool ShouldSerialize(const ScriptingObjectInterfaceReference& v, const void* otherObj)
+ {
+ return !otherObj || ShouldSerializeRef(v.GetObject(), ((ScriptingObjectInterfaceReference*)otherObj)->GetObject());
+ }
+ template
+ inline void Serialize(ISerializable::SerializeStream& stream, const ScriptingObjectInterfaceReference& v, const void* otherObj)
+ {
+ stream.Guid(v.GetID());
+ }
+ template
+ inline void Deserialize(ISerializable::DeserializeStream& stream, ScriptingObjectInterfaceReference& v, ISerializeModifier* modifier)
+ {
+ Guid id;
+ Deserialize(stream, id, modifier);
+ modifier->IdsMapping.TryGet(id, id);
v = id;
}
@@ -518,7 +542,28 @@ namespace Serialization
{
Guid id;
Deserialize(stream, id, modifier);
- modifier->IdsMapping.TryGet(id, id);
+ modifier->IdsMapping.TryGet(id, id);
+ v = id;
+ }
+
+ // Soft Object Interface Reference
+
+ template
+ inline bool ShouldSerialize(const SoftObjectInterfaceReference& v, const void* otherObj)
+ {
+ return !otherObj || ShouldSerializeRef(v.GetObject(), ((SoftObjectInterfaceReference*)otherObj)->GetObject());
+ }
+ template
+ inline void Serialize(ISerializable::SerializeStream& stream, const SoftObjectInterfaceReference& v, const void* otherObj)
+ {
+ stream.Guid(v.GetID());
+ }
+ template
+ inline void Deserialize(ISerializable::DeserializeStream& stream, SoftObjectInterfaceReference& v, ISerializeModifier* modifier)
+ {
+ Guid id;
+ Deserialize(stream, id, modifier);
+ modifier->IdsMapping.TryGet(id, id);
v = id;
}
diff --git a/Source/Engine/Serialization/Stream.h b/Source/Engine/Serialization/Stream.h
index 7e82467f5..e6dd3a42b 100644
--- a/Source/Engine/Serialization/Stream.h
+++ b/Source/Engine/Serialization/Stream.h
@@ -17,8 +17,12 @@ class ScriptingObject;
template
class ScriptingObjectReference;
template
+class ScriptingObjectInterfaceReference;
+template
class SoftObjectReference;
template
+class SoftObjectInterfaceReference;
+template
class AssetReference;
template
class WeakAssetReference;
diff --git a/Source/Engine/Serialization/WriteStream.h b/Source/Engine/Serialization/WriteStream.h
index f027deabb..6c610b66f 100644
--- a/Source/Engine/Serialization/WriteStream.h
+++ b/Source/Engine/Serialization/WriteStream.h
@@ -156,11 +156,29 @@ public:
{
Write(v.Get());
}
+
+ template
+ FORCE_INLINE void Write(const ScriptingObjectInterfaceReference& v)
+ {
+ uint32 id[4];
+ v.CopyID(id);
+ WriteBytes(id, sizeof(id));
+ }
+
template
FORCE_INLINE void Write(const SoftObjectReference& v)
{
Write(v.Get());
}
+
+ template
+ FORCE_INLINE void Write(const SoftObjectInterfaceReference& v)
+ {
+ uint32 id[4];
+ v.CopyID(id);
+ WriteBytes(id, sizeof(id));
+ }
+
template
FORCE_INLINE void Write(const AssetReference& v)
{
diff --git a/Source/Engine/Tests/TestScripting.h b/Source/Engine/Tests/TestScripting.h
index ca13ac307..0a764c89f 100644
--- a/Source/Engine/Tests/TestScripting.h
+++ b/Source/Engine/Tests/TestScripting.h
@@ -6,6 +6,8 @@
#include "Engine/Core/Math/Vector3.h"
#include "Engine/Core/Collections/Array.h"
#include "Engine/Scripting/ScriptingObject.h"
+#include "Engine/Scripting/ScriptingObjectInterfaceReference.h"
+#include "Engine/Scripting/SoftObjectInterfaceReference.h"
#include "Engine/Scripting/SerializableScriptingObject.h"
#include "Engine/Scripting/SoftTypeReference.h"
#include "Engine/Content/SceneReference.h"
@@ -177,6 +179,10 @@ public:
// Test struct
API_FIELD() TestStruct SimpleStruct;
+ // Test interface reference
+ API_FIELD() ScriptingObjectInterfaceReference InterfaceRef;
+ // Test soft interface reference
+ API_FIELD() SoftObjectInterfaceReference SoftInterfaceRef;
// Test event
API_EVENT() Delegate&, Array&> SimpleEvent;
diff --git a/Source/Tools/Flax.Build/Bindings/BindingsGenerator.CSharp.cs b/Source/Tools/Flax.Build/Bindings/BindingsGenerator.CSharp.cs
index 174c6de2c..433dbdda6 100644
--- a/Source/Tools/Flax.Build/Bindings/BindingsGenerator.CSharp.cs
+++ b/Source/Tools/Flax.Build/Bindings/BindingsGenerator.CSharp.cs
@@ -108,7 +108,7 @@ namespace Flax.Build.Bindings
if (attribute && valueType != null && !valueType.IsArray)
{
//if (valueType.Type == "")
- //ScriptingObjectReference
+ //ScriptingObjectReference, ScriptingObjectInterfaceReference, SoftObjectInterfaceReference
apiType = FindApiTypeInfo(buildData, valueType, caller);
// Object reference
@@ -350,6 +350,10 @@ namespace Flax.Build.Bindings
if (CSharpNativeToManagedDefault.TryGetValue(typeInfo.Type, out result))
return result;
+ // Interface reference property
+ if (typeInfo.IsInterfaceRef)
+ return marshalling ? "IntPtr" : GenerateCSharpNativeToManaged(buildData, typeInfo.GenericArgs[0], caller, marshalling);
+
// Object reference property
if (typeInfo.IsObjectRef)
return GenerateCSharpNativeToManaged(buildData, typeInfo.GenericArgs[0], caller, marshalling);
@@ -556,6 +560,10 @@ namespace Flax.Build.Bindings
}
return string.Empty;
default:
+ // Interface reference property
+ if (typeInfo.IsInterfaceRef)
+ return string.Format("FlaxEngine.Object.GetUnmanagedInterface({{0}}, typeof({0}))", GenerateCSharpNativeToManaged(buildData, typeInfo.GenericArgs[0], caller));
+
var apiType = FindApiTypeInfo(buildData, typeInfo, caller);
if (apiType != null)
{
@@ -778,9 +786,17 @@ namespace Flax.Build.Bindings
}
}
#endif
+ const string interfaceResultName = "__interfaceResult";
+
+ var returnInterfaceRef = !functionInfo.Glue.UseReferenceForResult && functionInfo.ReturnType.IsInterfaceRef;
+
if (functionInfo.Glue.UseReferenceForResult)
{
}
+ else if (returnInterfaceRef)
+ {
+ contents.Append("var ").Append(interfaceResultName).Append(" = ");
+ }
else if (!functionInfo.ReturnType.IsVoid)
{
contents.Append("return ");
@@ -851,6 +867,11 @@ namespace Flax.Build.Bindings
}
contents.Append(')');
+ if (returnInterfaceRef)
+ {
+ var managedType = GenerateCSharpNativeToManaged(buildData, functionInfo.ReturnType.GenericArgs[0], caller);
+ contents.Append("; return ").Append(interfaceResultName).Append(" != IntPtr.Zero ? Unsafe.As<").Append(managedType).Append(">(ManagedHandle.FromIntPtr(").Append(interfaceResultName).Append(").Target) : null");
+ }
if ((functionInfo.ReturnType.Type == "Array" || functionInfo.ReturnType.Type == "Span" || functionInfo.ReturnType.Type == "DataContainer") && functionInfo.ReturnType.GenericArgs != null)
{
// Convert array that uses different type for marshalling
@@ -987,6 +1008,12 @@ namespace Flax.Build.Bindings
private static void GenerateCSharpAttributes(BuildData buildData, StringBuilder contents, string indent, ApiTypeInfo apiTypeInfo, MemberInfo memberInfo, bool useUnmanaged, string defaultValue = null, TypeInfo defaultValueType = null)
{
GenerateCSharpAttributes(buildData, contents, indent, apiTypeInfo, memberInfo.Attributes, memberInfo.Comment, true, useUnmanaged, defaultValue, memberInfo.DeprecatedMessage, defaultValueType);
+ var memberType = (memberInfo as FieldInfo)?.Type ?? (memberInfo as PropertyInfo)?.Type;
+ if (memberType != null && memberType.IsInterfaceRef)
+ {
+ var attribute = memberType.Type == "SoftObjectInterfaceReference" ? "SoftObjectInterfaceReference" : "ScriptingObjectInterfaceReference";
+ contents.Append(indent).Append("[FlaxEngine.").Append(attribute).AppendLine("]");
+ }
}
private static bool GenerateCSharpStructureUseDefaultInitialize(BuildData buildData, StructureInfo structureInfo)
diff --git a/Source/Tools/Flax.Build/Bindings/BindingsGenerator.Cpp.cs b/Source/Tools/Flax.Build/Bindings/BindingsGenerator.Cpp.cs
index 6dd2aba6f..e67bde3af 100644
--- a/Source/Tools/Flax.Build/Bindings/BindingsGenerator.Cpp.cs
+++ b/Source/Tools/Flax.Build/Bindings/BindingsGenerator.Cpp.cs
@@ -167,6 +167,8 @@ namespace Flax.Build.Bindings
return $"Variant(StringView({value}))";
if (typeInfo.Type == "StringAnsi")
return $"Variant(StringAnsiView({value}))";
+ if (typeInfo.IsInterfaceRef)
+ return $"Variant({value}.GetObject())";
if (typeInfo.IsObjectRef)
return $"Variant({value}.Get())";
if (typeInfo.Type == "SoftTypeReference")
@@ -307,6 +309,8 @@ namespace Flax.Build.Bindings
return $"((StringView){value}).GetText()"; // (StringView)Variant, if not empty, is guaranteed to point to a null-terminated buffer.
if (typeInfo.Type == "ScriptingObjectReference" || typeInfo.Type == "SoftObjectReference")
return $"ScriptingObject::Cast<{typeInfo.GenericArgs[0].Type}>((ScriptingObject*){value})";
+ if (typeInfo.IsInterfaceRef)
+ return $"ScriptingObject::ToInterface<{typeInfo.GenericArgs[0].Type}>((ScriptingObject*){value})";
if (typeInfo.IsObjectRef)
return $"ScriptingObject::Cast<{typeInfo.GenericArgs[0].Type}>((Asset*){value})";
if (typeInfo.Type == "SoftTypeReference")
@@ -797,6 +801,19 @@ namespace Flax.Build.Bindings
type = "MObject*";
return "MUtils::ToNative({0})";
default:
+ // Interface reference property
+ if (typeInfo.IsInterfaceRef)
+ {
+ if (CppNonPodTypesConvertingGeneration)
+ {
+ type = "MObject*";
+ return "ScriptingObject::ToInterface<" + typeInfo.GenericArgs[0].Type + ">(ScriptingObject::ToNative({0}))";
+ }
+
+ type = typeInfo.GenericArgs[0].Type + '*';
+ return string.Empty;
+ }
+
// Object reference property
if (typeInfo.IsObjectRef)
{
diff --git a/Source/Tools/Flax.Build/Bindings/ClassInfo.cs b/Source/Tools/Flax.Build/Bindings/ClassInfo.cs
index f2d82cc6e..46097a218 100644
--- a/Source/Tools/Flax.Build/Bindings/ClassInfo.cs
+++ b/Source/Tools/Flax.Build/Bindings/ClassInfo.cs
@@ -18,6 +18,8 @@ namespace Flax.Build.Bindings
"ManagedScriptingObject",
"PersistentScriptingObject",
"ScriptingObjectReference",
+ "ScriptingObjectInterfaceReference",
+ "SoftObjectInterfaceReference",
"AssetReference",
"BinaryAsset",
"SceneObject",
diff --git a/Source/Tools/Flax.Build/Bindings/TypeInfo.cs b/Source/Tools/Flax.Build/Bindings/TypeInfo.cs
index 04836c636..79ade2bfa 100644
--- a/Source/Tools/Flax.Build/Bindings/TypeInfo.cs
+++ b/Source/Tools/Flax.Build/Bindings/TypeInfo.cs
@@ -38,10 +38,18 @@ namespace Flax.Build.Bindings
/// Gets a value indicating whether this type is a reference to another object.
///
public bool IsObjectRef => (Type == "ScriptingObjectReference" ||
+ Type == "ScriptingObjectInterfaceReference" ||
Type == "AssetReference" ||
Type == "WeakAssetReference" ||
Type == "SoftAssetReference" ||
- Type == "SoftObjectReference") && GenericArgs != null;
+ Type == "SoftObjectReference" ||
+ Type == "SoftObjectInterfaceReference") && GenericArgs != null;
+
+ ///
+ /// Gets a value indicating whether this type is a reference to another object filtered by interface.
+ ///
+ public bool IsInterfaceRef => (Type == "ScriptingObjectInterfaceReference" ||
+ Type == "SoftObjectInterfaceReference") && GenericArgs != null;
public TypeInfo()
{