Merge branch '4.3-beta' into c3

Author: davidetan

CHANGELOG.md

@@ -272,7 +272,7 @@
 - **Additions**
   - Added `Slider` and `SliderData` classes for slider constraints
   - Added `SliderTimeline` and `SliderMixTimeline` for animating sliders
-  - Added new pose system with `BoneLocal`, `BonePose`, and related classes
+  - Added new pose system with `BonePose` and related classes
   - Added `IPose`, `Posed`, and `PosedActive` base classes for unified pose management
   - Added `IConstraintTimeline` interface for unified constraint timeline indexing
   - Added `Animation.Bones` property to get bone indices used by an animation
@@ -387,6 +387,19 @@
   - Renamed timeline constraint index methods to use unified `ConstraintIndex` property
   - Reorganized timeline class hierarchy with new base classes
   - Removed `AtlasAttachmentLoader` method `AtlasRegion FindRegion(string name)` from public interface. Added `protected AtlasRegion FindRegion(string name, string path)` instead which may be overridden instead when deriving your own subclass.
+  - Renamed `Skin.SkinEntry.Name` to `Skin.SkinEntry.PlaceholderName` to better match Spine editor terminology.
+  - Removed `TrackEntry.HoldPrevious` and `TrackEntry.InterruptAlpha`. New `AnimationState` hold system automatically calculates the required state values.
+  - Removed `BoneLocal` class. `BonePose` now directly implements `IPose<BonePose>` and contains all local pose fields. Replace any use of `BoneLocal` → `BonePose`.
+  - `EventData` no longer stores `Int`, `Float`, `String`, `Volume`, and `Balance` properties directly. Use `EventData.SetupPose` to access the setup pose `Event` which provides these properties instead.
+    ||||
+    |-----|-|-----|
+    | `EventData.Int`     |→| `EventData.SetupPose.Int` |
+    | `EventData.Float`   |→| `EventData.SetupPose.Float` |
+    | `EventData.String`  |→| `EventData.SetupPose.String` |
+    | `EventData.Volume`  |→| `EventData.SetupPose.Volume` |
+    | `EventData.Balance` |→| `EventData.SetupPose.Balance` |
+  - `Timeline.PropertyIds` type changed from `string[]` to `ulong[]`. `Animation.HasTimeline()` parameter and Timeline constructors changed accordingly.
+  - `Skeleton.DrawOrder` type changed from `ExposedList<Slot>` to `DrawOrder` class. Use `Skeleton.DrawOrder.AppliedPose` for rendering and `Skeleton.DrawOrder.Pose` for changing the draw order.
 
 ### Unity
 
@@ -409,6 +422,7 @@
   - Renamed `ToAtlasRegionPMAClone` to `ToAtlasRegionWithNewPMATexture`.
   - Renamed `ToRegionAttachmentPMAClone` to `ToRegionAttachmentWithNewPMATexture`.
   - Removed support for long abandoned thirdparty asset "2D Toolkit" (TK2D) by Unikron Software.
+  - Removed Spine Timeline `Spine Animation State Clip` property `Hold Previous`. New `AnimationState` hold system automatically calculates the required state values.
 
 - **Changes of default values**
   - Changed default atlas texture workflow from PMA to straight alpha textures. This move was done because straight alpha textures are compatible with both Gamma and Linear color space, with the latter being the default for quite some time now in Unity. Note that `PMA Vertex Color` is unaffected and shall be enabled as usual to allow for single-pass additive rendering.

spine-csharp/src/Animation.cs

