Merge branch 'actor-tag-type' of https://github.com/Tryibion/FlaxEngine into Tryibion-actor-tag-type

Author: mafiesto4

Source/Engine/Level/Actor.cpp

@@ -1337,6 +1337,20 @@ Actor* Actor::FindActor(const MClass* type, const StringView& name) const
     return nullptr;
 }
 
+Actor* Actor::FindActor(const MClass* type, const Tag& tag) const
+{
+    CHECK_RETURN(type, nullptr);
+    if (GetClass()->IsSubClassOf(type) && HasTag(tag))
+        return const_cast<Actor*>(this);
+    for (auto child : Children)
+    {
+        const auto actor = child->FindActor(type, tag);
+        if (actor)
+            return actor;
+    }
+    return nullptr;
+}
+
 Script* Actor::FindScript(const MClass* type) const
 {
     CHECK_RETURN(type, nullptr);

Source/Engine/Level/Actor.cs

@@ -269,6 +269,17 @@ public T FindActor<T>(string name) where T : Actor
         {
             return FindActor(typeof(T), name) as T;
         }
+        
+        /// <summary>
+        /// Tries to find actor of the given type and tag in this actor hierarchy (checks this actor and all children hierarchy).
+        /// </summary>
+        /// <param name="tag">A tag on the object.</param>
+        /// <typeparam name="T">Type of the object.</typeparam>
+        /// <returns>Actor instance if found, null otherwise.</returns>
+        public T FindActor<T>(Tag tag) where T : Actor
+        {
+            return FindActor(typeof(T), tag) as T;
+        }
 
         /// <summary>
         /// Searches for all actors of a specific type in this actor children list.

Source/Engine/Level/Actor.h

@@ -739,6 +739,14 @@ API_CLASS(Abstract) class FLAXENGINE_API Actor : public SceneObject
     /// <returns>Actor instance if found, null otherwise.</returns>
     API_FUNCTION() Actor* FindActor(API_PARAM(Attributes="TypeReference(typeof(Actor))") const MClass* type, const StringView& name) const;
 
+    /// <summary>
+    /// Tries to find the actor of the given type and tag in this actor hierarchy.
+    /// </summary>
+    /// <param name="type">Type of the actor to search for. Includes any actors derived from the type.</param>
+    /// <param name="tag">The tag of the actor to search for.</param>
+    /// <returns>Actor instance if found, null otherwise.</returns>
+    API_FUNCTION() Actor* FindActor(API_PARAM(Attributes="TypeReference(typeof(Actor))") const MClass* type, const Tag& tag) const;
+
     /// <summary>
     /// Tries to find the actor of the given type in this actor hierarchy (checks this actor and all children hierarchy).
     /// </summary>
@@ -759,6 +767,17 @@ API_CLASS(Abstract) class FLAXENGINE_API Actor : public SceneObject
     {
         return (T*)FindActor(T::GetStaticClass(), name);
     }
+    
+    /// <summary>
+    /// Tries to find the actor of the given type and tag in this actor hierarchy (checks this actor and all children hierarchy).
+    /// </summary>
+    /// <param name="tag">The tag of the actor to search for.</param>
+    /// <returns>Actor instance if found, null otherwise.</returns>
+    template<typename T>
+    FORCE_INLINE T* FindActor(const Tag& tag) const
+    {
+        return (T*)FindActor(T::GetStaticClass(), tag);
+    }
 
     /// <summary>
     /// Tries to find the script of the given type in this actor hierarchy (checks this actor and all children hierarchy).

Source/Engine/Level/Level.cpp

@@ -726,116 +726,6 @@ int32 Level::GetLayerIndex(const StringView& layer)
     return result;
 }
 
