Browse Source

Update Sprite.html

Added notion that sprites do not cast shadows.
Coder2012 9 years ago
parent
commit
adfd72a3ad
1 changed files with 65 additions and 63 deletions
  1. 65 63
      docs/api/objects/Sprite.html

+ 65 - 63
docs/api/objects/Sprite.html

@@ -1,64 +1,66 @@
-<!DOCTYPE html>
-<html lang="en">
-	<head>
+<!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>
-
-		<div class="desc">A sprite is a plane in an 3d scene which faces always towards the camera. </div>
-
-                <h2>Example</h2>
-
-                <code>
-                var map = new THREE.TextureLoader().load( "sprite.png" );
-                var material = new THREE.SpriteMaterial( { map: map, color: 0xffffff, fog: true } );
-                var sprite = new THREE.Sprite( material );
-                scene.add( sprite );
-                </code>
-
-
-		<h2>Constructor</h2>
-
-		<h3>[name]([page:Material material])</h3>
-		<div>
-                material — An instance of [page:Material] (optional).
-		</div>
-		<div>
-		This creates a new sprite with an specific material.
-		</div>
-
-
-		<h2>Properties</h2>
-
-		<h3>[property:SpriteMaterial material]</h3>
-		<div>
-		An instance of [page:Material], defining the object's appearance. Default is a [page:SpriteMaterial] which is a white plane.
-		</div>
--
-           	<h2>Methods</h2>
-
-                <h3>[method:Sprite clone]()</h3>
-                <div>
-                This creates a new clone of the sprite.
-                </div>
-
-		<h3>[method:Object3D clone]([page:Object3D object])</h3>
-		<div>
-		object -- (optional) Object3D which needs to be cloned. If undefined, clone method will create a new cloned Sprite Object.
-		</div>
-		<div>
-		Clone a Sprite Object.
-		</div>
-
-		<h2>Source</h2>
-
-		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
-	</body>
-</html>
+		<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>
+
+		<div class="desc">A sprite is a plane in an 3d scene which faces always towards the camera. </div>
+
+		<div class="desc">Sprites do not cast shadows, setting <code>castShadow = true</code> will have no effect.</div>
+		
+                <h2>Example</h2>
+
+                <code>
+                var map = new THREE.TextureLoader().load( "sprite.png" );
+                var material = new THREE.SpriteMaterial( { map: map, color: 0xffffff, fog: true } );
+                var sprite = new THREE.Sprite( material );
+                scene.add( sprite );
+                </code>
+
+
+		<h2>Constructor</h2>
+
+		<h3>[name]([page:Material material])</h3>
+		<div>
+                material — An instance of [page:Material] (optional).
+		</div>
+		<div>
+		This creates a new sprite with an specific material.
+		</div>
+
+
+		<h2>Properties</h2>
+
+		<h3>[property:SpriteMaterial material]</h3>
+		<div>
+		An instance of [page:Material], defining the object's appearance. Default is a [page:SpriteMaterial] which is a white plane.
+		</div>
+-
+           	<h2>Methods</h2>
+
+                <h3>[method:Sprite clone]()</h3>
+                <div>
+                This creates a new clone of the sprite.
+                </div>
+
+		<h3>[method:Object3D clone]([page:Object3D object])</h3>
+		<div>
+		object -- (optional) Object3D which needs to be cloned. If undefined, clone method will create a new cloned Sprite Object.
+		</div>
+		<div>
+		Clone a Sprite Object.
+		</div>
+
+		<h2>Source</h2>
+
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
+	</body>
+</html>