Inicio Explorar Ayuda
Registro Iniciar sesión
samien
/
three.js
espejo de https://github.com/mrdoob/three.js.git
1
0
Fork 0
Archivos Incidencias 0 Wiki
Árbol: 4345fbc1f2
Ramas Etiquetas
three.js
/
docs
/
pages
/
Loader.html

Loader.html 13 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4. 	<meta charset="utf-8">
    5. 

  5. 	<title>Loader - Three.js Docs</title>
    6. 

  6. 	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
    7. 

  7. 	<script src="../scripts/highlight.min.js"></script>
    8. 

  8. 	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
    9. 

  9. 	<link type="text/css" rel="stylesheet" href="../styles/page.css">
    10. 

  10. </head>
    11. 

  11. <body>
    12. 

  12. 	<h1 translate="no">Loader</h1>
    13. 

  13. 		<section>
    14. 

  14. 			<header>
    15. 

  15. 				<div class="class-description"><p>Abstract base class for loaders.</p></div>
    16. 

  16. 			</header>
    17. 

  17. 			<article>
    18. 

  18. 				<div class="container-overview">
    19. 

  19. 					<h2>Constructor</h2>
    20. 

  20. 					<h3 class="name name-method" id="Loader" translate="no">new <a href="#Loader">Loader</a><span class="signature">( manager : <span class="param-type"><a href="LoadingManager.html">LoadingManager</a></span> )</span> <span class="type-signature">(abstract) </span></h3>
    21. 

  21. 					<div class="method">
    22. 

  22. 						<div class="description">
    23. 

  23. 							<p>Constructs a new loader.</p>
    24. 

  24. 						</div>
    25. 

  25. 						<table class="params">
    26. 

  26. 							<tbody>
    27. 

  27. 								<tr>
    28. 

  28. 									<td class="name">
    29. 

  29. 										<strong>manager</strong>
    30. 

  30. 									</td>
    31. 

  31. 									<td class="description last">
    32. 

  32. 										<p>The loading manager.</p>
    33. 

  33. 									</td>
    34. 

  34. 								</tr>
    35. 

  35. 							</tbody>
    36. 

  36. 						</table>
    37. 

  37. 					</div>
    38. 

  38. 				</div>
    39. 

  39. 				<h2 class="subsection-title">Properties</h2>
    40. 

  40. 				<div class="member">
    41. 

  41. 					<h3 class="name" id="crossOrigin" translate="no">.<a href="#crossOrigin">crossOrigin</a><span class="type-signature"> : string</span> </h3>
    42. 

  42. 					<div class="description">
    43. 

  43. 						<p>The crossOrigin string to implement CORS for loading the url from a
    44. 

  44. different domain that allows CORS.</p>
    45. 

  45. 						<p>Default is <code>'anonymous'</code>.</p>
    46. 

  46. 					</div>
    47. 

  47. 				</div>
    48. 

  48. 				<div class="member">
    49. 

  49. 					<h3 class="name" id="manager" translate="no">.<a href="#manager">manager</a><span class="type-signature"> : <a href="LoadingManager.html">LoadingManager</a></span> </h3>
    50. 

  50. 					<div class="description">
    51. 

  51. 						<p>The loading manager.</p>
    52. 

  52. 						<p>Default is <code>DefaultLoadingManager</code>.</p>
    53. 

  53. 					</div>
    54. 

  54. 				</div>
    55. 

  55. 				<div class="member">
    56. 

  56. 					<h3 class="name" id="path" translate="no">.<a href="#path">path</a><span class="type-signature"> : string</span> </h3>
    57. 

  57. 					<div class="description">
    58. 

  58. 						<p>The base path from which the asset will be loaded.</p>
    59. 

  59. 					</div>
    60. 

  60. 				</div>
    61. 

  61. 				<div class="member">
    62. 

  62. 					<h3 class="name" id="requestHeader" translate="no">.<a href="#requestHeader">requestHeader</a><span class="type-signature"> : Object.&lt;string, <a href="global.html#any">any</a>></span> </h3>
    63. 

  63. 					<div class="description">
    64. 

  64. 						<p>The <a href="https://developer.mozilla.org/en-US/docs/Glossary/Request_header" target="_blank" rel="noopener">request header</a>
    65. 

  65. used in HTTP request.</p>
    66. 

  66. 					</div>
    67. 

  67. 				</div>
    68. 

  68. 				<div class="member">
    69. 

  69. 					<h3 class="name" id="resourcePath" translate="no">.<a href="#resourcePath">resourcePath</a><span class="type-signature"> : string</span> </h3>
    70. 

  70. 					<div class="description">
    71. 

  71. 						<p>The base path from which additional resources like textures will be loaded.</p>
    72. 

  72. 					</div>
    73. 

  73. 				</div>
    74. 

  74. 				<div class="member">
    75. 

  75. 					<h3 class="name" id="withCredentials" translate="no">.<a href="#withCredentials">withCredentials</a><span class="type-signature"> : boolean</span> </h3>
    76. 

  76. 					<div class="description">
    77. 

  77. 						<p>Whether the XMLHttpRequest uses credentials.</p>
    78. 

  78. 						<p>Default is <code>false</code>.</p>
    79. 

  79. 					</div>
    80. 

  80. 				</div>
    81. 

  81. 				<div class="member">
    82. 

  82. 					<h3 class="name" id=".DEFAULT_MATERIAL_NAME" translate="no">.<a href="#.DEFAULT_MATERIAL_NAME">DEFAULT_MATERIAL_NAME</a><span class="type-signature"> : string</span> </h3>
    83. 

  83. 					<div class="description">
    84. 

  84. 						<p>The default material name that is used by loaders
    85. 

  85. when creating materials for loaded 3D objects.</p>
    86. 

  86. <p>Note: Not all loaders might honor this setting.</p>
    87. 

  87. 						<p>Default is <code>'__DEFAULT'</code>.</p>
    88. 

  88. 					</div>
    89. 

  89. 				</div>
    90. 

  90. 				<h2 class="subsection-title">Methods</h2>
    91. 

  91. 					<h3 class="name name-method" id="abort" translate="no">.<a href="#abort">abort</a><span class="signature">()</span><span class="type-signature"> : <a href="Loader.html">Loader</a></span> <span class="type-signature">(abstract) </span></h3>
    92. 

  92. 					<div class="method">
    93. 

  93. 						<div class="description">
    94. 

  94. 							<p>This method can be implemented in loaders for aborting ongoing requests.</p>
    95. 

  95. 						</div>
    96. 

  96. 						<dl class="details">
    97. 

  97. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    98. 

  98. 						</dl>
    99. 

  99. 					</div>
    100. 

  100. 					<h3 class="name name-method" id="load" translate="no">.<a href="#load">load</a><span class="signature">( url : <span class="param-type">string</span>, onLoad : <span class="param-type">function</span>, onProgress : <span class="param-type"><a href="global.html#onProgressCallback">onProgressCallback</a></span>, onError : <span class="param-type"><a href="global.html#onErrorCallback">onErrorCallback</a></span> )</span> <span class="type-signature">(abstract) </span></h3>
    101. 

  101. 					<div class="method">
    102. 

  102. 						<div class="description">
    103. 

  103. 							<p>This method needs to be implemented by all concrete loaders. It holds the
    104. 

  104. logic for loading assets from the backend.</p>
    105. 

  105. 						</div>
    106. 

  106. 						<table class="params">
    107. 

  107. 							<tbody>
    108. 

  108. 								<tr>
    109. 

  109. 									<td class="name">
    110. 

  110. 										<strong>url</strong>
    111. 

  111. 									</td>
    112. 

  112. 									<td class="description last">
    113. 

  113. 										<p>The path/URL of the file to be loaded.</p>
    114. 

  114. 									</td>
    115. 

  115. 								</tr>
    116. 

  116. 								<tr>
    117. 

  117. 									<td class="name">
    118. 

  118. 										<strong>onLoad</strong>
    119. 

  119. 									</td>
    120. 

  120. 									<td class="description last">
    121. 

  121. 										<p>Executed when the loading process has been finished.</p>
    122. 

  122. 									</td>
    123. 

  123. 								</tr>
    124. 

  124. 								<tr>
    125. 

  125. 									<td class="name">
    126. 

  126. 										<strong>onProgress</strong>
    127. 

  127. 									</td>
    128. 

  128. 									<td class="description last">
    129. 

  129. 										<p>Executed while the loading is in progress.</p>
    130. 

  130. 									</td>
    131. 

  131. 								</tr>
    132. 

  132. 								<tr>
    133. 

  133. 									<td class="name">
    134. 

  134. 										<strong>onError</strong>
    135. 

  135. 									</td>
    136. 

  136. 									<td class="description last">
    137. 

  137. 										<p>Executed when errors occur.</p>
    138. 

  138. 									</td>
    139. 

  139. 								</tr>
    140. 

  140. 							</tbody>
    141. 

  141. 						</table>
    142. 

  142. 					</div>
    143. 

  143. 					<h3 class="name name-method" id="loadAsync" translate="no">.<a href="#loadAsync">loadAsync</a><span class="signature">( url : <span class="param-type">string</span>, onProgress : <span class="param-type"><a href="global.html#onProgressCallback">onProgressCallback</a></span> )</span><span class="type-signature"> : Promise</span> </h3>
    144. 

  144. 					<div class="method">
    145. 

  145. 						<div class="description">
    146. 

  146. 							<p>A async version of <a href="Loader.html#load">Loader#load</a>.</p>
    147. 

  147. 						</div>
    148. 

  148. 						<table class="params">
    149. 

  149. 							<tbody>
    150. 

  150. 								<tr>
    151. 

  151. 									<td class="name">
    152. 

  152. 										<strong>url</strong>
    153. 

  153. 									</td>
    154. 

  154. 									<td class="description last">
    155. 

  155. 										<p>The path/URL of the file to be loaded.</p>
    156. 

  156. 									</td>
    157. 

  157. 								</tr>
    158. 

  158. 								<tr>
    159. 

  159. 									<td class="name">
    160. 

  160. 										<strong>onProgress</strong>
    161. 

  161. 									</td>
    162. 

  162. 									<td class="description last">
    163. 

  163. 										<p>Executed while the loading is in progress.</p>
    164. 

  164. 									</td>
    165. 

  165. 								</tr>
    166. 

  166. 							</tbody>
    167. 

  167. 						</table>
    168. 

  168. 						<dl class="details">
    169. 

  169. 							<dt class="tag-returns"><strong>Returns:</strong> A Promise that resolves when the asset has been loaded.</dt>
    170. 

  170. 						</dl>
    171. 

  171. 					</div>
    172. 

  172. 					<h3 class="name name-method" id="parse" translate="no">.<a href="#parse">parse</a><span class="signature">( data : <span class="param-type"><a href="global.html#any">any</a></span> )</span> <span class="type-signature">(abstract) </span></h3>
    173. 

  173. 					<div class="method">
    174. 

  174. 						<div class="description">
    175. 

  175. 							<p>This method needs to be implemented by all concrete loaders. It holds the
    176. 

  176. logic for parsing the asset into three.js entities.</p>
    177. 

  177. 						</div>
    178. 

  178. 						<table class="params">
    179. 

  179. 							<tbody>
    180. 

  180. 								<tr>
    181. 

  181. 									<td class="name">
    182. 

  182. 										<strong>data</strong>
    183. 

  183. 									</td>
    184. 

  184. 									<td class="description last">
    185. 

  185. 										<p>The data to parse.</p>
    186. 

  186. 									</td>
    187. 

  187. 								</tr>
    188. 

  188. 							</tbody>
    189. 

  189. 						</table>
    190. 

  190. 					</div>
    191. 

  191. 					<h3 class="name name-method" id="setCrossOrigin" translate="no">.<a href="#setCrossOrigin">setCrossOrigin</a><span class="signature">( crossOrigin : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="Loader.html">Loader</a></span> </h3>
    192. 

  192. 					<div class="method">
    193. 

  193. 						<div class="description">
    194. 

  194. 							<p>Sets the <code>crossOrigin</code> String to implement CORS for loading the URL
    195. 

  195. from a different domain that allows CORS.</p>
    196. 

  196. 						</div>
    197. 

  197. 						<table class="params">
    198. 

  198. 							<tbody>
    199. 

  199. 								<tr>
    200. 

  200. 									<td class="name">
    201. 

  201. 										<strong>crossOrigin</strong>
    202. 

  202. 									</td>
    203. 

  203. 									<td class="description last">
    204. 

  204. 										<p>The <code>crossOrigin</code> value.</p>
    205. 

  205. 									</td>
    206. 

  206. 								</tr>
    207. 

  207. 							</tbody>
    208. 

  208. 						</table>
    209. 

  209. 						<dl class="details">
    210. 

  210. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    211. 

  211. 						</dl>
    212. 

  212. 					</div>
    213. 

  213. 					<h3 class="name name-method" id="setPath" translate="no">.<a href="#setPath">setPath</a><span class="signature">( path : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="Loader.html">Loader</a></span> </h3>
    214. 

  214. 					<div class="method">
    215. 

  215. 						<div class="description">
    216. 

  216. 							<p>Sets the base path for the asset.</p>
    217. 

  217. 						</div>
    218. 

  218. 						<table class="params">
    219. 

  219. 							<tbody>
    220. 

  220. 								<tr>
    221. 

  221. 									<td class="name">
    222. 

  222. 										<strong>path</strong>
    223. 

  223. 									</td>
    224. 

  224. 									<td class="description last">
    225. 

  225. 										<p>The base path.</p>
    226. 

  226. 									</td>
    227. 

  227. 								</tr>
    228. 

  228. 							</tbody>
    229. 

  229. 						</table>
    230. 

  230. 						<dl class="details">
    231. 

  231. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    232. 

  232. 						</dl>
    233. 

  233. 					</div>
    234. 

  234. 					<h3 class="name name-method" id="setRequestHeader" translate="no">.<a href="#setRequestHeader">setRequestHeader</a><span class="signature">( requestHeader : <span class="param-type">Object</span> )</span><span class="type-signature"> : <a href="Loader.html">Loader</a></span> </h3>
    235. 

  235. 					<div class="method">
    236. 

  236. 						<div class="description">
    237. 

  237. 							<p>Sets the given request header.</p>
    238. 

  238. 						</div>
    239. 

  239. 						<table class="params">
    240. 

  240. 							<tbody>
    241. 

  241. 								<tr>
    242. 

  242. 									<td class="name">
    243. 

  243. 										<strong>requestHeader</strong>
    244. 

  244. 									</td>
    245. 

  245. 									<td class="description last">
    246. 

  246. 										<p>A <a href="https://developer.mozilla.org/en-US/docs/Glossary/Request_header" target="_blank" rel="noopener">request header</a>
    247. 

  247. for configuring the HTTP request.</p>
    248. 

  248. 									</td>
    249. 

  249. 								</tr>
    250. 

  250. 							</tbody>
    251. 

  251. 						</table>
    252. 

  252. 						<dl class="details">
    253. 

  253. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    254. 

  254. 						</dl>
    255. 

  255. 					</div>
    256. 

  256. 					<h3 class="name name-method" id="setResourcePath" translate="no">.<a href="#setResourcePath">setResourcePath</a><span class="signature">( resourcePath : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="Loader.html">Loader</a></span> </h3>
    257. 

  257. 					<div class="method">
    258. 

  258. 						<div class="description">
    259. 

  259. 							<p>Sets the base path for dependent resources like textures.</p>
    260. 

  260. 						</div>
    261. 

  261. 						<table class="params">
    262. 

  262. 							<tbody>
    263. 

  263. 								<tr>
    264. 

  264. 									<td class="name">
    265. 

  265. 										<strong>resourcePath</strong>
    266. 

  266. 									</td>
    267. 

  267. 									<td class="description last">
    268. 

  268. 										<p>The resource path.</p>
    269. 

  269. 									</td>
    270. 

  270. 								</tr>
    271. 

  271. 							</tbody>
    272. 

  272. 						</table>
    273. 

  273. 						<dl class="details">
    274. 

  274. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    275. 

  275. 						</dl>
    276. 

  276. 					</div>
    277. 

  277. 					<h3 class="name name-method" id="setWithCredentials" translate="no">.<a href="#setWithCredentials">setWithCredentials</a><span class="signature">( value : <span class="param-type">boolean</span> )</span><span class="type-signature"> : <a href="Loader.html">Loader</a></span> </h3>
    278. 

  278. 					<div class="method">
    279. 

  279. 						<div class="description">
    280. 

  280. 							<p>Whether the XMLHttpRequest uses credentials such as cookies, authorization
    281. 

  281. headers or TLS client certificates, see <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials" target="_blank" rel="noopener">XMLHttpRequest.withCredentials</a>.</p>
    282. 

  282. <p>Note: This setting has no effect if you are loading files locally or from the same domain.</p>
    283. 

  283. 						</div>
    284. 

  284. 						<table class="params">
    285. 

  285. 							<tbody>
    286. 

  286. 								<tr>
    287. 

  287. 									<td class="name">
    288. 

  288. 										<strong>value</strong>
    289. 

  289. 									</td>
    290. 

  290. 									<td class="description last">
    291. 

  291. 										<p>The <code>withCredentials</code> value.</p>
    292. 

  292. 									</td>
    293. 

  293. 								</tr>
    294. 

  294. 							</tbody>
    295. 

  295. 						</table>
    296. 

  296. 						<dl class="details">
    297. 

  297. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    298. 

  298. 						</dl>
    299. 

  299. 					</div>
    300. 

  300. 				<h2 class="subsection-title">Source</h2>
    301. 

  301. 				<p>
    302. 

  302. 					<a href="https://github.com/mrdoob/three.js/blob/master/src/loaders/Loader.js" translate="no" target="_blank" rel="noopener">src/loaders/Loader.js</a>
    303. 

  303. 				</p>
    304. 

  304. 			</article>
    305. 

  305. 		</section>
    306. 

  306. <script src="../scripts/linenumber.js"></script>
    307. 

  307. <script src="../scripts/page.js"></script>
    308. 

  308. </body>
    309. 

  309. </html>
    310.
粤ICP备19079148号