-Actor* FindActorRecursive(Actor* node, const Tag& tag)
-{
-    if (node->HasTag(tag))
-        return node;
-    Actor* result = nullptr;
-    for (Actor* child : node->Children)
-    {
-        result = FindActorRecursive(child, tag);
-        if (result)
-            break;
-    }
-    return result;
-}
-
-void FindActorsRecursive(Actor* node, const Tag& tag, const bool activeOnly, Array<Actor*>& result)
-{
-    if (activeOnly && !node->GetIsActive())
-        return;
-    if (node->HasTag(tag))
-        result.Add(node);
-    for (Actor* child : node->Children)
-        FindActorsRecursive(child, tag, activeOnly, result);
-}
-
-void FindActorsRecursiveByParentTags(Actor* node, const Array<Tag>& tags, const bool activeOnly, Array<Actor*>& result)
-{
-    if (activeOnly && !node->GetIsActive())
-        return;
-    for (Tag tag : tags)
-    {
-        if (node->HasTag(tag))
-        {
-            result.Add(node);
-            break;
-        }
-    }
-    for (Actor* child : node->Children)
-        FindActorsRecursiveByParentTags(child, tags, activeOnly, result);
-}
-
-Actor* Level::FindActor(const Tag& tag, Actor* root)
-{
-    PROFILE_CPU();
-    if (root)
-        return FindActorRecursive(root, tag);
-    Actor* result = nullptr;
-    for (Scene* scene : Scenes)
-    {
-        result = FindActorRecursive(scene, tag);
-        if (result)
-            break;
-    }
-    return result;
-}
-
-void FindActorRecursive(Actor* node, const Tag& tag, Array<Actor*>& result)
-{
-    if (node->HasTag(tag))
-        result.Add(node);
-    for (Actor* child : node->Children)
-        FindActorRecursive(child, tag, result);
-}
-
-Array<Actor*> Level::FindActors(const Tag& tag, const bool activeOnly, Actor* root)
-{
-    PROFILE_CPU();
-    Array<Actor*> result;
-    if (root)
-    {
-        FindActorsRecursive(root, tag, activeOnly, result);
-    }
-    else
-    {
-        ScopeLock lock(ScenesLock);
-        for (Scene* scene : Scenes)
-            FindActorsRecursive(scene, tag, activeOnly,  result);
-    }
-    return result;
-}
-
-Array<Actor*> Level::FindActorsByParentTag(const Tag& parentTag, const bool activeOnly, Actor* root)
-{
-    PROFILE_CPU();
-    Array<Actor*> result;
-    const Array<Tag> subTags = Tags::GetSubTags(parentTag);
-
-    if (subTags.Count() == 0)
-    {
-        return result;
-    }
-    if (subTags.Count() == 1)
-    {
-        result = FindActors(subTags[0], activeOnly, root);
-        return result;
-    }
-
-    if (root)
-    {
-        FindActorsRecursiveByParentTags(root, subTags, activeOnly, result);
-    }
-    else
-    {
-        ScopeLock lock(ScenesLock);
-        for (Scene* scene : Scenes)
-            FindActorsRecursiveByParentTags(scene, subTags, activeOnly, result);
-    }
-
-    return result;
-}
-
 void Level::callActorEvent(ActorEventType eventType, Actor* a, Actor* b)
 {
     PROFILE_CPU();
@@ -1505,6 +1395,143 @@ Actor* Level::FindActor(const MClass* type, const StringView& name)
     return result;
 }
 
