280 lines
11 KiB
C#
280 lines
11 KiB
C#
/******************************************************************************
|
|
* Spine Runtimes License Agreement
|
|
* Last updated April 5, 2025. Replaces all prior versions.
|
|
*
|
|
* Copyright (c) 2013-2026, 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.
|
|
*****************************************************************************/
|
|
|
|
#if UNITY_2018_3 || UNITY_2019 || UNITY_2018_3_OR_NEWER
|
|
#define NEW_PREFAB_SYSTEM
|
|
#endif
|
|
|
|
#if !SPINE_AUTO_UPGRADE_COMPONENTS_OFF
|
|
#define AUTO_UPGRADE_TO_43_COMPONENTS
|
|
#endif
|
|
|
|
using System;
|
|
using UnityEngine;
|
|
using UnityEngine.Serialization;
|
|
|
|
namespace Spine.Unity {
|
|
|
|
/// <summary>Sets a GameObject's transform to match a bone on a Spine skeleton.</summary>
|
|
#if NEW_PREFAB_SYSTEM
|
|
[ExecuteAlways]
|
|
#else
|
|
[ExecuteInEditMode]
|
|
#endif
|
|
[AddComponentMenu("Spine/BoneFollower")]
|
|
[HelpURL("https://esotericsoftware.com/spine-unity-utility-components#BoneFollower")]
|
|
public class BoneFollower : MonoBehaviour, IUpgradable {
|
|
|
|
#region Inspector
|
|
public SkeletonRenderer skeletonRenderer;
|
|
public SkeletonRenderer SkeletonRenderer {
|
|
get { return skeletonRenderer; }
|
|
set {
|
|
skeletonRenderer = value;
|
|
Initialize();
|
|
}
|
|
}
|
|
|
|
/// <summary>If a bone isn't set in code, boneName is used to find the bone at the beginning. For runtime switching by name, use SetBoneByName. You can also set the BoneFollower.bone field directly.</summary>
|
|
[SpineBone(dataField: "skeletonRenderer")]
|
|
public string boneName;
|
|
|
|
public bool followXYPosition = true;
|
|
public bool followZPosition = true;
|
|
public bool followAttachmentZSpacing = false;
|
|
public bool followBoneRotation = true;
|
|
|
|
[Tooltip("Follows the skeleton's flip state by controlling this Transform's local scale.")]
|
|
public bool followSkeletonFlip = true;
|
|
|
|
[Tooltip("Follows the target bone's local scale.")]
|
|
[UnityEngine.Serialization.FormerlySerializedAs("followScale")]
|
|
public bool followLocalScale = false;
|
|
[Tooltip("Includes the parent bone's lossy world scale. BoneFollower cannot inherit rotated/skewed scale because of UnityEngine.Transform property limitations.")]
|
|
public bool followParentWorldScale = false;
|
|
|
|
public enum AxisOrientation {
|
|
XAxis = 1,
|
|
YAxis
|
|
}
|
|
[Tooltip("Applies when 'Follow Skeleton Flip' is disabled but 'Follow Bone Rotation' is enabled."
|
|
+ " When flipping the skeleton by scaling its Transform, this follower's rotation is adjusted"
|
|
+ " instead of its scale to follow the bone orientation. When one of the axes is flipped, "
|
|
+ " only one axis can be followed, either the X or the Y axis, which is selected here.")]
|
|
public AxisOrientation maintainedAxisOrientation = AxisOrientation.XAxis;
|
|
|
|
[UnityEngine.Serialization.FormerlySerializedAs("resetOnAwake")]
|
|
public bool initializeOnAwake = true;
|
|
#endregion
|
|
|
|
[NonSerialized] public bool valid;
|
|
[NonSerialized] public Bone bone;
|
|
|
|
Transform skeletonTransform;
|
|
bool skeletonTransformIsParent;
|
|
|
|
/// <summary>
|
|
/// Sets the target bone by its bone name. Returns false if no bone was found. To set the bone by reference, use BoneFollower.bone directly.</summary>
|
|
public bool SetBone (string name) {
|
|
bone = skeletonRenderer.skeleton.FindBone(name);
|
|
if (bone == null) {
|
|
Debug.LogError("Bone not found: " + name, this);
|
|
return false;
|
|
}
|
|
boneName = name;
|
|
return true;
|
|
}
|
|
|
|
public void Awake () {
|
|
#if UNITY_EDITOR && AUTO_UPGRADE_TO_43_COMPONENTS
|
|
if (!Application.isPlaying && !wasUpgradedTo43) {
|
|
UpgradeTo43();
|
|
}
|
|
#endif
|
|
if (initializeOnAwake) Initialize();
|
|
}
|
|
|
|
public void HandleRebuildRenderer (ISkeletonRenderer skeletonRenderer) {
|
|
Initialize();
|
|
}
|
|
|
|
public virtual void Initialize () {
|
|
bone = null;
|
|
valid = skeletonRenderer != null && skeletonRenderer.valid;
|
|
if (!valid) return;
|
|
|
|
skeletonTransform = skeletonRenderer.transform;
|
|
skeletonRenderer.OnRebuild -= HandleRebuildRenderer;
|
|
skeletonRenderer.OnRebuild += HandleRebuildRenderer;
|
|
skeletonTransformIsParent = Transform.ReferenceEquals(skeletonTransform, transform.parent);
|
|
|
|
if (!string.IsNullOrEmpty(boneName))
|
|
bone = skeletonRenderer.skeleton.FindBone(boneName);
|
|
#if UNITY_EDITOR
|
|
if (Application.isEditor)
|
|
LateUpdate();
|
|
#endif
|
|
}
|
|
|
|
void OnDestroy () {
|
|
if (skeletonRenderer != null)
|
|
skeletonRenderer.OnRebuild -= HandleRebuildRenderer;
|
|
}
|
|
|
|
public virtual void LateUpdate () {
|
|
if (!valid) {
|
|
Initialize();
|
|
return;
|
|
}
|
|
|
|
#if UNITY_EDITOR
|
|
if (!Application.isPlaying)
|
|
skeletonTransformIsParent = Transform.ReferenceEquals(skeletonTransform, transform.parent);
|
|
#endif
|
|
Skeleton skeleton = skeletonRenderer.skeleton;
|
|
if (bone == null) {
|
|
if (string.IsNullOrEmpty(boneName)) return;
|
|
bone = skeleton.FindBone(boneName);
|
|
if (!SetBone(boneName)) return;
|
|
}
|
|
|
|
Transform thisTransform = this.transform;
|
|
float additionalFlipScale = 1;
|
|
|
|
float scaleSignX = 1;
|
|
float scaleSignY = 1;
|
|
Bone parentBone = bone.Parent;
|
|
if (followParentWorldScale || followLocalScale || followSkeletonFlip) {
|
|
Vector3 localScale = new Vector3(1f, 1f, 1f);
|
|
if (followParentWorldScale && parentBone != null) {
|
|
float cumulativeScaleX = 1.0f;
|
|
float cumulativeScaleY = 1.0f;
|
|
Bone p = parentBone;
|
|
while (p != null) {
|
|
cumulativeScaleX *= p.AppliedPose.ScaleX;
|
|
cumulativeScaleY *= p.AppliedPose.ScaleY;
|
|
p = p.Parent;
|
|
};
|
|
scaleSignX = Mathf.Sign(cumulativeScaleX);
|
|
scaleSignY = Mathf.Sign(cumulativeScaleY);
|
|
localScale = new Vector3(parentBone.AppliedPose.WorldScaleX * scaleSignX, parentBone.AppliedPose.WorldScaleY * scaleSignY, 1f);
|
|
}
|
|
if (followLocalScale)
|
|
localScale.Scale(new Vector3(bone.AppliedPose.ScaleX, bone.AppliedPose.ScaleY, 1f));
|
|
if (followSkeletonFlip)
|
|
localScale.y *= Mathf.Sign(skeleton.ScaleX * skeleton.ScaleY) * additionalFlipScale;
|
|
thisTransform.localScale = localScale;
|
|
}
|
|
|
|
if (skeletonTransformIsParent) {
|
|
// Recommended setup: Use local transform properties if Spine GameObject is the immediate parent
|
|
thisTransform.localPosition = new Vector3(
|
|
followXYPosition ? bone.AppliedPose.WorldX : thisTransform.localPosition.x,
|
|
followXYPosition ? bone.AppliedPose.WorldY : thisTransform.localPosition.y,
|
|
followZPosition ? (followAttachmentZSpacing ? GetAttachmentZPosition() : 0f) : thisTransform.localPosition.z);
|
|
if (followBoneRotation) {
|
|
float halfRotation = Mathf.Atan2(bone.AppliedPose.C, bone.AppliedPose.A) * 0.5f;
|
|
if (followLocalScale && bone.AppliedPose.ScaleX < 0) // Negate rotation from negative scaleX. Don't use negative determinant. local scaleY doesn't factor into used rotation.
|
|
halfRotation += Mathf.PI * 0.5f;
|
|
if (followParentWorldScale && scaleSignX < 0)
|
|
halfRotation += Mathf.PI * 0.5f;
|
|
|
|
Quaternion q = default(Quaternion);
|
|
q.z = Mathf.Sin(halfRotation);
|
|
q.w = Mathf.Cos(halfRotation);
|
|
thisTransform.localRotation = q;
|
|
}
|
|
} else { // For special cases: Use transform world properties if transform relationship is complicated
|
|
if (!skeletonTransform) return;
|
|
|
|
float z0Position = (followZPosition && followAttachmentZSpacing) ? GetAttachmentZPosition() : 0f;
|
|
Vector3 targetWorldPosition = skeletonTransform.TransformPoint(new Vector3(bone.AppliedPose.WorldX, bone.AppliedPose.WorldY, z0Position));
|
|
if (!followZPosition) targetWorldPosition.z = thisTransform.position.z;
|
|
if (!followXYPosition) {
|
|
targetWorldPosition.x = thisTransform.position.x;
|
|
targetWorldPosition.y = thisTransform.position.y;
|
|
}
|
|
|
|
Vector3 skeletonLossyScale = skeletonTransform.lossyScale;
|
|
Transform transformParent = thisTransform.parent;
|
|
Vector3 parentLossyScale = transformParent != null ? transformParent.lossyScale : Vector3.one;
|
|
if (followBoneRotation) {
|
|
float boneWorldRotation = bone.AppliedPose.WorldRotationX;
|
|
|
|
if ((skeletonLossyScale.x * skeletonLossyScale.y) < 0)
|
|
boneWorldRotation = -boneWorldRotation;
|
|
|
|
if (followSkeletonFlip || maintainedAxisOrientation == AxisOrientation.XAxis) {
|
|
if ((skeletonLossyScale.x * parentLossyScale.x < 0))
|
|
boneWorldRotation += 180f;
|
|
} else {
|
|
if ((skeletonLossyScale.y * parentLossyScale.y < 0))
|
|
boneWorldRotation += 180f;
|
|
}
|
|
if (followParentWorldScale && scaleSignX < 0)
|
|
boneWorldRotation += 180f;
|
|
|
|
Vector3 worldRotation = skeletonTransform.rotation.eulerAngles;
|
|
if (followLocalScale && bone.AppliedPose.ScaleX < 0) boneWorldRotation += 180f;
|
|
thisTransform.SetPositionAndRotation(targetWorldPosition, Quaternion.Euler(worldRotation.x, worldRotation.y, worldRotation.z + boneWorldRotation));
|
|
} else {
|
|
thisTransform.position = targetWorldPosition;
|
|
}
|
|
|
|
additionalFlipScale = Mathf.Sign(skeletonLossyScale.x * parentLossyScale.x
|
|
* skeletonLossyScale.y * parentLossyScale.y);
|
|
}
|
|
}
|
|
|
|
float GetAttachmentZPosition () {
|
|
var drawOrderPose = skeletonRenderer.Skeleton.DrawOrder.Pose;
|
|
int boneIndex = drawOrderPose.FindIndex(slot => slot.Bone == bone);
|
|
if (boneIndex < 0) return 0f;
|
|
return skeletonRenderer.zSpacing * boneIndex;
|
|
}
|
|
|
|
#region Transfer of Deprecated Fields
|
|
#if UNITY_EDITOR && AUTO_UPGRADE_TO_43_COMPONENTS
|
|
public virtual void UpgradeTo43 () {
|
|
wasUpgradedTo43 = true;
|
|
if (skeletonRenderer == null) {
|
|
Component previousReference = previousSkeletonRenderer != null ? previousSkeletonRenderer : this;
|
|
skeletonRenderer = previousReference.GetComponent<SkeletonRenderer>();
|
|
if (skeletonRenderer == null)
|
|
Debug.LogError("Please manually re-assign SkeletonRenderer at BoneFollower, " +
|
|
"automatic upgrade failed.", this);
|
|
}
|
|
}
|
|
[SerializeField, HideInInspector, FormerlySerializedAs("skeletonRenderer")] Component previousSkeletonRenderer;
|
|
[SerializeField] protected bool wasUpgradedTo43 = false;
|
|
#endif
|
|
#endregion
|
|
}
|
|
}
|