Files
Zos/Skills/@be/node_modules/jibo-anim-db/lib/docs/Animation.js

36 lines
1.4 KiB
JavaScript

/**
* @class Animation
* @memberof jibo.animdb
* @description Instantiates Animation object.
*
* Important: Optional `animData` object will persist and mutate.
*
* @param {jibo.animdb.AnimCollection} parent - The animation collection this animation belongs to.
* @param {jibo.animdb#AnimMetadata} meta Animation meta data
* @param {string} resourceRoot Root directory for finding resources
* @param {jibo.animdb#Anim} [animData] Optional animation data, if provided will override actual animation
*/
/**
* Create animation object from query parameters
* @param {jibo.animdb#AnimConfig} [config={}] - Animation config options
* @method jibo.animdb.Animation#createFromConfig
* @returns {Promise<jibo.animdb.Playback>}
*/
/**
* Create and immediately play animation object from query parameters and playback options
* @param {jibo.animdb#AnimConfig} [config={}] - Animation config options.
* @param {jibo.animdb#PlaybackOptions} [options] - Playback options.
* @method jibo.animdb.Animation#play
* @returns {Promise<jibo.animdb.PlaybackResult>}
*/
/**
* Creates a transformation spec from a requirements object based on desired
* speeds and duration, scale etc.
* @param {jibo.animdb#AnimConfig} options
* @returns {jibo.animdb.Transform}
* @method jibo.animdb.Animation#_getTransformation
* @private
*/