AnimationPlugin

constructor

• new AnimationPlugin(): AnimationPlugin

  Returns AnimationPlugin

Readonlyclock

init

• init(): void

  called when register to viewer

  Returns void

destroy

• destroy(): void

  called when unregister from viewer or destroying viewer.

  Returns void

beforeRendering

• beforeRendering(): void

  called on every rendering request started.

  Returns void

afterRendering

• afterRendering(): void

  called on every rendering request finish, but the rendering request maybe not actually executed. use renderedFrameId to check whether rendering request has executed.

  Returns void

registerToViewer

• registerToViewer(viewer: Viewer | IViewerContext): void

  Register this animation plugin to the viewer.

  Parameters

  • viewer: Viewer | IViewerContext

    Viewer or IViewerContext

  Returns void

add

• add(mixer: AnimationMixer): void

  Register AnimationMixer into the plugin, then the animation will be updated along with rendering

  Parameters

  • mixer: AnimationMixer

  Returns void

remove

• remove(mixer: AnimationMixer): void

  Unregister AnimationMixer

  Parameters

  • mixer: AnimationMixer

  Returns void

bindSkinned

• bindSkinned(mesh: SkinnedMesh, skeleton: Skeleton, mixer: AnimationMixer): void

  Bind SkinnedMesh with skeleton and register in animation plugin, then the skeletal animation will be update along with skeleton change. After binding, the SkinnedMesh can be considered as ISkinnedMesh

  Parameters

  • mesh: SkinnedMesh
  • skeleton: Skeleton

    Skeleton to be bound

  • mixer: AnimationMixer

    AnimationMixer to be bound to listen for events

  Returns void

unbindSkinned

• unbindSkinned(mesh: SkinnedMesh): void

  Unbind SkinnedMesh

  Parameters

  • mesh: SkinnedMesh

  Returns void