{lyn2265} adding a Python API for MotionGroup rules (#6215)

* {lyn2265} adding a Python API for MotionGroup rules

Signed-off-by: Allen Jackson <23512001+jackalbe@users.noreply.github.com>

* updating the license headers
added more proper example code for motion group


Signed-off-by: Allen Jackson <23512001+jackalbe@users.noreply.github.com>

* updating the actor group to use the common rules module

Signed-off-by: Allen Jackson <23512001+jackalbe@users.noreply.github.com>

AutomatedTesting/Assets/TestAnim/Test_Jack_Death_Fall_Back_ZUp.fbx

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4c1d04d687bdce69965965c290c907b3f9a730a7ea73874b734e1c7ff41426d9
+size 3832768

AutomatedTesting/Assets/TestAnim/scene_export_motion.py

@@ -0,0 +1,66 @@
+#
+# Copyright (c) Contributors to the Open 3D Engine Project.
+# For complete copyright and license terms please see the LICENSE at the root of this distribution.
+#
+# SPDX-License-Identifier: Apache-2.0 OR MIT
+#
+#
+import traceback, sys, uuid, os, json
+
+import scene_export_utils
+import scene_api.motion_group
+
+#
+# Example for exporting MotionGroup scene rules
+#
+
+def update_manifest(scene):
+    import azlmbr.scene.graph
+    import scene_api.scene_data
+
+    # create a SceneManifest
+    sceneManifest = scene_api.scene_data.SceneManifest()
+
+    # create a MotionGroup
+    motionGroup = scene_api.motion_group.MotionGroup()
+    motionGroup.name = os.path.basename(scene.sourceFilename.replace('.', '_'))
+
+    motionAdditiveRule = scene_api.motion_group.MotionAdditiveRule()
+    motionAdditiveRule.sampleFrame = 2
+    motionGroup.add_rule(motionAdditiveRule)
+
+    motionScaleRule = motionGroup.create_rule(scene_api.motion_group.MotionScaleRule())
+    motionScaleRule.scaleFactor = 1.1
+    motionGroup.add_rule(motionScaleRule)
+
+    # add motion group to scene manifest
+    sceneManifest.add_motion_group(motionGroup)
+
+    # Convert the manifest to a JSON string and return it
+    return sceneManifest.export()
+
+sceneJobHandler = None
+
+def on_update_manifest(args):
+    try:
+        scene = args[0]
+        return update_manifest(scene)
+    except RuntimeError as err:
+        print (f'ERROR - {err}')
+        scene_export_utils.log_exception_traceback()
+    except:
+        scene_export_utils.log_exception_traceback()
+
+    global sceneJobHandler
+    sceneJobHandler.disconnect()
+    sceneJobHandler = None
+
+# try to create SceneAPI handler for processing
+try:
+    import azlmbr.scene
+
+    sceneJobHandler = azlmbr.scene.ScriptBuildingNotificationBusHandler()
+    sceneJobHandler.connect()
+    sceneJobHandler.add_callback('OnUpdateManifest', on_update_manifest)
+except:
+    sceneJobHandler = None

AutomatedTesting/Assets/TestAnim/test_jack_death_fall_back_zup.fbx.assetinfo

@@ -0,0 +1,8 @@
+{
+    "values": [
+        {
+            "$type": "ScriptProcessorRule",
+            "scriptFilename": "Assets/TestAnim/scene_export_motion.py"
+        }
+    ]
+}

AutomatedTesting/Editor/Scripts/scene_export_utils.py

@@ -0,0 +1,63 @@
+#
+# Copyright (c) Contributors to the Open 3D Engine Project.
+# For complete copyright and license terms please see the LICENSE at the root of this distribution.
+#
+# SPDX-License-Identifier: Apache-2.0 OR MIT
+#
+#
+import traceback, sys, uuid, os, json
+
+#
+# Utility methods for processing scenes
+#
+
+def log_exception_traceback():
+    exc_type, exc_value, exc_tb = sys.exc_info()
+    data = traceback.format_exception(exc_type, exc_value, exc_tb)
+    print(str(data))
+
+def get_node_names(sceneGraph, nodeTypeName, testEndPoint = False, validList = None):
+    import azlmbr.scene.graph
+    import scene_api.scene_data
+
+    node = sceneGraph.get_root()
+    nodeList = []
+    children = []
+    paths = []
+
+    while node.IsValid():
+        # store children to process after siblings
+        if sceneGraph.has_node_child(node):
+            children.append(sceneGraph.get_node_child(node))
+
+        nodeName = scene_api.scene_data.SceneGraphName(sceneGraph.get_node_name(node))
+        paths.append(nodeName.get_path())
+        
+        include = True 
+        
+        if (validList is not None):
+            include = False # if a valid list filter provided, assume to not include node name
+            name_parts = nodeName.get_path().split('.')
+            for valid in validList:
+                if (valid in name_parts[-1]):
+                    include = True
+                    break
+
+        # store any node that has provides specifc data content
+        nodeContent = sceneGraph.get_node_content(node)
+        if include and nodeContent.CastWithTypeName(nodeTypeName):
+            if testEndPoint is not None:
+                include = sceneGraph.is_node_end_point(node) is testEndPoint
+            if include:
+                if (len(nodeName.get_path())):
+                    nodeList.append(scene_api.scene_data.SceneGraphName(sceneGraph.get_node_name(node)))
+
+        # advance to next node
+        if sceneGraph.has_node_sibling(node):
+            node = sceneGraph.get_node_sibling(node)
+        elif children:
+            node = children.pop()
+        else:
+            node = azlmbr.scene.graph.NodeIndex()
+
+    return nodeList, paths

AutomatedTesting/Editor/Scripts/scene_helpers.py

@@ -1,10 +1,10 @@
-"""
-Copyright (c) Contributors to the Open 3D Engine Project.
-For complete copyright and license terms please see the LICENSE at the root of this distribution.
-
-SPDX-License-Identifier: Apache-2.0 OR MIT
-"""
-
+#
+# Copyright (c) Contributors to the Open 3D Engine Project.
+# For complete copyright and license terms please see the LICENSE at the root of this distribution.
+#
+# SPDX-License-Identifier: Apache-2.0 OR MIT
+#
+#
 import traceback, logging, json
 from typing import Tuple, List