AnimationPlugin
A special viewer plugin responsible for animation and skeleton updating.
A special viewer plugin responsible for animation and skeleton updating.
Implements
ViewerPlugin
Constructors
Constructor
new AnimationPlugin():
AnimationPlugin
Returns
AnimationPlugin
Properties
clock
readonlyclock:Clock
Methods
init()
init():
void
called when register to viewer
Returns
void
Implementation of
ViewerPlugin.init
destroy()
destroy():
void
called when unregister from viewer or destroying viewer.
Returns
void
Implementation of
ViewerPlugin.destroy
beforeRendering()
beforeRendering():
void
called on every rendering request started.
Returns
void
Implementation of
ViewerPlugin.beforeRendering
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
Implementation of
ViewerPlugin.afterRendering
registerToViewer()
registerToViewer(
viewer):void
Register this animation plugin to the viewer.
Parameters
viewer
Viewer | IViewerContext
Viewer or IViewerContext
Returns
void
add()
add(
mixer):void
Register AnimationMixer into the plugin, then the animation will be updated along with rendering
Parameters
mixer
Returns
void
remove()
remove(
mixer):void
Unregister AnimationMixer
Parameters
mixer
Returns
void
bindSkinned()
bindSkinned(
mesh,skeleton,mixer):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 to be bound
mixer
AnimationMixer to be bound to listen for events
Returns
void
unbindSkinned()
unbindSkinned(
mesh):void
Unbind SkinnedMesh
Parameters
mesh
SkinnedMesh
Returns
void