extensions.js 7.6 KB

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