88 lines
3.7 KiB
JavaScript
88 lines
3.7 KiB
JavaScript
|
/**
|
||
|
|
* @typedef jibo.animdb.AnimDBParser#AnimMetadataMap
|
||
|
|
* @description Map of AnimDB names to their {@link jibo.animdb#AnimMetadata}.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef jibo.animdb.AnimDBParser#KeyValueAnimMetadataArray
|
||
|
|
* @description Array of Key/Value Pairs of AnimDB names to their {@link jibo.animdb#AnimMetadata}.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Creates an animDB from a list of root directories
|
||
|
|
* @method jibo.animdb.AnimDBParser#readAnimDB
|
||
|
|
* @param {object} jibo - The jibo runtime
|
||
|
|
* @param {string} animDBPath - Path to an animDB json
|
||
|
|
* @param {string[]} [moreAnimDBPaths] - Paths to more animDB json
|
||
|
|
* @returns {Promise<jibo.animdb.AnimDB>}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Creates an animDB instance from a particular root animation directory
|
||
|
|
* @method jibo.animdb.AnimDBParser#readAndAddAnimCollection
|
||
|
|
* @param {jibo.animdb.AnimDB} animDB - The animDB to add collection to
|
||
|
|
* @param {string} animDBPath - Path to an animDB json
|
||
|
|
* @returns {Promise<void>}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Adds an animation collection to a supplied animDB instance
|
||
|
|
* @method jibo.animdb.AnimDBParser#addAnimCollection
|
||
|
|
* @param {jibo.animdb.AnimDB} animDB - The animDB to add collection to
|
||
|
|
* @param {string} rootDir - Root directory for Animations in the collection
|
||
|
|
* @param {jibo.animdb.AnimDBParser#AnimMetadataMap} animMetaMap - Data comprising the collection to be added.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Adds a collection of AnimMetadata to a supplied animation collection
|
||
|
|
* @method jibo.animdb.AnimDBParser#addToAnimCollection
|
||
|
|
* @param {jibo.animdb.AnimDB} animDB - The animDB to add collection to
|
||
|
|
* @param {string} rootDir - Root directory for Animations in the collection
|
||
|
|
* @param {jibo.animdb.AnimDBParser#KeyValueAnimMetadataArray|jibo.animdb.AnimDBParser#AnimMetadataMap} animMetadataCollection - Data comprising the collection to be appended.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Finds all key files under a certain root dir (recursively), reads them and
|
||
|
|
* extracts meta data from them.
|
||
|
|
* Writes resulting metadata collection to a json object on disk
|
||
|
|
* @method jibo.animdb.AnimDBParser#createAndWriteAnimMetaData
|
||
|
|
* @param {Object} jibo - The jibo runtime
|
||
|
|
* @param {string} rootDir - Animations will be searched in rootDir/animations
|
||
|
|
* @param {string} outName - Name of output file (no extension)
|
||
|
|
* @returns {Promise<any>}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Finds all key files under a certain root dir (recursively), reads them and
|
||
|
|
* extracts meta data from them
|
||
|
|
* @method jibo.animdb.AnimDBParser#createAnimMetaData
|
||
|
|
* @param {Object} jibo - The jibo runtime
|
||
|
|
* @param {string} rootDir - Animations will be searched in rootDir/animations
|
||
|
|
* @returns {Promise<jibo.animdb.AnimDBParser#AnimMetadataMap>}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Loads animation data from disk and calculates derived properties
|
||
|
|
* @method jibo.animdb.AnimDBParser#parseAnimation
|
||
|
|
* @param {Object} jibo - The jibo runtime
|
||
|
|
* @param {string} filePath Path to animation
|
||
|
|
* @param {string} [rootDir] Root directory of animation
|
||
|
|
* @returns {Promise<jibo.animdb#AnimMetadata>}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Loads animation data from disk and expanding resolving/"macro-expanding" any Reference layers
|
||
|
|
* @method jibo.animdb.AnimDBParser#loadKeys
|
||
|
|
* @param {Object} jibo - The jibo runtime
|
||
|
|
* @param {string} keysPath Path to animation
|
||
|
|
* @param {string} [rootDir] Root directory of animation
|
||
|
|
* @returns {Promise<jibo.animdb#Anim>}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Calculates derived properties from Anim object
|
||
|
|
* @method jibo.animdb.AnimDBParser#parseAnimationFromAnim
|
||
|
|
* @param {jibo.animdb#Anim} animData Animation object
|
||
|
|
* @param {string} [filePath] Keys file JSON
|
||
|
|
* @returns {jibo.animdb#AnimMetadata}
|
||
|
|
*/
|