/******************************************************************************
|
* Spine Runtimes License Agreement
|
* Last updated July 28, 2023. Replaces all prior versions.
|
*
|
* Copyright (c) 2013-2023, Esoteric Software LLC
|
*
|
* Integration of the Spine Runtimes into software or otherwise creating
|
* derivative works of the Spine Runtimes is permitted under the terms and
|
* conditions of Section 2 of the Spine Editor License Agreement:
|
* http://esotericsoftware.com/spine-editor-license
|
*
|
* Otherwise, it is permitted to integrate the Spine Runtimes into software or
|
* otherwise create derivative works of the Spine Runtimes (collectively,
|
* "Products"), provided that each user of the Products must obtain their own
|
* Spine Editor license and redistribution of the Products in any form must
|
* include this license and copyright notice.
|
*
|
* THE SPINE RUNTIMES ARE PROVIDED BY ESOTERIC SOFTWARE LLC "AS IS" AND ANY
|
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
* DISCLAIMED. IN NO EVENT SHALL ESOTERIC SOFTWARE LLC BE LIABLE FOR ANY
|
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES,
|
* BUSINESS INTERRUPTION, OR LOSS OF USE, DATA, OR PROFITS) HOWEVER CAUSED AND
|
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THE
|
* SPINE RUNTIMES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
*****************************************************************************/
|
|
using UnityEditor;
|
using UnityEngine;
|
|
namespace Spine.Unity.Editor {
|
[CustomEditor(typeof(SkeletonRootMotionBase))]
|
[CanEditMultipleObjects]
|
public class SkeletonRootMotionBaseInspector : UnityEditor.Editor {
|
protected SerializedProperty rootMotionBoneName;
|
protected SerializedProperty transformPositionX;
|
protected SerializedProperty transformPositionY;
|
protected SerializedProperty transformRotation;
|
protected SerializedProperty rootMotionScaleX;
|
protected SerializedProperty rootMotionScaleY;
|
protected SerializedProperty rootMotionScaleRotation;
|
protected SerializedProperty rootMotionTranslateXPerY;
|
protected SerializedProperty rootMotionTranslateYPerX;
|
protected SerializedProperty rigidBody2D;
|
protected SerializedProperty applyRigidbody2DGravity;
|
protected SerializedProperty rigidBody;
|
|
protected GUIContent rootMotionBoneNameLabel;
|
protected GUIContent transformPositionXLabel;
|
protected GUIContent transformPositionYLabel;
|
protected GUIContent transformRotationLabel;
|
protected GUIContent rootMotionScaleXLabel;
|
protected GUIContent rootMotionScaleYLabel;
|
protected GUIContent rootMotionScaleRotationLabel;
|
protected GUIContent rootMotionTranslateXPerYLabel;
|
protected GUIContent rootMotionTranslateYPerXLabel;
|
protected GUIContent rigidBody2DLabel;
|
protected GUIContent applyRigidbody2DGravityLabel;
|
protected GUIContent rigidBodyLabel;
|
|
protected virtual void OnEnable () {
|
|
rootMotionBoneName = serializedObject.FindProperty("rootMotionBoneName");
|
transformPositionX = serializedObject.FindProperty("transformPositionX");
|
transformPositionY = serializedObject.FindProperty("transformPositionY");
|
transformRotation = serializedObject.FindProperty("transformRotation");
|
rootMotionScaleX = serializedObject.FindProperty("rootMotionScaleX");
|
rootMotionScaleY = serializedObject.FindProperty("rootMotionScaleY");
|
rootMotionScaleRotation = serializedObject.FindProperty("rootMotionScaleRotation");
|
rootMotionTranslateXPerY = serializedObject.FindProperty("rootMotionTranslateXPerY");
|
rootMotionTranslateYPerX = serializedObject.FindProperty("rootMotionTranslateYPerX");
|
rigidBody2D = serializedObject.FindProperty("rigidBody2D");
|
applyRigidbody2DGravity = serializedObject.FindProperty("applyRigidbody2DGravity");
|
rigidBody = serializedObject.FindProperty("rigidBody");
|
|
rootMotionBoneNameLabel = new UnityEngine.GUIContent("Root Motion Bone", "The bone to take the motion from.");
|
transformPositionXLabel = new UnityEngine.GUIContent("X", "Root transform position (X)");
|
transformPositionYLabel = new UnityEngine.GUIContent("Y", "Use the Y-movement of the bone.");
|
transformRotationLabel = new UnityEngine.GUIContent("Rotation", "Use the rotation of the bone.");
|
rootMotionScaleXLabel = new UnityEngine.GUIContent("Root Motion Scale (X)", "Scale applied to the horizontal root motion delta. Can be used for delta compensation to e.g. stretch a jump to the desired distance.");
|
rootMotionScaleYLabel = new UnityEngine.GUIContent("Root Motion Scale (Y)", "Scale applied to the vertical root motion delta. Can be used for delta compensation to e.g. stretch a jump to the desired distance.");
|
rootMotionScaleRotationLabel = new UnityEngine.GUIContent("Root Motion Scale (Rotation)", "Scale applied to the rotational root motion delta. Can be used for delta compensation to e.g. adjust an angled jump landing to the desired platform angle.");
|
rootMotionTranslateXPerYLabel = new UnityEngine.GUIContent("Root Motion Translate (X)", "Added X translation per root motion Y delta. Can be used for delta compensation when scaling is not enough, to e.g. offset a horizontal jump to a vertically different goal.");
|
rootMotionTranslateYPerXLabel = new UnityEngine.GUIContent("Root Motion Translate (Y)", "Added Y translation per root motion X delta. Can be used for delta compensation when scaling is not enough, to e.g. offset a horizontal jump to a vertically different goal.");
|
rigidBody2DLabel = new UnityEngine.GUIContent("Rigidbody2D",
|
"Optional Rigidbody2D: Assign a Rigidbody2D here if you want " +
|
" to apply the root motion to the rigidbody instead of the Transform." +
|
"\n\n" +
|
"Note that animation and physics updates are not always in sync." +
|
"Some jitter may result at certain framerates.");
|
applyRigidbody2DGravityLabel = new UnityEngine.GUIContent("Apply Gravity",
|
"Apply Rigidbody2D Gravity");
|
rigidBodyLabel = new UnityEngine.GUIContent("Rigidbody",
|
"Optional Rigidbody: Assign a Rigidbody here if you want " +
|
" to apply the root motion to the rigidbody instead of the Transform." +
|
"\n\n" +
|
"Note that animation and physics updates are not always in sync." +
|
"Some jitter may result at certain framerates.");
|
}
|
|
public override void OnInspectorGUI () {
|
MainPropertyFields();
|
OptionalPropertyFields();
|
serializedObject.ApplyModifiedProperties();
|
}
|
|
protected virtual void MainPropertyFields () {
|
EditorGUILayout.PropertyField(rootMotionBoneName, rootMotionBoneNameLabel);
|
EditorGUILayout.PropertyField(transformPositionX, transformPositionXLabel);
|
EditorGUILayout.PropertyField(transformPositionY, transformPositionYLabel);
|
EditorGUILayout.PropertyField(transformRotation, transformRotationLabel);
|
|
EditorGUILayout.PropertyField(rootMotionScaleX, rootMotionScaleXLabel);
|
EditorGUILayout.PropertyField(rootMotionScaleY, rootMotionScaleYLabel);
|
EditorGUILayout.PropertyField(rootMotionScaleRotation, rootMotionScaleRotationLabel);
|
|
EditorGUILayout.PropertyField(rootMotionTranslateXPerY, rootMotionTranslateXPerYLabel);
|
EditorGUILayout.PropertyField(rootMotionTranslateYPerX, rootMotionTranslateYPerXLabel);
|
}
|
|
protected virtual void OptionalPropertyFields () {
|
EditorGUILayout.PropertyField(rigidBody2D, rigidBody2DLabel);
|
|
if (rigidBody2D.objectReferenceValue != null || rigidBody2D.hasMultipleDifferentValues) {
|
using (new SpineInspectorUtility.IndentScope())
|
EditorGUILayout.PropertyField(applyRigidbody2DGravity, applyRigidbody2DGravityLabel);
|
}
|
|
EditorGUILayout.PropertyField(rigidBody, rigidBodyLabel);
|
DisplayWarnings();
|
}
|
|
protected void DisplayWarnings () {
|
bool usesRigidbodyPhysics = rigidBody.objectReferenceValue != null || rigidBody2D.objectReferenceValue != null;
|
if (usesRigidbodyPhysics) {
|
SkeletonRootMotionBase rootMotionComponent = (SkeletonRootMotionBase)serializedObject.targetObject;
|
ISkeletonAnimation skeletonComponent = rootMotionComponent ? rootMotionComponent.TargetSkeletonAnimationComponent : null;
|
if (skeletonComponent != null && skeletonComponent.UpdateTiming == UpdateTiming.InUpdate) {
|
string warningMessage = "Skeleton component uses 'Advanced - Animation Update' mode 'In Update'.\n" +
|
"When using a Rigidbody, 'In FixedUpdate' is recommended instead.";
|
EditorGUILayout.HelpBox(warningMessage, MessageType.Warning, true);
|
}
|
}
|
}
|
}
|
}
|
