[libgdx] Javadoc for skeleton transform properties.

This commit is contained in:
Nathan Sweet 2022-06-16 11:19:51 -04:00
parent 1ed52764b3
commit a1e782a533

View File

@ -707,8 +707,9 @@ public class Skeleton {
color.set(r, g, b, a); color.set(r, g, b, a);
} }
/** Scales the entire skeleton on the X axis. This affects all bones, even if the bone's transform mode disallows scale /** Scales the entire skeleton on the X axis.
* inheritance. */ * <p>
* Bones that do not inherit scale are still affected by this property. */
public float getScaleX () { public float getScaleX () {
return scaleX; return scaleX;
} }
@ -717,8 +718,9 @@ public class Skeleton {
this.scaleX = scaleX; this.scaleX = scaleX;
} }
/** Scales the entire skeleton on the Y axis. This affects all bones, even if the bone's transform mode disallows scale /** Scales the entire skeleton on the Y axis.
* inheritance. */ * <p>
* Bones that do not inherit scale are still affected by this property. */
public float getScaleY () { public float getScaleY () {
return scaleY; return scaleY;
} }
@ -727,12 +729,17 @@ public class Skeleton {
this.scaleY = scaleY; this.scaleY = scaleY;
} }
/** Scales the entire skeleton on the X and Y axes.
* <p>
* Bones that do not inherit scale are still affected by this property. */
public void setScale (float scaleX, float scaleY) { public void setScale (float scaleX, float scaleY) {
this.scaleX = scaleX; this.scaleX = scaleX;
this.scaleY = scaleY; this.scaleY = scaleY;
} }
/** Sets the skeleton X position, which is added to the root bone worldX position. */ /** Sets the skeleton X position, which is added to the root bone worldX position.
* <p>
* Bones that do not inherit translation are still affected by this property. */
public float getX () { public float getX () {
return x; return x;
} }
@ -741,7 +748,9 @@ public class Skeleton {
this.x = x; this.x = x;
} }
/** Sets the skeleton Y position, which is added to the root bone worldY position. */ /** Sets the skeleton Y position, which is added to the root bone worldY position.
* <p>
* Bones that do not inherit translation are still affected by this property. */
public float getY () { public float getY () {
return y; return y;
} }
@ -750,7 +759,9 @@ public class Skeleton {
this.y = y; this.y = y;
} }
/** Sets the skeleton X and Y position, which is added to the root bone worldX and worldY position. */ /** Sets the skeleton X and Y position, which is added to the root bone worldX and worldY position.
* <p>
* Bones that do not inherit translation are still affected by this property. */
public void setPosition (float x, float y) { public void setPosition (float x, float y) {
this.x = x; this.x = x;
this.y = y; this.y = y;