Documentation / @imvu/cal3d / Animation

Class: Animation

Defined in: packages/cal3d/src/Animation.ts:101

A Cal3D skeletal animation (.caf binary / .xaf XML): per-bone keyframe tracks.

Constructors

Constructor

new Animation(init): Animation;

Defined in: packages/cal3d/src/Animation.ts:110

Parameters

Parameter	Type
init	AnimationInit

Returns

Animation

Properties

compressed

compressed: boolean = false;

Defined in: packages/cal3d/src/Animation.ts:108

Whether the parsed binary file used compressed keyframes.

---

duration

duration: number;

Defined in: packages/cal3d/src/Animation.ts:103

Length in seconds.

---

tracks

readonly tracks: Track[];

Defined in: packages/cal3d/src/Animation.ts:104

---

version

version: number | undefined;

Defined in: packages/cal3d/src/Animation.ts:106

The version of the file this was parsed from (undefined for animations built in code).

Methods

getTrack()

getTrack(boneId): Track | undefined;

Defined in: packages/cal3d/src/Animation.ts:123

Parameters

Parameter	Type
boneId	number

Returns

Track | undefined

---

toBinary()

toBinary(__namedParameters?): Uint8Array;

Defined in: packages/cal3d/src/Animation.ts:127

Parameters

Parameter	Type
__namedParameters?	AnimationBinaryOptions

Returns

Uint8Array

---

toXml()

toXml(): string;

Defined in: packages/cal3d/src/Animation.ts:162

Returns

string

---

parse()

static parse(input, options?): Animation;

Defined in: packages/cal3d/src/Animation.ts:116

Parse a binary or XML animation file.

Parameters

Parameter	Type
input	Cal3DInput
options?	ParseOptions

Returns

Animation