API Reference

Class List

pc.Skeleton

Represents a skeleton used to play animations.

Summary

Properties

animation

Animation currently assigned to skeleton.

currentTime

Current time of currently active animation in seconds.

looping

Determines whether skeleton is looping its animation.

numNodes

Read-only property that returns number of nodes of a skeleton.[read only]

Methods

addTime

Progresses The animation assigned to The specified skeleton by The supplied time delta.

blend

Blends two skeletons together.

setGraph

Links a skeleton to a node hierarchy.

updateGraph

Synchronizes the currently linked node hierarchy with the current state of the skeleton.

Details

Constructor

Skeleton(graph)

Parameters

graphpc.GraphNode

The root pc.GraphNode of the skeleton.

Properties

pc.Animationanimation

Animation currently assigned to skeleton.

numbercurrentTime

Current time of currently active animation in seconds. This value is between zero and the duration of the animation.

booleanlooping

Determines whether skeleton is looping its animation.

numbernumNodes

Read-only property that returns number of nodes of a skeleton.

[read only]

Methods

addTime(delta)

Progresses The animation assigned to The specified skeleton by The supplied time delta. If the delta takes the animation passed its end point, if the skeleton is set to loop, the animation will continue from the beginning. Otherwise, the animation's current time will remain at its duration (i.e. the end).

Parameters

deltanumber

The time in seconds to progress the skeleton's animation.

blend(skel1, skel2, alpha)

Blends two skeletons together.

Parameters

skel1pc.Skeleton

Skeleton holding the first pose to be blended.

skel2pc.Skeleton

Skeleton holding the second pose to be blended.

alphanumber

The value controlling the interpolation in relation to the two input skeletons. The value is in the range 0 to 1, 0 generating skel1, 1 generating skel2 and anything in between generating a spherical interpolation between the two.

setGraph(graph)

Links a skeleton to a node hierarchy. The nodes animated skeleton are then subsequently used to drive the local transformation matrices of the node hierarchy.

Parameters

graphpc.GraphNode

The root node of the graph that the skeleton is to drive.

updateGraph()

Synchronizes the currently linked node hierarchy with the current state of the skeleton. Internally, this function converts the interpolated keyframe at each node in the skeleton into the local transformation matrix at each corresponding node in the linked node hierarchy.