extensions.mjs 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207
  1. /*!
  2. * @pixi/extensions - v6.5.10
  3. * Compiled Thu, 06 Jul 2023 15:25:11 UTC
  4. *
  5. * @pixi/extensions is licensed under the MIT License.
  6. * http://www.opensource.org/licenses/mit-license
  7. */
  8. /*! *****************************************************************************
  9. Copyright (c) Microsoft Corporation.
  10. Permission to use, copy, modify, and/or distribute this software for any
  11. purpose with or without fee is hereby granted.
  12. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
  13. REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  14. AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
  15. INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  16. LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
  17. OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  18. PERFORMANCE OF THIS SOFTWARE.
  19. ***************************************************************************** */
  20. var __assign = function() {
  21. __assign = Object.assign || function __assign(t) {
  22. var arguments$1 = arguments;
  23. for (var s, i = 1, n = arguments.length; i < n; i++) {
  24. s = arguments$1[i];
  25. for (var p in s) { if (Object.prototype.hasOwnProperty.call(s, p)) { t[p] = s[p]; } }
  26. }
  27. return t;
  28. };
  29. return __assign.apply(this, arguments);
  30. };
  31. /**
  32. * Collection of valid extension types.
  33. * @memberof PIXI
  34. * @property {string} Application - Application plugins
  35. * @property {string} RendererPlugin - Plugins for Renderer
  36. * @property {string} CanvasRendererPlugin - Plugins for CanvasRenderer
  37. * @property {string} Loader - Plugins to use with Loader
  38. * @property {string} LoadParser - Parsers for Assets loader.
  39. * @property {string} ResolveParser - Parsers for Assets resolvers.
  40. * @property {string} CacheParser - Parsers for Assets cache.
  41. */
  42. var ExtensionType;
  43. (function (ExtensionType) {
  44. ExtensionType["Application"] = "application";
  45. ExtensionType["RendererPlugin"] = "renderer-webgl-plugin";
  46. ExtensionType["CanvasRendererPlugin"] = "renderer-canvas-plugin";
  47. ExtensionType["Loader"] = "loader";
  48. ExtensionType["LoadParser"] = "load-parser";
  49. ExtensionType["ResolveParser"] = "resolve-parser";
  50. ExtensionType["CacheParser"] = "cache-parser";
  51. ExtensionType["DetectionParser"] = "detection-parser";
  52. })(ExtensionType || (ExtensionType = {}));
  53. /**
  54. * Convert input into extension format data.
  55. * @ignore
  56. */
  57. var normalizeExtension = function (ext) {
  58. // Class/Object submission, use extension object
  59. if (typeof ext === 'function' || (typeof ext === 'object' && ext.extension)) {
  60. if (!ext.extension) {
  61. throw new Error('Extension class must have an extension object');
  62. }
  63. var metadata = (typeof ext.extension !== 'object')
  64. ? { type: ext.extension }
  65. : ext.extension;
  66. ext = __assign(__assign({}, metadata), { ref: ext });
  67. }
  68. if (typeof ext === 'object') {
  69. ext = __assign({}, ext);
  70. }
  71. else {
  72. throw new Error('Invalid extension type');
  73. }
  74. if (typeof ext.type === 'string') {
  75. ext.type = [ext.type];
  76. }
  77. return ext;
  78. };
  79. /**
  80. * Global registration of all PixiJS extensions. One-stop-shop for extensibility.
  81. * @memberof PIXI
  82. * @namespace extensions
  83. */
  84. var extensions = {
  85. /** @ignore */
  86. _addHandlers: null,
  87. /** @ignore */
  88. _removeHandlers: null,
  89. /** @ignore */
  90. _queue: {},
  91. /**
  92. * Remove extensions from PixiJS.
  93. * @param extensions - Extensions to be removed.
  94. * @returns {PIXI.extensions} For chaining.
  95. */
  96. remove: function () {
  97. var arguments$1 = arguments;
  98. var _this = this;
  99. var extensions = [];
  100. for (var _i = 0; _i < arguments.length; _i++) {
  101. extensions[_i] = arguments$1[_i];
  102. }
  103. extensions.map(normalizeExtension).forEach(function (ext) {
  104. ext.type.forEach(function (type) { var _a, _b; return (_b = (_a = _this._removeHandlers)[type]) === null || _b === void 0 ? void 0 : _b.call(_a, ext); });
  105. });
  106. return this;
  107. },
  108. /**
  109. * Register new extensions with PixiJS.
  110. * @param extensions - The spread of extensions to add to PixiJS.
  111. * @returns {PIXI.extensions} For chaining.
  112. */
  113. add: function () {
  114. var arguments$1 = arguments;
  115. var _this = this;
  116. var extensions = [];
  117. for (var _i = 0; _i < arguments.length; _i++) {
  118. extensions[_i] = arguments$1[_i];
  119. }
  120. // Handle any extensions either passed as class w/ data or as data
  121. extensions.map(normalizeExtension).forEach(function (ext) {
  122. ext.type.forEach(function (type) {
  123. var handlers = _this._addHandlers;
  124. var queue = _this._queue;
  125. if (!handlers[type]) {
  126. queue[type] = queue[type] || [];
  127. queue[type].push(ext);
  128. }
  129. else {
  130. handlers[type](ext);
  131. }
  132. });
  133. });
  134. return this;
  135. },
  136. /**
  137. * Internal method to handle extensions by name.
  138. * @param type - The extension type.
  139. * @param onAdd - Function for handling when extensions are added/registered passes {@link PIXI.ExtensionFormat}.
  140. * @param onRemove - Function for handling when extensions are removed/unregistered passes {@link PIXI.ExtensionFormat}.
  141. * @returns {PIXI.extensions} For chaining.
  142. */
  143. handle: function (type, onAdd, onRemove) {
  144. var addHandlers = this._addHandlers = this._addHandlers || {};
  145. var removeHandlers = this._removeHandlers = this._removeHandlers || {};
  146. if (addHandlers[type] || removeHandlers[type]) {
  147. throw new Error("Extension type " + type + " already has a handler");
  148. }
  149. addHandlers[type] = onAdd;
  150. removeHandlers[type] = onRemove;
  151. // Process the queue
  152. var queue = this._queue;
  153. // Process any plugins that have been registered before the handler
  154. if (queue[type]) {
  155. queue[type].forEach(function (ext) { return onAdd(ext); });
  156. delete queue[type];
  157. }
  158. return this;
  159. },
  160. /**
  161. * Handle a type, but using a map by `name` property.
  162. * @param type - Type of extension to handle.
  163. * @param map - The object map of named extensions.
  164. * @returns {PIXI.extensions} For chaining.
  165. */
  166. handleByMap: function (type, map) {
  167. return this.handle(type, function (extension) {
  168. map[extension.name] = extension.ref;
  169. }, function (extension) {
  170. delete map[extension.name];
  171. });
  172. },
  173. /**
  174. * Handle a type, but using a list of extensions.
  175. * @param type - Type of extension to handle.
  176. * @param list - The list of extensions.
  177. * @returns {PIXI.extensions} For chaining.
  178. */
  179. handleByList: function (type, list) {
  180. return this.handle(type, function (extension) {
  181. var _a, _b;
  182. if (list.includes(extension.ref)) {
  183. return;
  184. }
  185. list.push(extension.ref);
  186. // TODO: remove me later, only added for @pixi/loaders
  187. if (type === ExtensionType.Loader) {
  188. (_b = (_a = extension.ref).add) === null || _b === void 0 ? void 0 : _b.call(_a);
  189. }
  190. }, function (extension) {
  191. var index = list.indexOf(extension.ref);
  192. if (index !== -1) {
  193. list.splice(index, 1);
  194. }
  195. });
  196. },
  197. };
  198. export { ExtensionType, extensions };
  199. //# sourceMappingURL=extensions.mjs.map