From 7ac77fb177c8188ff8d67421d5b89e7baea6021c Mon Sep 17 00:00:00 2001 From: NathanSweet Date: Sat, 29 Oct 2016 20:05:26 +0200 Subject: [PATCH] Javadoc. --- .../src/com/esotericsoftware/spine/Slot.java | 3 ++- .../spine/attachments/VertexAttachment.java | 11 ++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/spine-libgdx/spine-libgdx/src/com/esotericsoftware/spine/Slot.java b/spine-libgdx/spine-libgdx/src/com/esotericsoftware/spine/Slot.java index c31a8c999..72d6b7b98 100644 --- a/spine-libgdx/spine-libgdx/src/com/esotericsoftware/spine/Slot.java +++ b/spine-libgdx/spine-libgdx/src/com/esotericsoftware/spine/Slot.java @@ -112,7 +112,8 @@ public class Slot { attachmentTime = bone.skeleton.time - time; } - /** Vertices to deform the slot's attachment. + /** Vertices to deform the slot's attachment. For an unweighted mesh, the entries are local positions for each vertex. For a + * weighted mesh, the entries are an offset for each vertex which will be added to the mesh's local vertex positions. *

* See {@link VertexAttachment#computeWorldVertices(Slot, int, int, float[], int)} and {@link DeformTimeline}. */ public FloatArray getAttachmentVertices () { diff --git a/spine-libgdx/spine-libgdx/src/com/esotericsoftware/spine/attachments/VertexAttachment.java b/spine-libgdx/spine-libgdx/src/com/esotericsoftware/spine/attachments/VertexAttachment.java index b0c57b607..9ecf01a3f 100644 --- a/spine-libgdx/spine-libgdx/src/com/esotericsoftware/spine/attachments/VertexAttachment.java +++ b/spine-libgdx/spine-libgdx/src/com/esotericsoftware/spine/attachments/VertexAttachment.java @@ -46,15 +46,16 @@ public class VertexAttachment extends Attachment { super(name); } - /** Transforms local {@link #getVertices()} to world coordinates, using 0 for start and offset. + /** Transforms the attachment's local {@link #getVertices()} to world coordinates, using 0 for start and + * offset. *

* See {@link #computeWorldVertices(Slot, int, int, float[], int)}. */ public void computeWorldVertices (Slot slot, float[] worldVertices) { computeWorldVertices(slot, 0, worldVerticesLength, worldVertices, 0); } - /** Transforms local {@link #getVertices()} to world coordinates. If the slot has {@link Slot#getAttachmentVertices()}, they - * are used to deform the vertices. + /** Transforms the attachment's local {@link #getVertices()} to world coordinates. If the slot has + * {@link Slot#getAttachmentVertices()}, they are used to deform the vertices. *

* See World transforms in the Spine * Runtimes Guide. @@ -126,8 +127,8 @@ public class VertexAttachment extends Attachment { } /** The bones which affect the {@link #getVertices()}. The array entries are, for each vertex, the number of bones affecting - * the vertex followed by that many bone indices, which is the index of the bone in {@link Skeleton#getBones()}. May be null if - * this attachment has no weights. */ + * the vertex followed by that many bone indices, which is the index of the bone in {@link Skeleton#getBones()}. Will be null + * if this attachment has no weights. */ public int[] getBones () { return bones; }