Files
cocos4/cocos/core/utils/array.ts
T
Leslie Leigh 5936b42393 animation (#4153)
* animation

* animation

* update
2019-04-04 19:09:09 +08:00

177 lines
5.3 KiB
TypeScript

/****************************************************************************
Copyright (c) 2018 Xiamen Yaji Software Co., Ltd.
http://www.cocos.com
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated engine source code (the "Software"), a limited,
worldwide, royalty-free, non-assignable, revocable and non-exclusive license
to use Cocos Creator solely to develop games on your target platforms. You shall
not use Cocos Creator software for developing other software or tools that's
used for developing games. You are not granted to publish, distribute,
sublicense, and/or sell copies of Cocos Creator.
The software or tools in this License Agreement are licensed, not sold.
Xiamen Yaji Software Co., Ltd. reserves all rights not expressly granted to you.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/
export {default as MutableForwardIterator} from './mutable-forward-iterator';
/**
* @class js.array
* @static
*/
/**
* Removes the array item at the specified index.
* @method removeAt
* @param {any[]} array
* @param {Number} index
*/
export function removeAt (array, index) {
array.splice(index, 1);
}
/**
* Removes the array item at the specified index.
* It's faster but the order of the array will be changed.
* @method fastRemoveAt
* @param {any[]} array
* @param {Number} index
*/
export function fastRemoveAt (array, index) {
const length = array.length;
if (index < 0 || index >= length) {
return;
}
array[index] = array[length - 1];
array.length = length - 1;
}
/**
* Removes the first occurrence of a specific object from the array.
* @method remove
* @param {any[]} array
* @param {any} value
* @return {Boolean}
*/
export function remove (array, value) {
const index = array.indexOf(value);
if (index >= 0) {
removeAt(array, index);
return true;
}
else {
return false;
}
}
/**
* Removes the first occurrence of a specific object from the array.
* It's faster but the order of the array will be changed.
* @method fastRemove
* @param {any[]} array
* @param {Number} value
*/
export function fastRemove (array, value) {
const index = array.indexOf(value);
if (index >= 0) {
array[index] = array[array.length - 1];
--array.length;
}
}
/**
* Verify array's Type
* @method verifyType
* @param {array} array
* @param {Function} type
* @return {Boolean}
*/
export function verifyType (array, type) {
if (array && array.length > 0) {
for (const item of array) {
if (!(item instanceof type)) {
cc.logID(1300);
return false;
}
}
}
return true;
}
/**
* Removes from array all values in minusArr. For each Value in minusArr, the first matching instance in array will be removed.
* @method removeArray
* @param {Array} array Source Array
* @param {Array} minusArr minus Array
*/
export function removeArray (array, minusArr) {
for (let i = 0, l = minusArr.length; i < l; i++) {
remove(array, minusArr[i]);
}
}
/**
* Inserts some objects at index
* @method appendObjectsAt
* @param {Array} array
* @param {Array} addObjs
* @param {Number} index
* @return {Array}
*/
export function appendObjectsAt (array, addObjs, index) {
array.splice.apply(array, [index, 0].concat(addObjs));
return array;
}
/**
* Exact same function as Array.prototype.indexOf.<br>
* HACK: ugliy hack for Baidu mobile browser compatibility,
* stupid Baidu guys modify Array.prototype.indexOf for all pages loaded,
* their version changes strict comparison to non-strict comparison,
* it also ignores the second parameter of the original API, and this will cause event handler enter infinite loop.<br>
* Baidu developers, if you ever see this documentation,
* here is the standard: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf, Seriously!
*
* @method indexOf
* @param {any} searchElement - Element to locate in the array.
* @param {Number} [fromIndex=0] - The index to start the search at
* @return {Number} - the first index at which a given element can be found in the array, or -1 if it is not present.
*/
// Array.prototype.indexOf;
/**
* Determines whether the array contains a specific value.
* @method contains
* @param {any[]} array
* @param {any} value
* @return {Boolean}
*/
export function contains (array, value) {
return array.indexOf(value) >= 0;
}
/**
* Copy an array's item to a new array (its performance is better than Array.slice)
* @method copy
* @param {Array} array
* @return {Array}
*/
export function copy (array) {
const len = array.length;
const arr_clone = new Array(len);
for (let i = 0; i < len; i += 1) {
arr_clone[i] = array[i];
}
return arr_clone;
}