Stores the setup pose for a {@link PathConstraint}.

See Path constraints in the Spine User Guide.

Constructor

new(name:String)

Variables

@:value(new Array())bones:Array<BoneData> = new Array()

@:value(0)offsetRotation:Float = 0

@:value(0)position:Float = 0

@:value(0)spacing:Float = 0

@:value(0)mixRotate:Float = 0

@:value(0)mixX:Float = 0

@:value(0)mixY:Float = 0

Methods

getBones():Array<BoneData>

The bones that will be modified by this path constraint.

getTarget():SlotData

The slot whose path attachment will be used to constrained the bones.

getPositionMode():PositionMode

The mode for positioning the first bone on the path.

getSpacingMode():SpacingMode

The mode for positioning the bones after the first bone on the path.

getRotateMode():RotateMode

The mode for adjusting the rotation of the bones.

getOffsetRotation():Float

An offset added to the constrained bone rotation.

setOffsetRotation(offsetRotation:Float):Void

getPosition():Float

The position along the path.

getSpacing():Float

The spacing between bones.

getMixRotate():Float

A percentage (0-1) that controls the mix between the constrained and unconstrained rotation.

getMixX():Float

A percentage (0-1) that controls the mix between the constrained and unconstrained translation X.

getMixY():Float

A percentage (0-1) that controls the mix between the constrained and unconstrained translation Y.

Inherited Variables

Defined by ConstraintData

@:value(0)order:Int = 0

@:value(false)skinRequired:Bool = false

Inherited Methods

Defined by ConstraintData

getName():String

The constraint's name, which is unique across all constraints in the skeleton of the same type.

getOrder():Int

The ordinal of this constraint for the order a skeleton's constraints will be applied by {@link Skeleton#updateWorldTransform()}.

getSkinRequired():Bool

When true, {@link Skeleton#updateWorldTransform()} only updates this constraint if the {@link Skeleton#getSkin()} contains this constraint.

See {@link Skin#getConstraints()}.

setSkinRequired(skinRequired:Bool):Void