-
-
Notifications
You must be signed in to change notification settings - Fork 35.5k
/
Loader.html
122 lines (97 loc) · 4.28 KB
/
Loader.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../../" />
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
<h1>[name]</h1>
<p class="desc">Base class for implementing loaders.</p>
<h2>Constructor</h2>
<h3>[name]( [param:LoadingManager manager] )</h3>
<p>
[page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
</p>
<p>
Creates a new [name].
</p>
<h2>Properties</h2>
<h3>[property:String crossOrigin]</h3>
<p>
The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
Default is *anonymous*.
</p>
<h3>[property:Boolean withCredentials]</h3>
<p>
Whether the XMLHttpRequest uses credentials. See [page:.setWithCredentials].
Default is *false*.
</p>
<h3>[property:LoadingManager manager]</h3>
<p>
The [page:LoadingManager loadingManager] the loader is using. Default is [page:DefaultLoadingManager].
</p>
<h3>[property:String path]</h3>
<p>
The base path from which the asset will be loaded.
Default is the empty string.
</p>
<h3>[property:String resourcePath]</h3>
<p>
The base path from which additional resources like textures will be loaded.
Default is the empty string.
</p>
<h3>[property:Object requestHeader]</h3>
<p>
The [link:https://developer.mozilla.org/en-US/docs/Glossary/Request_header request header] used in HTTP request. See [page:.setRequestHeader]. Default is empty object.
</p>
<h2>Methods</h2>
<h3>[method:void load]()</h3>
<p>
This method needs to be implement by all concrete loaders. It holds the logic for loading the asset from the backend.
</p>
<h3>[method:Promise loadAsync]( [param:String url], [param:Function onProgress] )</h3>
<p>
[page:String url] — A string containing the path/URL of the file to be loaded.<br />
[page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, that contains .[page:Integer total] and .[page:Integer loaded] bytes.<br />
</p>
<p>
This method is equivalent to [page:.load], but returns a [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise].
</p>
<p>
[page:Function onLoad] is handled by [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/resolve Promise.resolve] and [page:Function onError] is handled by [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/reject Promise.reject].
</p>
<h3>[method:void parse]()</h3>
<p>
This method needs to be implement by all concrete loaders. It holds the logic for parsing the asset into three.js entities.
</p>
<h3>[method:Loader setCrossOrigin]( [param:String crossOrigin] )</h3>
<p>
[page:String crossOrigin] — The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
</p>
<h3>[method:Loader setWithCredentials]( [param:Boolean value] )</h3>
<p>
Whether the XMLHttpRequest uses credentials such as cookies, authorization headers or
TLS client certificates. See [link:https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials XMLHttpRequest.withCredentials].<br />
Note that this has no effect if you are loading files locally or from the same domain.
</p>
<h3>[method:Loader setPath]( [param:String path] )</h3>
<p>
[page:String path] — Set the base path for the asset.
</p>
<h3>[method:Loader setResourcePath]( [param:String resourcePath] )</h3>
<p>
[page:String resourcePath] — Set the base path for dependent resources like textures.
</p>
<h3>[method:Loader setRequestHeader]( [param:Object requestHeader] )</h3>
<p>
[page:Object requestHeader] - key: The name of the header whose value is to be set. value: The value to set as the body of the header.<br /><br />
Set the [link:https://developer.mozilla.org/en-US/docs/Glossary/Request_header request header] used in HTTP request.
</p>
<h2>Source</h2>
<p>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</p>
</body>
</html>