File: Light.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 (82 lines) | stat: -rw-r--r-- 2,368 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
<!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>
		[page:Object3D] &rarr;

		<h1>[name]</h1>

		<p class="desc">
			Abstract base class for lights - all other light types inherit the properties and methods
			described here.
		</p>


		<h2>Constructor</h2>


		<h3>[name]( [param:Integer color], [param:float intensity] )</h3>
		<p>
		[page:Integer color] - (optional) hexadecimal color of the light. Default is 0xffffff (white).<br />
		[page:Float intensity] - (optional) numeric value of the light's strength/intensity. Default is 1.<br /><br />

		Creates a new [name]. Note that this is not intended to be called directly (use one of derived classes instead).
		</p>

		<h2>Properties</h2>
		<p>
			See the base [page:Object3D Object3D] class for common properties.
		</p>

		<h3>[property:Color color]</h3>
		<p>
			Color of the light. Defaults to a new [page:Color] set to white, if not passed in the constructor.<br />
		</p>

		<h3>[property:Float intensity]</h3>
		<p>
			The light's intensity, or strength.<br />
			In [page:WebGLRenderer.physicallyCorrectLights physically correct] mode, the product of
			[page:.color color] * intensity is interpreted as luminous intensity measured in candela.<br />
			Default - *1.0*.
		</p>

		<h3>[property:Boolean isLight]</h3>
		<p>
			Used to check whether this or derived classes are lights. Default is *true*.<br /><br />

			You should not change this, as it used internally for optimisation.
		</p>


		<h2>Methods</h2>
		<p>
			See the base [page:Object3D Object3D] class for common methods.
		</p>


		<h3>[method:Light copy]( [param:Light source] )</h3>
		<p>
		Copies the value of [page:.color color] and [page:.intensity intensity] from the
		[page:Light source] light into this one.
		</p>

		<h3>[method:Object toJSON]( [param:object meta] )</h3>
		<p>
		meta -- object containing metadata such as materials, textures for objects.<br />
		Convert the light to three.js [link:https://github.com/mrdoob/three.js/wiki/JSON-Object-Scene-format-4 JSON Object/Scene format].
		</p>

		<h2>Source</h2>

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