Browse Source

LightProbeHelper: Added doc page and TS file.

Mugen87 5 years ago
parent
commit
13dff08855

+ 60 - 0
docs/examples/en/helpers/LightProbeHelper.html

@@ -0,0 +1,60 @@
+<!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; [page:Mesh] &rarr;
+
+		<h1>[name]</h1>
+
+		<p class="desc">
+			Renders a sphere to visualize a light probe in the scene.
+		<p>
+
+		<h2>Example</h2>
+
+		<div>[example:webgl_lightprobe_cubecamera WebGL / lightprobe / cubecamera]</div>
+
+		<code>
+		var helper = new LightProbeHelper( lightProbe, 1 );
+		scene.add( helper );
+		</code>
+
+		<h2>Constructor</h2>
+
+
+		<h3>[name]( [param:LightProbe lightProbe], [param:Number size] )</h3>
+		<p>
+		[page:LightProbe lightProbe] -- the light probe.<br />
+		[page:Number size] -- size of the helper sphere
+		</p>
+
+
+		<h2>Properties</h2>
+		<p>See the base [page:Mesh] class for common properties.</p>
+
+		<h3>[property:LightProbe lightProbe]</h3>
+		<p>The light probe.</p>
+
+		<h3>[property:Number size]</h3>
+		<p>The size of the helper sphere.</p>
+
+		<h2>Methods</h2>
+		<p>See the base [page:Mesh] class for common methods.</p>
+
+		<h3>[method:null dispose]()</h3>
+		<p>Frees internal resources.</p>
+
+
+		<h2>Source</h2>
+
+		<p>
+			[link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/helpers/LightProbeHelper.js examples/jsm/helpers/LightProbeHelper.js]
+		</p>
+	</body>
+</html>

+ 60 - 0
docs/examples/zh/helpers/LightProbeHelper.html

@@ -0,0 +1,60 @@
+<!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; [page:Mesh] &rarr;
+
+		<h1>[name]</h1>
+
+		<p class="desc">
+			Renders a sphere to visualize a light probe in the scene.
+		<p>
+
+		<h2>Example</h2>
+
+		<div>[example:webgl_lightprobe_cubecamera WebGL / lightprobe / cubecamera]</div>
+
+		<code>
+		var helper = new LightProbeHelper( lightProbe, 1 );
+		scene.add( helper );
+		</code>
+
+		<h2>Constructor</h2>
+
+
+		<h3>[name]( [param:LightProbe lightProbe], [param:Number size] )</h3>
+		<p>
+		[page:LightProbe lightProbe] -- the light probe.<br />
+		[page:Number size] -- size of the helper sphere
+		</p>
+
+
+		<h2>Properties</h2>
+		<p>See the base [page:Mesh] class for common properties.</p>
+
+		<h3>[property:LightProbe lightProbe]</h3>
+		<p>The light probe.</p>
+
+		<h3>[property:Number size]</h3>
+		<p>The size of the helper sphere.</p>
+
+		<h2>Methods</h2>
+		<p>See the base [page:Mesh] class for common methods.</p>
+
+		<h3>[method:null dispose]()</h3>
+		<p>Frees internal resources.</p>
+
+
+		<h2>Source</h2>
+
+		<p>
+			[link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/helpers/LightProbeHelper.js examples/jsm/helpers/LightProbeHelper.js]
+		</p>
+	</body>
+</html>

+ 2 - 0
docs/list.js

@@ -368,6 +368,7 @@ var list = {
 
 			"Helpers": {
 				"FaceNormalsHelper": "examples/en/helpers/FaceNormalsHelper",
+				"LightProbeHelper": "examples/en/helpers/LightProbeHelper",
 				"PositionalAudioHelper": "examples/en/helpers/PositionalAudioHelper",
 				"RectAreaLightHelper": "examples/en/helpers/RectAreaLightHelper",
 				"VertexNormalsHelper": "examples/en/helpers/VertexNormalsHelper",
@@ -816,6 +817,7 @@ var list = {
 
 			"辅助对象": {
 				"FaceNormalsHelper": "examples/zh/helpers/FaceNormalsHelper",
+				"LightProbeHelper": "examples/zh/helpers/LightProbeHelper",
 				"PositionalAudioHelper": "examples/zh/helpers/PositionalAudioHelper",
 				"RectAreaLightHelper": "examples/zh/helpers/RectAreaLightHelper",
 				"VertexNormalsHelper": "examples/zh/helpers/VertexNormalsHelper",

+ 15 - 0
examples/jsm/helpers/LightProbeHelper.d.ts

@@ -0,0 +1,15 @@
+import {
+	LightProbe,
+	Mesh
+} from '../../../src/Three';
+
+export class LightProbeHelper extends Mesh {
+
+	constructor( lightProbe: LightProbe, size: number );
+
+	lightProbe: LightProbe;
+	size: number;
+
+	dispose(): void;
+
+}