class PathConstraintData

package spine

extends ConstraintData

@:directlyUsed

Available with spine plugin

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()

target:SlotData

positionMode:PositionMode

spacingMode:SpacingMode

rotateMode:RotateMode

@: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.

setTarget(target:SlotData):Void

getPositionMode():PositionMode

The mode for positioning the first bone on the path.

setPositionMode(positionMode:PositionMode):Void

getSpacingMode():SpacingMode

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

setSpacingMode(spacingMode:SpacingMode):Void

getRotateMode():RotateMode

The mode for adjusting the rotation of the bones.

setRotateMode(rotateMode:RotateMode):Void

getOffsetRotation():Float

An offset added to the constrained bone rotation.

setOffsetRotation(offsetRotation:Float):Void

getPosition():Float

The position along the path.

setPosition(position:Float):Void

getSpacing():Float

The spacing between bones.

setSpacing(spacing:Float):Void

getMixRotate():Float

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

setMixRotate(mixRotate:Float):Void

getMixX():Float

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

setMixX(mixX:Float):Void

getMixY():Float

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

setMixY(mixY:Float):Void

Inherited Variables

Defined by ConstraintData

name:String

@: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()}.

setOrder(order:Int):Void

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

toString():String