@@ -32,7 +32,7 @@
 
 namespace Spine {
 
-	/// <summary>Stores mix (crossfade) durations to be applied when AnimationState animations are changed.</summary>
+	/// <summary>Stores mix (crossfade) durations to be applied when <see cref="AnimationState"/> animations are changed on the same track.</summary>
 	public class AnimationStateData {
 		internal SkeletonData skeletonData;
 		readonly Dictionary<AnimationPair, float> animationToMixTime = new Dictionary<AnimationPair, float>(AnimationPairComparer.Instance);
@@ -70,8 +70,8 @@ public void SetMix (Animation from, Animation to, float duration) {
 		}
 
 		/// <summary>
-		/// The mix duration to use when changing from the specified animation to the other,
-		/// or the DefaultMix if no mix duration has been set.
+		/// Returns the mix duration to use when changing from the specified animation to the other on the same track,
+		/// or the <see cref="DefaultMix"/> if no mix duration has been set.
 		/// </summary>
 		public float GetMix (Animation from, Animation to) {
 			if (from == null) throw new ArgumentNullException("from", "from cannot be null.");

spine-csharp/src/AnimationState.cs

@@ -32,11 +32,13 @@
 namespace Spine {
 
 	/// <summary>
-	/// An AttachmentLoader that configures attachments using texture regions from an Atlas.
+	/// An <see cref="AttachmentLoader"/> that configures attachments using texture regions from an <see cref="Atlas"/>.
 	/// See <a href='http://esotericsoftware.com/spine-loading-skeleton-data#JSON-and-binary-data'>Loading Skeleton Data</a> in the Spine Runtimes Guide.
 	/// </summary>
 	public class AtlasAttachmentLoader : AttachmentLoader {
 		private Atlas[] atlasArray;
+		/// <summary>If true, <see cref="FindRegion(string, string)"/> may return null. If false, an error is raised if the texture region is not
+		/// found. Default is false.</summary>
 		public bool allowMissingRegions;
 
 		public AtlasAttachmentLoader (params Atlas[] atlasArray)
@@ -49,13 +51,17 @@ public AtlasAttachmentLoader (bool allowMissingRegions, params Atlas[] atlasArra
 			this.allowMissingRegions = allowMissingRegions;
 		}
 
+		/// <summary>Sets each <see cref="Sequence.Regions"/> by calling <see cref="FindRegion(string, string)"/> for each texture region using
+		/// <see cref="Sequence.GetPath(string, int)"/>.</summary>
 		protected void FindRegions (string name, string basePath, Sequence sequence) {
 			TextureRegion[] regions = sequence.Regions;
 			for (int i = 0, n = regions.Length; i < n; i++) {
 				regions[i] = FindRegion(name, sequence.GetPath(basePath, i));
 			}
 		}
 
+		/// <summary>Looks for the region with the specified path. If not found and <see cref="allowMissingRegions"/> is false, an error is
+		/// raised.</summary>
 		protected AtlasRegion FindRegion (string name, string path) {
 			for (int i = 0; i < atlasArray.Length; i++) {
 				AtlasRegion region = atlasArray[i].FindRegion(path);

spine-csharp/src/AnimationStateData.cs

@@ -31,7 +31,8 @@
 
 namespace Spine {
 
-	/// <summary>The base class for all attachments.</summary>
+	/// <summary>The base class for all attachments. Multiple <see cref="Skeleton"/> instances, slots, or skins can use the same
+	/// attachments.</summary>
 	abstract public class Attachment {
 		internal Attachment timelineAttachment;
 

spine-csharp/src/Attachments/AtlasAttachmentLoader.cs

@@ -33,6 +33,8 @@ namespace Spine {
 	public class ClippingAttachment : VertexAttachment {
 		internal SlotData endSlot;
 
+		/// <summary>Clipping is performed between the clipping attachment's slot and the end slot. If null, clipping is done until the end of
+		/// the skeleton's rendering.</summary>
 		public SlotData EndSlot { get { return endSlot; } set { endSlot = value; } }
 
 		public ClippingAttachment (string name) : base(name) {

spine-csharp/src/Attachments/Attachment.cs

@@ -36,11 +36,15 @@ namespace Spine {
 	using Color32F = UnityEngine.Color;
 #endif
 
+	/// <summary>Interface for an attachment that gets 1 or more texture regions from a <see cref="Sequence"/>.</summary>
 	public interface IHasSequence {
+		/// <summary>The base path for the attachment's texture region.</summary>
 		string Path { get; set; }
+		/// <summary>The color the attachment is tinted, to be combined with <see cref="SlotPose.Color"/>.</summary>
 		Color32F GetColor ();
 		void SetColor (Color32F color);
 		void SetColor (float r, float g, float b, float a);
+		/// <summary>The sequence that provides texture regions, UVs, and vertex offsets for rendering this attachment.</summary>
 		Sequence Sequence { get; }
 		void UpdateSequence ();
 	}

spine-csharp/src/Attachments/ClippingAttachment.cs

@@ -94,8 +94,8 @@ public MeshAttachment ParentMesh {
 
 		// Nonessential.
 		/// <summary>
-		/// Vertex index pairs describing edges for controlling triangulation, or be null if nonessential data was not exported. Mesh
-		/// triangles never cross edges. Triangulation is not performed at runtime.
+		/// Vertex index pairs describing edges for controlling triangulation, or null if nonessential data was not exported. Mesh
+		/// triangles do not cross edges. Triangulation is not performed at runtime.
 		/// </summary>
 		public int[] Edges { get; set; }
 		public float Width { get; set; }

spine-csharp/src/Attachments/IHasSequence.cs

@@ -39,8 +39,8 @@ public class PathAttachment : VertexAttachment {
 		public float[] Lengths { get { return lengths; } set { lengths = value; } }
 		/// <summary>If true, the start and end knots are connected.</summary>
 		public bool Closed { get { return closed; } set { closed = value; } }
-		/// <summary>If true, additional calculations are performed to make computing positions along the path more accurate and movement along
-		/// the path have a constant speed.</summary>
+		/// <summary>If true, additional calculations are performed to make computing positions along the path more accurate so movement along
+		/// the path has a constant speed.</summary>
 		public bool ConstantSpeed { get { return constantSpeed; } set { constantSpeed = value; } }
 
 		public PathAttachment (String name)