/****************************************************************************** * Spine Runtimes License Agreement * Last updated January 1, 2020. Replaces all prior versions. * * Copyright (c) 2013-2020, 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 System; using System.Collections.Generic; namespace Spine { public class Skeleton { internal SkeletonData data; internal ExposedList bones; internal ExposedList slots; internal ExposedList drawOrder; internal ExposedList ikConstraints; internal ExposedList transformConstraints; internal ExposedList pathConstraints; internal ExposedList updateCache = new ExposedList(); internal ExposedList updateCacheReset = new ExposedList(); internal Skin skin; internal float r = 1, g = 1, b = 1, a = 1; internal float time; private float scaleX = 1, scaleY = 1; internal float x, y; public SkeletonData Data { get { return data; } } public ExposedList Bones { get { return bones; } } public ExposedList UpdateCacheList { get { return updateCache; } } public ExposedList Slots { get { return slots; } } public ExposedList DrawOrder { get { return drawOrder; } } public ExposedList IkConstraints { get { return ikConstraints; } } public ExposedList PathConstraints { get { return pathConstraints; } } public ExposedList TransformConstraints { get { return transformConstraints; } } public Skin Skin { get { return skin; } set { SetSkin(value); } } public float R { get { return r; } set { r = value; } } public float G { get { return g; } set { g = value; } } public float B { get { return b; } set { b = value; } } public float A { get { return a; } set { a = value; } } public float Time { get { return time; } set { time = value; } } public float X { get { return x; } set { x = value; } } public float Y { get { return y; } set { y = value; } } public float ScaleX { get { return scaleX; } set { scaleX = value; } } public float ScaleY { get { return scaleY * (Bone.yDown ? -1 : 1); } set { scaleY = value; } } [Obsolete("Use ScaleX instead. FlipX is when ScaleX is negative.")] public bool FlipX { get { return scaleX < 0; } set { scaleX = value ? -1f : 1f; } } [Obsolete("Use ScaleY instead. FlipY is when ScaleY is negative.")] public bool FlipY { get { return scaleY < 0; } set { scaleY = value ? -1f : 1f; } } public Bone RootBone { get { return bones.Count == 0 ? null : bones.Items[0]; } } public Skeleton (SkeletonData data) { if (data == null) throw new ArgumentNullException("data", "data cannot be null."); this.data = data; bones = new ExposedList(data.bones.Count); foreach (BoneData boneData in data.bones) { Bone bone; if (boneData.parent == null) { bone = new Bone(boneData, this, null); } else { Bone parent = bones.Items[boneData.parent.index]; bone = new Bone(boneData, this, parent); parent.children.Add(bone); } bones.Add(bone); } slots = new ExposedList(data.slots.Count); drawOrder = new ExposedList(data.slots.Count); foreach (SlotData slotData in data.slots) { Bone bone = bones.Items[slotData.boneData.index]; Slot slot = new Slot(slotData, bone); slots.Add(slot); drawOrder.Add(slot); } ikConstraints = new ExposedList(data.ikConstraints.Count); foreach (IkConstraintData ikConstraintData in data.ikConstraints) ikConstraints.Add(new IkConstraint(ikConstraintData, this)); transformConstraints = new ExposedList(data.transformConstraints.Count); foreach (TransformConstraintData transformConstraintData in data.transformConstraints) transformConstraints.Add(new TransformConstraint(transformConstraintData, this)); pathConstraints = new ExposedList (data.pathConstraints.Count); foreach (PathConstraintData pathConstraintData in data.pathConstraints) pathConstraints.Add(new PathConstraint(pathConstraintData, this)); UpdateCache(); UpdateWorldTransform(); } /// Caches information about bones and constraints. Must be called if the is modified or if bones, constraints, or /// constraints, or weighted path attachments are added or removed. public void UpdateCache () { var updateCache = this.updateCache; updateCache.Clear(); this.updateCacheReset.Clear(); int boneCount = this.bones.Items.Length; var bones = this.bones; for (int i = 0; i < boneCount; i++) { Bone bone = bones.Items[i]; bone.sorted = bone.data.skinRequired; bone.active = !bone.sorted; } if (skin != null) { Object[] skinBones = skin.bones.Items; for (int i = 0, n = skin.bones.Count; i < n; i++) { Bone bone = (Bone)bones.Items[((BoneData)skinBones[i]).index]; do { bone.sorted = false; bone.active = true; bone = bone.parent; } while (bone != null); } } int ikCount = this.ikConstraints.Count, transformCount = this.transformConstraints.Count, pathCount = this.pathConstraints.Count; var ikConstraints = this.ikConstraints; var transformConstraints = this.transformConstraints; var pathConstraints = this.pathConstraints; int constraintCount = ikCount + transformCount + pathCount; //outer: for (int i = 0; i < constraintCount; i++) { for (int ii = 0; ii < ikCount; ii++) { IkConstraint constraint = ikConstraints.Items[ii]; if (constraint.data.order == i) { SortIkConstraint(constraint); goto continue_outer; //continue outer; } } for (int ii = 0; ii < transformCount; ii++) { TransformConstraint constraint = transformConstraints.Items[ii]; if (constraint.data.order == i) { SortTransformConstraint(constraint); goto continue_outer; //continue outer; } } for (int ii = 0; ii < pathCount; ii++) { PathConstraint constraint = pathConstraints.Items[ii]; if (constraint.data.order == i) { SortPathConstraint(constraint); goto continue_outer; //continue outer; } } continue_outer: {} } for (int i = 0; i < boneCount; i++) SortBone(bones.Items[i]); } private void SortIkConstraint (IkConstraint constraint) { constraint.active = constraint.target.active && (!constraint.data.skinRequired || (skin != null && skin.constraints.Contains(constraint.data))); if (!constraint.active) return; Bone target = constraint.target; SortBone(target); var constrained = constraint.bones; Bone parent = constrained.Items[0]; SortBone(parent); if (constrained.Count > 1) { Bone child = constrained.Items[constrained.Count - 1]; if (!updateCache.Contains(child)) updateCacheReset.Add(child); } updateCache.Add(constraint); SortReset(parent.children); constrained.Items[constrained.Count - 1].sorted = true; } private void SortPathConstraint (PathConstraint constraint) { constraint.active = constraint.target.bone.active && (!constraint.data.skinRequired || (skin != null && skin.constraints.Contains(constraint.data))); if (!constraint.active) return; Slot slot = constraint.target; int slotIndex = slot.data.index; Bone slotBone = slot.bone; if (skin != null) SortPathConstraintAttachment(skin, slotIndex, slotBone); if (data.defaultSkin != null && data.defaultSkin != skin) SortPathConstraintAttachment(data.defaultSkin, slotIndex, slotBone); Attachment attachment = slot.attachment; if (attachment is PathAttachment) SortPathConstraintAttachment(attachment, slotBone); var constrained = constraint.bones; int boneCount = constrained.Count; for (int i = 0; i < boneCount; i++) SortBone(constrained.Items[i]); updateCache.Add(constraint); for (int i = 0; i < boneCount; i++) SortReset(constrained.Items[i].children); for (int i = 0; i < boneCount; i++) constrained.Items[i].sorted = true; } private void SortTransformConstraint (TransformConstraint constraint) { constraint.active = constraint.target.active && (!constraint.data.skinRequired || (skin != null && skin.constraints.Contains(constraint.data))); if (!constraint.active) return; SortBone(constraint.target); var constrained = constraint.bones; int boneCount = constrained.Count; if (constraint.data.local) { for (int i = 0; i < boneCount; i++) { Bone child = constrained.Items[i]; SortBone(child.parent); if (!updateCache.Contains(child)) updateCacheReset.Add(child); } } else { for (int i = 0; i < boneCount; i++) SortBone(constrained.Items[i]); } updateCache.Add(constraint); for (int i = 0; i < boneCount; i++) SortReset(constrained.Items[i].children); for (int i = 0; i < boneCount; i++) constrained.Items[i].sorted = true; } private void SortPathConstraintAttachment (Skin skin, int slotIndex, Bone slotBone) { foreach (var entryObj in skin.Attachments.Keys) { var entry = (Skin.SkinEntry)entryObj; if (entry.SlotIndex == slotIndex) SortPathConstraintAttachment(entry.Attachment, slotBone); } } private void SortPathConstraintAttachment (Attachment attachment, Bone slotBone) { if (!(attachment is PathAttachment)) return; int[] pathBones = ((PathAttachment)attachment).bones; if (pathBones == null) SortBone(slotBone); else { var bones = this.bones; for (int i = 0, n = pathBones.Length; i < n;) { int nn = pathBones[i++]; nn += i; while (i < nn) SortBone(bones.Items[pathBones[i++]]); } } } private void SortBone (Bone bone) { if (bone.sorted) return; Bone parent = bone.parent; if (parent != null) SortBone(parent); bone.sorted = true; updateCache.Add(bone); } private static void SortReset (ExposedList bones) { var bonesItems = bones.Items; for (int i = 0, n = bones.Count; i < n; i++) { Bone bone = bonesItems[i]; if (!bone.active) continue; if (bone.sorted) SortReset(bone.children); bone.sorted = false; } } /// Updates the world transform for each bone and applies constraints. public void UpdateWorldTransform () { var updateCacheReset = this.updateCacheReset; var updateCacheResetItems = updateCacheReset.Items; for (int i = 0, n = updateCacheReset.Count; i < n; i++) { Bone bone = updateCacheResetItems[i]; bone.ax = bone.x; bone.ay = bone.y; bone.arotation = bone.rotation; bone.ascaleX = bone.scaleX; bone.ascaleY = bone.scaleY; bone.ashearX = bone.shearX; bone.ashearY = bone.shearY; bone.appliedValid = true; } var updateItems = this.updateCache.Items; for (int i = 0, n = updateCache.Count; i < n; i++) updateItems[i].Update(); } /// /// Temporarily sets the root bone as a child of the specified bone, then updates the world transform for each bone and applies /// all constraints. /// public void UpdateWorldTransform (Bone parent) { // This partial update avoids computing the world transform for constrained bones when 1) the bone is not updated // before the constraint, 2) the constraint only needs to access the applied local transform, and 3) the constraint calls // updateWorldTransform. var updateCacheReset = this.updateCacheReset; var updateCacheResetItems = updateCacheReset.Items; for (int i = 0, n = updateCacheReset.Count; i < n; i++) { Bone bone = updateCacheResetItems[i]; bone.ax = bone.x; bone.ay = bone.y; bone.arotation = bone.rotation; bone.ascaleX = bone.scaleX; bone.ascaleY = bone.scaleY; bone.ashearX = bone.shearX; bone.ashearY = bone.shearY; bone.appliedValid = true; } // Apply the parent bone transform to the root bone. The root bone always inherits scale, rotation and reflection. Bone rootBone = this.RootBone; float pa = parent.a, pb = parent.b, pc = parent.c, pd = parent.d; rootBone.worldX = pa * x + pb * y + parent.worldX; rootBone.worldY = pc * x + pd * y + parent.worldY; float rotationY = rootBone.rotation + 90 + rootBone.shearY; float la = MathUtils.CosDeg(rootBone.rotation + rootBone.shearX) * rootBone.scaleX; float lb = MathUtils.CosDeg(rotationY) * rootBone.scaleY; float lc = MathUtils.SinDeg(rootBone.rotation + rootBone.shearX) * rootBone.scaleX; float ld = MathUtils.SinDeg(rotationY) * rootBone.scaleY; rootBone.a = (pa * la + pb * lc) * scaleX; rootBone.b = (pa * lb + pb * ld) * scaleX; rootBone.c = (pc * la + pd * lc) * scaleY; rootBone.d = (pc * lb + pd * ld) * scaleY; // Update everything except root bone. var updateCache = this.updateCache; var updateCacheItems = updateCache.Items; for (int i = 0, n = updateCache.Count; i < n; i++) { var updatable = updateCacheItems[i]; if (updatable != rootBone) updatable.Update(); } } /// Sets the bones, constraints, and slots to their setup pose values. public void SetToSetupPose () { SetBonesToSetupPose(); SetSlotsToSetupPose(); } /// Sets the bones and constraints to their setup pose values. public void SetBonesToSetupPose () { var bonesItems = this.bones.Items; for (int i = 0, n = bones.Count; i < n; i++) bonesItems[i].SetToSetupPose(); var ikConstraintsItems = this.ikConstraints.Items; for (int i = 0, n = ikConstraints.Count; i < n; i++) { IkConstraint constraint = ikConstraintsItems[i]; constraint.mix = constraint.data.mix; constraint.softness = constraint.data.softness; constraint.bendDirection = constraint.data.bendDirection; constraint.compress = constraint.data.compress; constraint.stretch = constraint.data.stretch; } var transformConstraintsItems = this.transformConstraints.Items; for (int i = 0, n = transformConstraints.Count; i < n; i++) { TransformConstraint constraint = transformConstraintsItems[i]; TransformConstraintData constraintData = constraint.data; constraint.rotateMix = constraintData.rotateMix; constraint.translateMix = constraintData.translateMix; constraint.scaleMix = constraintData.scaleMix; constraint.shearMix = constraintData.shearMix; } var pathConstraintItems = this.pathConstraints.Items; for (int i = 0, n = pathConstraints.Count; i < n; i++) { PathConstraint constraint = pathConstraintItems[i]; PathConstraintData constraintData = constraint.data; constraint.position = constraintData.position; constraint.spacing = constraintData.spacing; constraint.rotateMix = constraintData.rotateMix; constraint.translateMix = constraintData.translateMix; } } public void SetSlotsToSetupPose () { var slots = this.slots; var slotsItems = slots.Items; drawOrder.Clear(); for (int i = 0, n = slots.Count; i < n; i++) drawOrder.Add(slotsItems[i]); for (int i = 0, n = slots.Count; i < n; i++) slotsItems[i].SetToSetupPose(); } /// May be null. public Bone FindBone (string boneName) { if (boneName == null) throw new ArgumentNullException("boneName", "boneName cannot be null."); var bones = this.bones; var bonesItems = bones.Items; for (int i = 0, n = bones.Count; i < n; i++) { Bone bone = bonesItems[i]; if (bone.data.name == boneName) return bone; } return null; } /// -1 if the bone was not found. public int FindBoneIndex (string boneName) { if (boneName == null) throw new ArgumentNullException("boneName", "boneName cannot be null."); var bones = this.bones; var bonesItems = bones.Items; for (int i = 0, n = bones.Count; i < n; i++) if (bonesItems[i].data.name == boneName) return i; return -1; } /// May be null. public Slot FindSlot (string slotName) { if (slotName == null) throw new ArgumentNullException("slotName", "slotName cannot be null."); var slots = this.slots; var slotsItems = slots.Items; for (int i = 0, n = slots.Count; i < n; i++) { Slot slot = slotsItems[i]; if (slot.data.name == slotName) return slot; } return null; } /// -1 if the bone was not found. public int FindSlotIndex (string slotName) { if (slotName == null) throw new ArgumentNullException("slotName", "slotName cannot be null."); var slots = this.slots; var slotsItems = slots.Items; for (int i = 0, n = slots.Count; i < n; i++) if (slotsItems[i].data.name.Equals(slotName)) return i; return -1; } /// Sets a skin by name (see SetSkin). public void SetSkin (string skinName) { Skin foundSkin = data.FindSkin(skinName); if (foundSkin == null) throw new ArgumentException("Skin not found: " + skinName, "skinName"); SetSkin(foundSkin); } /// /// Sets the skin used to look up attachments before looking in the . If the /// skin is changed, is called. /// /// Attachments from the new skin are attached if the corresponding attachment from the old skin was attached. /// If there was no old skin, each slot's setup mode attachment is attached from the new skin. /// /// After changing the skin, the visible attachments can be reset to those attached in the setup pose by calling /// . /// Also, often is called before the next time the /// skeleton is rendered to allow any attachment keys in the current animation(s) to hide or show attachments from the new skin. /// /// May be null. public void SetSkin (Skin newSkin) { if (newSkin == skin) return; if (newSkin != null) { if (skin != null) newSkin.AttachAll(this, skin); else { ExposedList slots = this.slots; for (int i = 0, n = slots.Count; i < n; i++) { Slot slot = slots.Items[i]; string name = slot.data.attachmentName; if (name != null) { Attachment attachment = newSkin.GetAttachment(i, name); if (attachment != null) slot.Attachment = attachment; } } } } skin = newSkin; UpdateCache(); } /// Finds an attachment by looking in the {@link #skin} and {@link SkeletonData#defaultSkin} using the slot name and attachment name. /// May be null. public Attachment GetAttachment (string slotName, string attachmentName) { return GetAttachment(data.FindSlotIndex(slotName), attachmentName); } /// Finds an attachment by looking in the skin and skeletonData.defaultSkin using the slot index and attachment name.First the skin is checked and if the attachment was not found, the default skin is checked. /// May be null. public Attachment GetAttachment (int slotIndex, string attachmentName) { if (attachmentName == null) throw new ArgumentNullException("attachmentName", "attachmentName cannot be null."); if (skin != null) { Attachment attachment = skin.GetAttachment(slotIndex, attachmentName); if (attachment != null) return attachment; } return data.defaultSkin != null ? data.defaultSkin.GetAttachment(slotIndex, attachmentName) : null; } /// A convenience method to set an attachment by finding the slot with FindSlot, finding the attachment with GetAttachment, then setting the slot's slot.Attachment. /// May be null to clear the slot's attachment. public void SetAttachment (string slotName, string attachmentName) { if (slotName == null) throw new ArgumentNullException("slotName", "slotName cannot be null."); ExposedList slots = this.slots; for (int i = 0, n = slots.Count; i < n; i++) { Slot slot = slots.Items[i]; if (slot.data.name == slotName) { Attachment attachment = null; if (attachmentName != null) { attachment = GetAttachment(i, attachmentName); if (attachment == null) throw new Exception("Attachment not found: " + attachmentName + ", for slot: " + slotName); } slot.Attachment = attachment; return; } } throw new Exception("Slot not found: " + slotName); } /// May be null. public IkConstraint FindIkConstraint (string constraintName) { if (constraintName == null) throw new ArgumentNullException("constraintName", "constraintName cannot be null."); ExposedList ikConstraints = this.ikConstraints; for (int i = 0, n = ikConstraints.Count; i < n; i++) { IkConstraint ikConstraint = ikConstraints.Items[i]; if (ikConstraint.data.name == constraintName) return ikConstraint; } return null; } /// May be null. public TransformConstraint FindTransformConstraint (string constraintName) { if (constraintName == null) throw new ArgumentNullException("constraintName", "constraintName cannot be null."); ExposedList transformConstraints = this.transformConstraints; for (int i = 0, n = transformConstraints.Count; i < n; i++) { TransformConstraint transformConstraint = transformConstraints.Items[i]; if (transformConstraint.data.Name == constraintName) return transformConstraint; } return null; } /// May be null. public PathConstraint FindPathConstraint (string constraintName) { if (constraintName == null) throw new ArgumentNullException("constraintName", "constraintName cannot be null."); ExposedList pathConstraints = this.pathConstraints; for (int i = 0, n = pathConstraints.Count; i < n; i++) { PathConstraint constraint = pathConstraints.Items[i]; if (constraint.data.Name.Equals(constraintName)) return constraint; } return null; } public void Update (float delta) { time += delta; } /// Returns the axis aligned bounding box (AABB) of the region and mesh attachments for the current pose. /// The horizontal distance between the skeleton origin and the left side of the AABB. /// The vertical distance between the skeleton origin and the bottom side of the AABB. /// The width of the AABB /// The height of the AABB. /// Reference to hold a float[]. May be a null reference. This method will assign it a new float[] with the appropriate size as needed. public void GetBounds (out float x, out float y, out float width, out float height, ref float[] vertexBuffer) { float[] temp = vertexBuffer; temp = temp ?? new float[8]; var drawOrderItems = this.drawOrder.Items; float minX = int.MaxValue, minY = int.MaxValue, maxX = int.MinValue, maxY = int.MinValue; for (int i = 0, n = drawOrderItems.Length; i < n; i++) { Slot slot = drawOrderItems[i]; if (!slot.bone.active) continue; int verticesLength = 0; float[] vertices = null; Attachment attachment = slot.attachment; var regionAttachment = attachment as RegionAttachment; if (regionAttachment != null) { verticesLength = 8; vertices = temp; if (vertices.Length < 8) vertices = temp = new float[8]; regionAttachment.ComputeWorldVertices(slot.bone, temp, 0); } else { var meshAttachment = attachment as MeshAttachment; if (meshAttachment != null) { MeshAttachment mesh = meshAttachment; verticesLength = mesh.WorldVerticesLength; vertices = temp; if (vertices.Length < verticesLength) vertices = temp = new float[verticesLength]; mesh.ComputeWorldVertices(slot, 0, verticesLength, temp, 0); } } if (vertices != null) { for (int ii = 0; ii < verticesLength; ii += 2) { float vx = vertices[ii], vy = vertices[ii + 1]; minX = Math.Min(minX, vx); minY = Math.Min(minY, vy); maxX = Math.Max(maxX, vx); maxY = Math.Max(maxY, vy); } } } x = minX; y = minY; width = maxX - minX; height = maxY - minY; vertexBuffer = temp; } } }