View source

class Skeleton

package spinehaxe

@:directlyUsed
  • Spine Runtimes Software License v2.5

Copyright (c) 2013-2016, Esoteric Software All rights reserved.

You are granted a perpetual, non-exclusive, non-sublicensable, and non-transferable license to use, install, execute, and perform the Spine Runtimes software and derivative works solely for personal or internal use. Without the written permission of Esoteric Software (see Section 2 of the Spine Software License Agreement), you may not (a) modify, translate, adapt, or develop new applications using the Spine Runtimes or otherwise create derivative works or improvements of the Spine Runtimes or (b) remove, delete, alter, or obscure any trademarks or any copyright, trademark, patent, or other intellectual property or proprietary rights notices on or in the Software, including any copy thereof. Redistributions in binary or source form must include this license and terms.

THIS SOFTWARE IS PROVIDED BY ESOTERIC SOFTWARE "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 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 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Constructor

new(data:SkeletonData)

Variables

@:value(1)a:Float = 1

@:value(1)b:Float = 1

bones:Array<Bone>

read onlydata:SkeletonData

drawOrder:Array<Slot>

@:value(false)flipX:Bool = false

@:value(false)flipY:Bool = false

@:value(1)g:Float = 1

read onlygetUpdateCache:Array<Updatable>

ikConstraints:Array<IkConstraint>

pathConstraints:Array<PathConstraint>

@:value(1)r:Float = 1

skin:Skin

skinName:String

slots:Array<Slot>

@:value(0)time:Float = 0

transformConstraints:Array<TransformConstraint>

@:value(0)x:Float = 0

@:value(0)y:Float = 0

Methods

findBone(boneName:String):Bone

Returns:

May be null.

findBoneIndex(boneName:String):Int

Returns:

-1 if the bone was not found.

findIkConstraint(constraintName:String):IkConstraint

Returns:

May be null.

findPathConstraint(constraintName:String):PathConstraint

Returns:

May be null.

findSlot(slotName:String):Slot

Returns:

May be null.

findSlotIndex(slotName:String):Int

Returns:

-1 if the bone was not found.

findTransformConstraint(constraintName:String):TransformConstraint

Returns:

May be null.

getAttachmentForSlotIndex(slotIndex:Int, attachmentName:String):Attachment

Returns:

May be null.

getAttachmentForSlotName(slotName:String, attachmentName:String):Attachment

Returns:

May be null.

setAttachment(slotName:String, attachmentName:String):Void

Parameters:

attachmentName

May be null.

setBonesToSetupPose():Void

Sets the bones and constraints to their setup pose values.

setSlotsToSetupPose():Void

setToSetupPose():Void

Sets the bones, constraints, and slots to their setup pose values.

toString():String

update(delta:Float):Void

updateCache():Void

Caches information about bones and constraints. Must be called if bones, constraints, or weighted path attachments are added or removed.

updateWorldTransform():Void

Updates the world transform for each bone and applies constraints.