API Docs for:
Show:

LS.Animation.Track Class

Defined in: ../src/resources/animation.js:700
Module: LS

Represents one track with data over time about one property Data could be stored in two forms, or an array containing arrays of [time,data] (unpacked data) or in a single typed array (packed data), depends on the attribute typed_mode

Constructor

LS.Animation.Track

()

Defined in ../src/resources/animation.js:700

Methods

addKeyframe

(
  • time
  • value
  • skip_replace
)
Number

Defined in ../src/resources/animation.js:884

Adds a new keyframe to this track

Parameters:

  • time Number

    time stamp in seconds

  • value

    anything you want to store

  • skip_replace Boolean

    if you want to replace existing keyframes at same time stamp or add it next to that

Returns:

Number:

index of keyframe

findTimeIndex

(
  • time
)
Number

Defined in ../src/resources/animation.js:1127

returns nearest index of keyframe with time equal or less to specified time (Dichotimic search)

Parameters:

  • time Number

Returns:

Number:

index

getIDasName

(
  • use_basename
  • root
)
String

Defined in ../src/resources/animation.js:835

used to change every track so instead of using UIDs for properties it uses node names this is used when you want to apply the same animation to different nodes in the scene

Parameters:

  • use_basename Boolean

    if you want to just use the node name, othewise it uses the fullname (name with path)

  • root LS.SceneNode

Returns:

String:

the result name

getKeyframe

(
  • index
)
Array

Defined in ../src/resources/animation.js:918

returns a keyframe given an index

Parameters:

  • index Number

Returns:

Array:

the keyframe in [time,data] format

getKeyframeByTime

(
  • time
)
Array

Defined in ../src/resources/animation.js:944

returns the first keyframe that matches this time

Parameters:

  • time Number

Returns:

Array:

keyframe in [time,value]

moveKeyframe

(
  • index
  • new_time
)
Number

Defined in ../src/resources/animation.js:958

changes a keyframe time and rearranges it

Parameters:

  • index Number
  • new_time Number

Returns:

Number:

new index

packData

()

Defined in ../src/resources/animation.js:1072

takes all the keyframes and stores them inside a typed-array so they are faster to store in server or work with

removeKeyframe

(
  • index
)

Defined in ../src/resources/animation.js:1015

removes one keyframe

Parameters:

  • index Number

trim

(
  • start
  • end
)

Defined in ../src/resources/animation.js:1539

removes keyframes that are before or after the time range

Parameters:

  • start Number

    time

  • end Number

    time

unpackData

()

Defined in ../src/resources/animation.js:1104

takes all the keyframes and unpacks them so they are in a simple array, easier to work with