File: Loader.html

package info (click to toggle)
three.js 111%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 15,184 kB
  • sloc: javascript: 133,174; makefile: 24; sh: 1
file content (86 lines) | stat: -rw-r--r-- 2,317 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<base href="../../../" />
		<script src="list.js"></script>
		<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: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>

		<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: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 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>

		<h2>Source</h2>

		<p>
			[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
		</p>
	</body>
</html>