Class AnimationControls

Animation controls

Hierarchy

AnimationControls

Index

Constructors

constructor

Properties

Accessors

paused

Methods

Constructors

constructor

new AnimationControls(stage: Stage): AnimationControls

- Defined in src/controls/animation-controls.ts:28
Create animation controls

Parameters
- stage: Stage
  
  the stage object
Returns AnimationControls

Properties

animationList

animationList: Animation[] = []

controls

controls: ViewerControls

finishedList

finishedList: Animation[] = []

stage

stage: Stage

the stage object

viewer

viewer: Viewer

Accessors

paused

get paused(): boolean

- Defined in src/controls/animation-controls.ts:43
True when all animations are paused

Returns boolean

Methods

add

add(animation: Animation): Animation

- Defined in src/controls/animation-controls.ts:50
Add an animation

Parameters
- animation: Animation
Returns Animation

clear

clear(): void

- Defined in src/controls/animation-controls.ts:305
Clear all animations

Returns void

dispose

dispose(): void

- Defined in src/controls/animation-controls.ts:309
Returns void

move

move(moveTo: Vector3 | number[], duration?: undefined | number): Animation

- Defined in src/controls/animation-controls.ts:144
Add a move animation

Parameters
- moveTo: Vector3 | number[]
  
  target position
- Optional duration: undefined | number
  
  animation time in milliseconds
Returns Animation

the animation

moveComponent

moveComponent(component: Component, moveTo: Vector3 | number[], duration?: undefined | number): Animation

- Defined in src/controls/animation-controls.ts:264
Add a component move animation

Parameters
- component: Component
  
  object to move
- moveTo: Vector3 | number[]
  
  target position
- Optional duration: undefined | number
  
  animation time in milliseconds
Returns Animation

the animation

orient

orient(orientTo: Matrix4 | number[], duration?: undefined | number): AnimationList

- Defined in src/controls/animation-controls.ts:186
Add an orient animation

Parameters
- orientTo: Matrix4 | number[]
  
  target orientation
- Optional duration: undefined | number
  
  animation time in milliseconds
Returns AnimationList

the animations

pause

pause(): void

- Defined in src/controls/animation-controls.ts:277
Pause all animations

Returns void

remove

remove(animation: Animation): void

- Defined in src/controls/animation-controls.ts:63
Remove an animation

Parameters
- animation: Animation
Returns void

resume

resume(): void

- Defined in src/controls/animation-controls.ts:285
Resume all animations

Returns void

rock

rock(axis: Vector3 | number[], angle?: undefined | number, end?: undefined | number, duration?: undefined | number): Animation

- Defined in src/controls/animation-controls.ts:118
Add a rock animation

Parameters
- axis: Vector3 | number[]
  
  axis to rock around
- Optional angle: undefined | number
  
  amount to spin per frame, radians
- Optional end: undefined | number
  
  maximum extend of motion, radians
- Optional duration: undefined | number
  
  animation time in milliseconds
Returns Animation

the animation

rockComponent

rockComponent(component: Component, axis: Vector3 | number[], angle?: undefined | number, end?: undefined | number, duration?: undefined | number): Animation

- Defined in src/controls/animation-controls.ts:250
Add a component rock animation

Parameters
- component: Component
  
  object to move
- axis: Vector3 | number[]
  
  axis to rock around
- Optional angle: undefined | number
  
  amount to spin per frame, radians
- Optional end: undefined | number
  
  maximum extend of motion, radians
- Optional duration: undefined | number
  
  animation time in milliseconds
Returns Animation

the animation

rotate

rotate(rotateTo: Quaternion | number[], duration?: undefined | number): Animation

- Defined in src/controls/animation-controls.ts:130
Add a rotate animation

Parameters
- rotateTo: Quaternion | number[]
  
  target rotation
- Optional duration: undefined | number
  
  animation time in milliseconds
Returns Animation

the animation

run

run(stats: Stats): void

- Defined in src/controls/animation-controls.ts:75
Run all animations

Parameters
- stats: Stats
Returns void

spin

spin(axis: Vector3 | number[], angle?: undefined | number, duration?: undefined | number): Animation

- Defined in src/controls/animation-controls.ts:104
Add a spin animation

Parameters
- axis: Vector3 | number[]
  
  axis to spin around
- Optional angle: undefined | number
  
  amount to spin per frame, radians
- Optional duration: undefined | number
  
  animation time in milliseconds
Returns Animation

the animation

spinComponent

spinComponent(component: Component, axis?: Vector3 | number[], angle?: undefined | number, duration?: undefined | number): Animation

- Defined in src/controls/animation-controls.ts:234
Add a component spin animation

Parameters
- component: Component
  
  object to move
- Optional axis: Vector3 | number[]
  
  axis to spin around
- Optional angle: undefined | number
  
  amount to spin per frame, radians
- Optional duration: undefined | number
  
  animation time in milliseconds
Returns Animation

the animation

timeout

timeout(callback: Function, duration?: undefined | number): Animation

- Defined in src/controls/animation-controls.ts:220
Add a timeout animation

Parameters
- callback: Function
  
  called after duration
- Optional duration: undefined | number
  
  timeout in milliseconds
Returns Animation

the animation

toggle

toggle(): void

- Defined in src/controls/animation-controls.ts:293
Toggle all animations

Returns void

value

value(valueFrom: number, valueTo: number, callback: Function, duration?: undefined | number): Animation

- Defined in src/controls/animation-controls.ts:208
Add a value animation

Parameters
- valueFrom: number
  
  start value
- valueTo: number
  
  target value
- callback: Function
  
  called on every tick
- Optional duration: undefined | number
  
  animation time in milliseconds
Returns Animation

the animation

zoom

zoom(zoomTo: number, duration?: undefined | number): Animation

- Defined in src/controls/animation-controls.ts:158
Add a zoom animation

Parameters
- zoomTo: number
  
  target distance
- Optional duration: undefined | number
  
  animation time in milliseconds
Returns Animation

the animation

zoomMove

zoomMove(moveTo: Vector3, zoomTo: number, duration?: undefined | number): AnimationList

- Defined in src/controls/animation-controls.ts:173
Add a zoom and a move animation

Parameters
- moveTo: Vector3
  
  target position
- zoomTo: number
  
  target distance
- Optional duration: undefined | number
  
  animation time in milliseconds
Returns AnimationList

the animations

Generated using TypeDoc