165 lines
5.1 KiB
JavaScript
165 lines
5.1 KiB
JavaScript
/**
|
|
* @typedef jibo.animdb#Orientation
|
|
* @description Enum of orientation options.
|
|
* @property LEFT {string} Animation left oriented.
|
|
* @property RIGHT {string} Animation right oriented.
|
|
*/
|
|
|
|
/**
|
|
* @interface jibo.animdb#AnimConfig
|
|
* @extends CloneOptions
|
|
* @description Interface of configurations.
|
|
* @property [duration] {number} Desired duration of animation in frames.
|
|
* @property [exaggerate] {number} Desired scale multiplier for body DoFs.
|
|
* @property [orientation] {jibo.animdb#Orientation} Desired orientation of the animation (left or right sided).
|
|
* @property cache {string} Jibo loader cache name.
|
|
*/
|
|
|
|
/**
|
|
* @interface jibo.animdb#AnimMetadata
|
|
* @description Interface for the animation metadata.
|
|
* @property name {string} Name of the animation.
|
|
* @property path {string} Path to the animation.
|
|
* @property scale {number[]} Description needed.
|
|
* @property speed {number[]} Description needed.
|
|
* @property durationRange {number[]} Description needed.
|
|
* @property duration {number} Duration of the animation in milliseconds.
|
|
* @property startsNeutral {boolean} `true` if the animation starts in a neutral pose.
|
|
* @property endsNeutral {boolean} `true` if the animation ends in a neutral pose.
|
|
* @property hasAudio {boolean} `true` if animation includes audio
|
|
* @property holdSafeKF {number} Description needed.
|
|
* @property orientation {string} Orientation of the animation.
|
|
* @property categories {string[]} Description needed.
|
|
* @property layers {jibo.animdb#LayerPresence} Layers included in the animation.
|
|
* @property metaTerms {string[]} Array of meta terms for the animation.
|
|
*/
|
|
|
|
/**
|
|
* @typedef jibo.animdb#HasAudio
|
|
* @description Enum of audio options
|
|
* @property YES {string} Animation has audio.
|
|
* @property NO {string} Animation does not have audio.
|
|
* @property DONT_CARE {string} Animation may or may not have audio.
|
|
*/
|
|
|
|
/**
|
|
* @interface jibo.animdb#AnimQuery
|
|
* @description Interface of query informaton.
|
|
* @property [category] {string} Desired category name
|
|
* @property [categories] {string[]} Multiple category names to pick from
|
|
* @property [includeCat] {string[]} List of categories that the animation must contain
|
|
* @property [includeSomeCat] {string[]} List of categories that the animation must contain at least one of
|
|
* @property [excludeCat] {string[]} List of categories that the animation must not contain
|
|
* @property [duration] {number} Desired animation duration in frames
|
|
* @property [durationError] {number} Allowed duration error in frames
|
|
* @property [hasAudio] {jibo.animdb#HasAudio} Whether animation can contain audio
|
|
* @property [includeMeta] {string[]} List of meta tags that the animation must contain
|
|
* @property [includeSomeMeta] {string[]} List of meta tags that the animation must contain at least one of
|
|
* @property [excludeMeta] {string[]} List of meta tags that the animation must not contain
|
|
*/
|
|
|
|
/**
|
|
* @class AnimResults
|
|
* @memberof jibo.animdb
|
|
*/
|
|
|
|
/**
|
|
* Animations that match the query
|
|
* @name jibo.animdb.AnimResults#matching
|
|
* @type {jibo.animdb.Animation[]}
|
|
*/
|
|
|
|
/**
|
|
* Animations that match the query but not the duration boundaries
|
|
* @name jibo.animdb.AnimResults#nonMatching
|
|
* @type {jibo.animdb.Animation[]}
|
|
*/
|
|
|
|
/**
|
|
* @class SearchResults
|
|
* @memberof jibo.animdb
|
|
*/
|
|
|
|
/**
|
|
* Category that matches search string
|
|
* @name jibo.animdb.SearchResults#category
|
|
* @type {jibo.animdb.Category}
|
|
*/
|
|
|
|
/**
|
|
* Animation whose name matches search string
|
|
* @name jibo.animdb.SearchResults#name
|
|
* @type {jibo.animdb.Category}
|
|
*/
|
|
|
|
/**
|
|
* Animations that match search string on meta tags
|
|
* @name jibo.animdb.SearchResults#meta
|
|
* @type {jibo.animdb.Category}
|
|
*/
|
|
|
|
/**
|
|
* @interface jibo.animdb#LayerPresence
|
|
* @description Interface for layers present in the animation.
|
|
* For more information on animation layers, see [Animation Editor](https://developers.jibo.com/docs/animation-editor.html#layers).
|
|
* @property [Body] {boolean}
|
|
* @property [Eye] {boolean}
|
|
* @property [EyeTexture] {boolean}
|
|
* @property [Overlay] {boolean}
|
|
* @property [OverlayTexture] {boolean}
|
|
* @property [AudioEvent] {boolean}
|
|
* @property [Event] {boolean}
|
|
* @property [Pixi] {boolean}
|
|
* @property [BackgroundTexture] {boolean}
|
|
* @property [LED] {boolean}
|
|
*/
|
|
|
|
/**
|
|
* @name jibo.animdb.LayerPresence#Body
|
|
* @type {boolean}
|
|
*/
|
|
|
|
/**
|
|
* @name jibo.animdb.LayerPresence#Eye
|
|
* @type {boolean}
|
|
*/
|
|
|
|
/**
|
|
* @name jibo.animdb.LayerPresence#EyeTexture
|
|
* @type {boolean}
|
|
*/
|
|
|
|
/**
|
|
* @name jibo.animdb.LayerPresence#Overlay
|
|
* @type {boolean}
|
|
*/
|
|
|
|
/**
|
|
* @name jibo.animdb.LayerPresence#OverlayTexture
|
|
* @type {boolean}
|
|
*/
|
|
|
|
/**
|
|
* @name jibo.animdb.LayerPresence#AudioEvent
|
|
* @type {boolean}
|
|
*/
|
|
|
|
/**
|
|
* @name jibo.animdb.LayerPresence#Event
|
|
* @type {boolean}
|
|
*/
|
|
|
|
/**
|
|
* @name jibo.animdb.LayerPresence#Pixi
|
|
* @type {boolean}
|
|
*/
|
|
|
|
/**
|
|
* @name jibo.animdb.LayerPresence#BackgroundTexture
|
|
* @type {boolean}
|
|
*/
|
|
|
|
/**
|
|
* @name jibo.animdb.LayerPresence#LED
|
|
* @type {boolean}
|
|
*/ |