class IkConstraintTimeline

package spine

extends CurveTimeline › Timeline

import spine.Animation

@:directlyUsed

Available with spine plugin

Changes an IK constraint's {@link IkConstraint#getMix()}, {@link IkConstraint#getSoftness()}, {@link IkConstraint#getBendDirection()}, {@link IkConstraint#getStretch()}, and {@link IkConstraint#getCompress()}.

Static variables

@:value(6)staticinlineread onlyENTRIES:Int = 6

@:value(CurveTimeline.LINEAR)staticinlineread onlyLINEAR:Int = CurveTimeline.LINEAR

@:value(CurveTimeline.STEPPED)staticinlineread onlySTEPPED:Int = CurveTimeline.STEPPED

@:value(CurveTimeline.BEZIER)staticinlineread onlyBEZIER:Int = CurveTimeline.BEZIER

@:value(CurveTimeline.BEZIER_SIZE)staticinlineread onlyBEZIER_SIZE:Int = CurveTimeline.BEZIER_SIZE

Constructor

new(frameCount:Int, bezierCount:Int, ikConstraintIndex:Int)

Variables

@:value(0)ikConstraintIndex:Int = 0

Methods

getIkConstraintIndex():Int

The index of the IK constraint slot in {@link Skeleton#getIkConstraints()} that will be changed when this timeline is applied.

setFrame(frame:Int, time:Float, mix:Float, softness:Float, bendDirection:Int, compress:Bool, stretch:Bool):Void

Sets the time, mix, softness, bend direction, compress, and stretch for the specified frame.

Parameters:

frame

Between 0 and frameCount, inclusive.

time

The frame time in seconds.

bendDirection

1 or -1.

Inherited Variables

Defined by CurveTimeline

Defined by Timeline

Inherited Methods

Defined by CurveTimeline

setLinear(frame:Int):Void

Sets the specified frame to linear interpolation.

Parameters:

frame

Between 0 and frameCount - 1, inclusive.

setStepped(frame:Int):Void

Sets the specified frame to stepped interpolation.

Parameters:

frame

Between 0 and frameCount - 1, inclusive.

getCurveType(frame:Int):Int

Returns the interpolation type for the specified frame. @link #LINEAR}, {@link #STEPPED}, or {@link #BEZIER} + the index of the Bezier segments.

Parameters:

frame

Between 0 and frameCount - 1, inclusive.

Returns:

{

shrink(bezierCount:Int):Void

Shrinks the storage for Bezier curves, for use when bezierCount (specified in the constructor) was larger than the actual number of Bezier curves.

setBezier(bezier:Int, frame:Int, value:Int, time1:Float, value1:Float, cx1:Float, cy1:Float, cx2:Float, cy2:Float, time2:Float, value2:Float):Void

Stores the segments for the specified Bezier curve. For timelines that modify multiple values, there may be more than one curve per frame.

Parameters:

bezier

The ordinal of this Bezier curve for this timeline, between 0 and bezierCount - 1 (specified in the constructor), inclusive.

frame

Between 0 and frameCount - 1, inclusive.

value

The index of the value for the frame this curve is used for.

time1

The time for the first key.

value1

The value for the first key.

cx1

The time for the first Bezier handle.

cy1

The value for the first Bezier handle.

cx2

The time of the second Bezier handle.

cy2

The value for the second Bezier handle.

time2

The time for the second key.

value2

The value for the second key.

getBezierValue(time:Float, frameIndex:Int, valueOffset:Int, i:Int):Float

Returns the Bezier interpolated value for the specified time. @link #getFrames()} for the values of the frame before time. @link #getCurveType(int)}.

Parameters:

frameIndex

The index into {

valueOffset

The offset from frameIndex to the value this curve is used for.

i

The index of the Bezier segments. See {

Defined by Timeline

getPropertyIds():StringArray

Uniquely encodes both the type of this timeline and the skeleton properties that it affects.

getFrames():FloatArray

The time in seconds and any other values for each frame.

getFrameCount():Int

The number of frames for this timeline.

getDuration():Float