54 lines
1.6 KiB
JavaScript
54 lines
1.6 KiB
JavaScript
|
/**
|
||
|
|
* @class AnimDB
|
||
|
|
* @memberof jibo.animdb
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This jibo reference is hidden so it doesn't generate typings (creating a circular dependency).
|
||
|
|
* @private
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Adds animation database instance
|
||
|
|
* @method jibo.animdb.AnimDB#push
|
||
|
|
* @param {jibo.animdb.AnimCollection} animCollection Animation collection to add
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Pops the last anim database instance off the stack
|
||
|
|
* @method jibo.animdb.AnimDB#pop
|
||
|
|
* @return {jibo.animdb.AnimCollection}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get animation by name. Returns first animation by that iname in the case of multiple collections
|
||
|
|
* @method jibo.animdb.AnimDB#getAnimByName
|
||
|
|
* @param {string} animName Name of animation to retrieve
|
||
|
|
* @returns {jibo.animdb.Animation}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get animation names. Returns a list of all the animation names in the animDB.
|
||
|
|
* @method jibo.animdb.AnimDB#getAnimationNames
|
||
|
|
* @returns {string[]} List of animation names
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get animation categories. Returns a list of all the animation categories in the animDB.
|
||
|
|
* @method jibo.animdb.AnimDB#getAnimationCategories
|
||
|
|
* @returns {string[]} List of animation categories
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Search animations for meta tags
|
||
|
|
* @method jibo.animdb.AnimDB#search
|
||
|
|
* @param {string} searchTerm Search term could be meta tag, name, or category
|
||
|
|
* @returns {jibo.animdb.SearchResults}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Queries for animations that fit the criteria
|
||
|
|
* @method jibo.animdb.AnimDB#query
|
||
|
|
* @param {jibo.animdb#AnimQuery} query The query parameters
|
||
|
|
* @return {jibo.animdb.AnimResults}
|
||
|
|
*/
|