Files
cocos4/cocos2d/core/platform/CCAssetLibrary.js
T

367 lines
13 KiB
JavaScript

/****************************************************************************
Copyright (c) 2013-2016 Chukong Technologies Inc.
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.
Chukong Aipu 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.
****************************************************************************/
var Asset = require('../assets/CCAsset');
var callInNextTick = require('./utils').callInNextTick;
var Loader = require('../load-pipeline/CCLoader');
/**
* The asset library which managing loading/unloading assets in project.
*
* @class AssetLibrary
* @static
*/
// configs
var _libraryBase = '';
var _rawAssetsBase = ''; // The base dir for raw assets in runtime
var _uuidToRawAssets;
function isScene (asset) {
return asset && (asset.constructor === cc.SceneAsset || asset instanceof cc.Scene);
}
// publics
var AssetLibrary = {
/**
* @callback loadCallback
* @param {String} error - null or the error info
* @param {Asset} data - the loaded asset or null
*/
/**
* @method loadAsset
* @param {String} uuid
* @param {loadCallback} callback - the callback function once load finished
* @param {Object} options
* @param {Boolean} options.readMainCache - Default is true. If false, the asset and all its depends assets will reload and create new instances from library.
* @param {Boolean} options.writeMainCache - Default is true. If true, the result will cache to AssetLibrary, and MUST be unload by user manually.
* @param {Asset} options.existingAsset - load to existing asset, this argument is only available in editor
* @param {deserialize.Details} options.deserializeInfo - specified a DeserializeInfo object if you want,
* this parameter is only available in editor.
* @private
*/
loadAsset: function (uuid, callback, options) {
// var readMainCache = typeof (options && options.readMainCache) !== 'undefined' ? readMainCache : true;
// var writeMainCache = typeof (options && options.writeMainCache) !== 'undefined' ? writeMainCache : true;
var item = {
id: uuid,
type: 'uuid'
};
if (options && options.deserializeInfo) {
item.deserializeInfo = options.deserializeInfo;
}
if (options && options.existingAsset) {
item.existingAsset = options.existingAsset;
}
this._loadAssetByUuid(item, callback);
},
getImportedDir: function (uuid) {
return _libraryBase + uuid.slice(0, 2)/* + cc.path.sep + uuid*/;
},
_queryAssetInfoInEditor: function (uuid, callback) {
if (CC_EDITOR) {
Editor.sendRequestToCore( 'scene:query-asset-info-by-uuid', uuid, function (info) {
if (info) {
Editor.UuidCache.cache(info.url, uuid);
var ctor = Editor.assets[info.type];
if (ctor) {
var isRawAsset = !cc.isChildClassOf(ctor, Asset);
callback(null, info.url, isRawAsset, ctor);
}
else {
callback(new Error('Can not find asset type ' + info.type));
}
}
else {
callback(new Error('Can not get asset url by uuid ' + uuid));
}
});
}
},
_getAssetInfoInRuntime: function (uuid) {
var info = _uuidToRawAssets[uuid];
if (info && info.raw) {
return {
url: _rawAssetsBase + info.url,
raw: true,
};
}
else {
var url = this.getImportedDir(uuid) + '/' + uuid + '.json';
return {
url: url,
raw: false,
};
}
},
/**
* @method queryAssetInfo
* @param {String} uuid
* @param {Function} callback
* @param {Error} callback.error
* @param {String} callback.url - the url of raw asset or imported asset
* @param {Boolean} callback.raw - indicates whether the asset is raw asset
* @param {Function} callback.ctorInEditor - the actual type of asset, used in editor only
*/
queryAssetInfo: function (uuid, callback) {
if (CC_EDITOR && !CC_TEST) {
this._queryAssetInfoInEditor(uuid, callback);
}
else {
var info = this._getAssetInfoInRuntime(uuid);
callback(null, info.url, info.raw);
}
},
// parse uuid out of url
parseUuidInEditor: function (url) {
if (CC_EDITOR) {
var uuid = '';
var isImported = url.startsWith(_libraryBase);
if (isImported) {
var dir = cc.path.dirname(url);
var dirBasename = cc.path.basename(dir);
var isAssetUrl = dirBasename.length === 2;
if (isAssetUrl) {
uuid = cc.path.basename(url);
var index = uuid.indexOf('.');
if (index !== -1) {
uuid = uuid.slice(0, index);
}
}
else {
// raw file url
uuid = dirBasename;
}
}
// If url is not in the library, just return ""
return uuid;
}
},
/**
* !#zh uuid加载流程:
* 1. 查找_uuidToAsset,如果已经加载过,直接返回
* 2. 查找_uuidToCallbacks,如果已经在加载,则注册回调,直接返回
* 3. 如果没有url,则将uuid直接作为路径
* 4. 递归加载Asset及其引用到的其它Asset
*
* @method _loadAssetByUuid
* @param {Object} item - loading item including uuid, type and extra infos
* @param {loadCallback} callback - the callback to receive the asset, can be null
* @private
*/
_loadAssetByUuid: function (item, callback) {
var uuid = item.id;
var thisTick = true;
if (typeof uuid !== 'string') {
return callInNextTick(callback, new Error('[AssetLibrary] uuid must be string'), null);
}
Loader.load(item, function (error, asset) {
if (error || !asset) {
error = new Error('[AssetLibrary] loading JSON or dependencies failed : ' + JSON.stringify(error));
}
if (thisTick) {
callInNextTick(function () {
if (isScene(asset) || CC_EDITOR) {
Loader.removeItem(uuid);
}
callback(error, asset);
});
}
else {
if (isScene(asset) || CC_EDITOR) {
Loader.removeItem(uuid);
}
callback(error, asset);
}
});
thisTick = false;
},
/**
* @method loadJson
* @param {String} json
* @param {loadCallback} callback
* @return {LoadingHandle}
* @private
*/
loadJson: function (json, callback) {
var randomUuid = '' + ((new Date()).getTime() + Math.random());
var thisTick = true;
var item = {
id: randomUuid,
type: 'uuid',
content: json,
skips: [ Loader.downloader.id ]
};
Loader.load(item, function (error, asset) {
if (error) {
error = new Error('[AssetLibrary] loading JSON or dependencies failed : ' + JSON.stringify(error));
}
if (thisTick) {
callInNextTick(function () {
if (isScene(asset) || CC_EDITOR) {
Loader.removeItem(randomUuid);
}
asset._uuid = '';
callback(error, asset);
});
}
else {
if (isScene(asset) || CC_EDITOR) {
Loader.removeItem(randomUuid);
}
asset._uuid = '';
callback(error, asset);
}
});
thisTick = false;
},
/**
* Get the exists asset by uuid.
*
* @method getAssetByUuid
* @param {String} uuid
* @return {Asset} - the existing asset, if not loaded, just returns null.
* @private
*/
getAssetByUuid: function (uuid) {
return AssetLibrary._uuidToAsset[uuid] || null;
},
/**
* init the asset library
*
* @method init
* @param {Object} options
* @param {String} options.libraryPath - 能接收的任意类型的路径,通常在编辑器里使用绝对的,在网页里使用相对的。
* @param {Object} options.mountPaths - mount point of actual urls for raw assets (only used in editor)
* @param {Object} [options.rawAssets] - uuid to raw asset's urls (only used in runtime)
* @param {String} [options.rawAssetsBase] - base of raw asset's urls (only used in runtime)
*/
init: function (options) {
if (CC_EDITOR && _libraryBase) {
cc.error('AssetLibrary has already been initialized!');
return;
}
// 这里将路径转 url,不使用路径的原因是有的 runtime 不能解析 "\" 符号。
// 不使用 url.format 的原因是 windows 不支持 file:// 和 /// 开头的协议,所以只能用 replace 操作直接把路径转成 URL。
var libraryPath = options.libraryPath;
libraryPath = libraryPath.replace(/\\/g, '/');
_libraryBase = cc.path._setEndWithSep(libraryPath, '/');
_rawAssetsBase = options.rawAssetsBase;
_uuidToRawAssets = {};
var rawAssets = options.rawAssets;
if (rawAssets) {
var RES_DIR = 'resources/';
for (var mountPoint in rawAssets) {
var assets = rawAssets[mountPoint];
for (var uuid in assets) {
var info = assets[uuid];
var url = info.url;
var raw = info.raw;
_uuidToRawAssets[uuid] = {
url: mountPoint + '/' + url,
raw: !!raw,
};
// init resources
if (mountPoint === 'assets' && url.startsWith(RES_DIR)) {
if ( !raw ) {
var ext = cc.path.extname(url);
if (ext) {
// trim base dir and extname
url = url.slice(RES_DIR.length, - ext.length);
}
else {
// trim base dir
url = url.slice(RES_DIR.length);
}
}
else {
url = url.slice(RES_DIR.length);
}
// register
Loader._resources.add(url, uuid);
}
}
}
}
var mountPaths = options.mountPaths;
if (!mountPaths) {
mountPaths = {
assets: _rawAssetsBase + 'assets',
internal: _rawAssetsBase + 'internal',
};
}
cc.url._init(mountPaths);
}
};
// unload asset if it is destoryed
/**
* !#en Caches uuid to all loaded assets in scenes.
*
* !#zh 这里保存所有已经加载的场景资源,防止同一个资源在内存中加载出多份拷贝。
*
* 这里用不了WeakMap,在浏览器中所有加载过的资源都只能手工调用 unloadAsset 释放。
*
* 参考:
* https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap
* https://github.com/TooTallNate/node-weak
*
* @property {object} _uuidToAsset
* @private
*/
AssetLibrary._uuidToAsset = {};
//暂时屏蔽,因为目前没有缓存任何asset
//if (CC_DEV && Asset.prototype._onPreDestroy) {
// cc.error('_onPreDestroy of Asset has already defined');
//}
//Asset.prototype._onPreDestroy = function () {
// if (AssetLibrary._uuidToAsset[this._uuid] === this) {
// AssetLibrary.unloadAsset(this);
// }
//};
cc.AssetLibrary = AssetLibrary;