samien
/
three.js
oglindă de https://github.com/mrdoob/three.js.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>FileLoader - Three.js Docs</title>
	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
	<script src="../scripts/highlight.min.js"></script>
	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
	<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
		<p class="inheritance" translate="no"><a href="Loader.html">Loader</a> → </p>
	<h1 translate="no">FileLoader</h1>
		<section>
			<header>
				<div class="class-description"><p>A low level class for loading resources with the Fetch API, used internally by
most loaders. It can also be used directly to load any file type that does
not have a loader.</p>
<p>This loader supports caching. If you want to use it, add <code>THREE.Cache.enabled = true;</code>
once to your application.</p></div>
				<h2>Code Example</h2>
				<div translate="no"><pre><code class="language-js">const loader = new THREE.FileLoader();
const data = await loader.loadAsync( 'example.txt' );
</code></pre></div>
			</header>
			<article>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="FileLoader" translate="no">new <a href="#FileLoader">FileLoader</a><span class="signature">( manager : <span class="param-type"><a href="LoadingManager.html">LoadingManager</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new file loader.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>manager</strong>
									</td>
									<td class="description last">
										<p>The loading manager.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="mimeType" translate="no">.<a href="#mimeType">mimeType</a><span class="type-signature"> : string</span> </h3>
					<div class="description">
						<p>The expected mime type. Valid values can be found
<a href="hhttps://developer.mozilla.org/en-US/docs/Web/API/DOMParser/parseFromString#mimetype">here</a></p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="responseType" translate="no">.<a href="#responseType">responseType</a><span class="type-signature"> : 'arraybuffer' | 'blob' | 'document' | 'json' | ''</span> </h3>
					<div class="description">
						<p>The expected response type.</p>
						<p>Default is <code>''</code>.</p>
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="abort" translate="no">.<a href="#abort">abort</a><span class="signature">()</span><span class="type-signature"> : <a href="FileLoader.html">FileLoader</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Aborts ongoing fetch requests.</p>
						</div>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#abort">Loader#abort</a></dt>
						</dl>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
						</dl>
					</div>
					<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"> : <a href="global.html#any">any</a> | undefined</span> </h3>
					<div class="method">
						<div class="description">
							<p>Starts loading from the given URL and pass the loaded response to the <code>onLoad()</code> callback.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>url</strong>
									</td>
									<td class="description last">
										<p>The path/URL of the file to be loaded. This can also be a data URI.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong>onLoad</strong>
									</td>
									<td class="description last">
										<p>Executed when the loading process has been finished.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong>onProgress</strong>
									</td>
									<td class="description last">
										<p>Executed while the loading is in progress.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong>onError</strong>
									</td>
									<td class="description last">
										<p>Executed when errors occur.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#load">Loader#load</a></dt>
						</dl>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> The cached resource if available.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="setMimeType" translate="no">.<a href="#setMimeType">setMimeType</a><span class="signature">( value : <span class="param-type">string</span> )</span><span class="type-signature"> : <a href="FileLoader.html">FileLoader</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Sets the expected mime type of the loaded file.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>value</strong>
									</td>
									<td class="description last">
										<p>The mime type.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this file loader.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="setResponseType" translate="no">.<a href="#setResponseType">setResponseType</a><span class="signature">( value : <span class="param-type">'arraybuffer' | 'blob' | 'document' | 'json' | ''</span> )</span><span class="type-signature"> : <a href="FileLoader.html">FileLoader</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Sets the expected response type.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>value</strong>
									</td>
									<td class="description last">
										<p>The response type.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this file loader.</dt>
						</dl>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/src/loaders/FileLoader.js" translate="no" target="_blank" rel="noopener">src/loaders/FileLoader.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>