Bläddra i källkod

Updated description of BoxHelper doc

looeee 8 år sedan
förälder
incheckning
e7ae4a0979
1 ändrade filer med 7 tillägg och 2 borttagningar
  1. 7 2
      docs/api/extras/helpers/BoxHelper.html

+ 7 - 2
docs/api/extras/helpers/BoxHelper.html

@@ -12,7 +12,12 @@
 
 		<h1>[name]</h1>
 
-		<div class="desc">Helper object to show a bounding box around an object.</div>
+		<div class="desc">
+			Helper object to show the world-axis-aligned bounding box around an object.
+
+			Note that the object must have a [page:Geometry] or [page:BufferGeometry] for this to work, 
+			so it won't work with [page:Sprite Sprites].
+		</div>
 
 
 		<h2>Example</h2>
@@ -39,7 +44,7 @@
 		[page:Color color] --  hexadecimal value that defines the box's color. Default is 0xffff00.<br /><br />
 
 		Creates a new wireframe box that bounds the passed object. Internally this uses [page:Box3.setFromObject]
-		to calculate the dimensions. Note that this includes any children. 
+		to calculate the dimensions. Note that this includes any children.
 		</div>
 
 		<h2>Properties</h2>