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

39 lines
1.0 KiB
JavaScript

/**
* A number to represent infinite duration
* @const INFINITE_DURATION
* @memberof jibo.animdb
* @private
*/
/**
* Constructs a Range object
* @param {number} min - Minimum value of range
* @param {number} max - Maximum value of range
*/
/**
* @method jibo.animdb.Range#toString
* @returns {string}
*/
/**
* Takes a number and limits it by this range.
* If `min` then return min bound, if higher then return max bound
* @method jibo.animdb.Range#limit
* @param {number} num - Number to limit to range
* @returns {number}
*/
/**
* Does the upper bound of this range represent infinity
* @method jibo.animdb.Range#isUpperInfinite
* @returns {boolean}
*/
/**
* Reports how far a number is from being within this range.
* Returns 0 if it is contained in range.
* @method jibo.animdb.Range#distanceFrom
* @param {number} num - Number to calculate distance from
* @returns {number}
*/