+Actor* FindActorRecursive(Actor* node, const Tag& tag)
+{
+    if (node->HasTag(tag))
+        return node;
+    Actor* result = nullptr;
+    for (Actor* child : node->Children)
+    {
+        result = FindActorRecursive(child, tag);
+        if (result)
+            break;
+    }
+    return result;
+}
+
+Actor* FindActorRecursiveByType(Actor* node, const MClass* type, const Tag& tag)
+{
+    CHECK_RETURN(type, nullptr);
+    if (node->HasTag(tag) && node->GetClass()->IsSubClassOf(type))
+        return node;
+    Actor* result = nullptr;
+    for (Actor* child : node->Children)
+    {
+        result = FindActorRecursiveByType(child, type, tag);
+        if (result)
+            break;
+    }
+    return result;
+}
+
+void FindActorsRecursive(Actor* node, const Tag& tag, const bool activeOnly, Array<Actor*>& result)
+{
+    if (activeOnly && !node->GetIsActive())
+        return;
+    if (node->HasTag(tag))
+        result.Add(node);
+    for (Actor* child : node->Children)
+        FindActorsRecursive(child, tag, activeOnly, result);
+}
+
+void FindActorsRecursiveByParentTags(Actor* node, const Array<Tag>& tags, const bool activeOnly, Array<Actor*>& result)
+{
+    if (activeOnly && !node->GetIsActive())
+        return;
+    for (Tag tag : tags)
+    {
+        if (node->HasTag(tag))
+        {
+            result.Add(node);
+            break;
+        }
+    }
+    for (Actor* child : node->Children)
+        FindActorsRecursiveByParentTags(child, tags, activeOnly, result);
+}
+
+Actor* Level::FindActor(const Tag& tag, Actor* root)
+{
+    PROFILE_CPU();
+    if (root)
+        return FindActorRecursive(root, tag);
+    Actor* result = nullptr;
+    for (Scene* scene : Scenes)
+    {
+        result = FindActorRecursive(scene, tag);
+        if (result)
+            break;
+    }
+    return result;
+}
+
+Actor* Level::FindActor(const MClass* type, const Tag& tag, Actor* root)
+{
+    CHECK_RETURN(type, nullptr);
+    if (root)
+        return FindActorRecursiveByType(root, type, tag);
+    Actor* result = nullptr;
+    ScopeLock lock(ScenesLock);
+    for (int32 i = 0; result == nullptr && i < Scenes.Count(); i++)
+        result = Scenes[i]->FindActor(type, tag);
+    return result;
+}
+
+void FindActorRecursive(Actor* node, const Tag& tag, Array<Actor*>& result)
+{
+    if (node->HasTag(tag))
+        result.Add(node);
+    for (Actor* child : node->Children)
+        FindActorRecursive(child, tag, result);
+}
+
+Array<Actor*> Level::FindActors(const Tag& tag, const bool activeOnly, Actor* root)
+{
+    PROFILE_CPU();
+    Array<Actor*> result;
+    if (root)
+    {
+        FindActorsRecursive(root, tag, activeOnly, result);
+    }
+    else
+    {
+        ScopeLock lock(ScenesLock);
+        for (Scene* scene : Scenes)
+            FindActorsRecursive(scene, tag, activeOnly,  result);
+    }
+    return result;
+}
+
+Array<Actor*> Level::FindActorsByParentTag(const Tag& parentTag, const bool activeOnly, Actor* root)
+{
+    PROFILE_CPU();
+    Array<Actor*> result;
+    const Array<Tag> subTags = Tags::GetSubTags(parentTag);
+
+    if (subTags.Count() == 0)
+    {
+        return result;
+    }
+    if (subTags.Count() == 1)
+    {
+        result = FindActors(subTags[0], activeOnly, root);
+        return result;
+    }
+
+    if (root)
+    {
+        FindActorsRecursiveByParentTags(root, subTags, activeOnly, result);
+    }
+    else
+    {
+        ScopeLock lock(ScenesLock);
+        for (Scene* scene : Scenes)
+            FindActorsRecursiveByParentTags(scene, subTags, activeOnly, result);
+    }
+
+    return result;
+}
+
 Script* Level::FindScript(const MClass* type)
 {
     CHECK_RETURN(type, nullptr);

Source/Engine/Level/Level.cs

@@ -77,6 +77,18 @@ public static T FindActor<T>(string name) where T : Actor
         {
             return FindActor(typeof(T), name) as T;
         }
+        
+        /// <summary>
+        /// Tries to find actor of the given type and tag in a root actor or all loaded scenes.
+        /// </summary>
+        /// <param name="tag">A tag on the object.</param>
+        /// <param name="root">The custom root actor to start searching from (hierarchical), otherwise null to search all loaded scenes.</param>
+        /// <typeparam name="T">Type of the object.</typeparam>
+        /// <returns>Found actor or null.</returns>
+        public static T FindActor<T>(Tag tag, Actor root = null) where T : Actor
+        {
+            return FindActor(typeof(T), tag, root) as T;
+        }
 
         /// <summary>
         /// Tries to find actor with the given ID in all loaded scenes. It's very fast O(1) lookup.