javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295
							<!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>

		<div class="desc">Represents a boundary box in 3d space.</div>


		<h2>Constructor</h2>


		<h3>[name]( [page:Vector3 min], [page:Vector3 max] )</h3>
		<div>
		min -- Lower (x, y, z) boundary of the box.<br>
		max -- Upper (x, y, z) boundary of the box.
		</div>
		<div>
		Creates a box bounded by min and max.
		</div>

		<h2>Properties</h2>


		<h3>[property:Vector3 min]</h3>
		<div>
		Lower (x, y, z) boundary of this box.
		</div>

		<h3>[property:Vector3 max]</h3>
		<div>
		Upper (x, y, z) boundary of this box.
		</div>

		<h2>Methods</h2>


		<h3>[method:Box3 set]( [page:Vector3 min], [page:Vector3 max] ) [page:Box3 this]</h3>
		<div>
		min -- Lower (x, y, z) boundary of the box. <br>
		max -- Upper (x, y, z) boundary of the box.
		</div>
		<div>
		Sets the lower and upper (x, y, z) boundaries of this box.
		</div>

		<h3>[method:Box3 applyMatrix4]( [page:Matrix4 matrix] ) [page:Box3 this]</h3>
		<div>
		matrix -- The [page:Matrix4] to apply
		</div>
		<div>
		Transforms this Box3 with the supplied matrix.
		</div>

		<h3>[method:Vector3 clampPoint]( [page:Vector3 point], [page:Vector3 optionalTarget] ) [page:Box3 this]</h3>
		<div>
		point -- Position to clamp. <br>
		optionalTarget -- If specified, the clamped result will be copied here.
		</div>
		<div>
		Clamps *point* within the bounds of this box.
		</div>

		<h3>[method:Boolean intersectsBox]( [page:Box3 box] ) [page:Box3 this]</h3>
		<div>
		box -- Box to check for intersection against.
		</div>
		<div>
		Determines whether or not this box intersects *box*.
		</div>

		<h3>[method:Boolean intersectsSphere]( [page:Sphere sphere] ) [page:Box3 this]</h3>
		<div>
		sphere -- Sphere to check for intersection against.
		</div>
		<div>
		Determines whether or not this box intersects *sphere*.
		</div>

		<h3>[method:Boolean intersectsPlane]( [page:Plane plane] ) [page:Box3 this]</h3>
		<div>
		plane -- Plane to check for intersection against.
		</div>
		<div>
		Determines whether or not this box intersects *plane*.
		</div>

		<h3>[method:Box3 setFromArray]( [page:Array array] ) [page:Box3 this]</h3>
		<div>
		array -- An array of position data that the resulting box will envelop.
		</div>
		<div>
		Sets the upper and lower bounds of this box to include all of the data in *array*.
		</div>

		<h3>[method:Box3 setFromBufferAttribute]( [page:BufferAttribute attribute] ) [page:Box3 this]</h3>
		<div>
		buffer -- A buffer attribute of position data that the resulting box will envelop.
		</div>
		<div>
		Sets the upper and lower bounds of this box to include all of the data in *attribute*.
		</div>

		<h3>[method:Box3 setFromPoints]( [page:Array points] ) [page:Box3 this]</h3>
		<div>
		points -- Set of points that the resulting box will envelop.
		</div>
		<div>
		Sets the upper and lower bounds of this box to include all of the points in *points*.
		</div>

		<h3>[method:Box3 setFromCenterAndSize]( [page:Vector3 center], [page:Vector3 size] ) [page:Box3 this]</h3>
		<div>
		center -- Desired center position of the box. <br>
		size -- Desired x, y and z dimensions of the box.
		</div>
		<div>
		Centers this box on *center* and sets this box's width, height and depth to the values specified <br>
		in *size*.
		</div>

		<h3>[method:Box3 setFromObject]( [page:Object3D object] ) [page:Box3 this]</h3>
		<div>
		object -- [page:Object3D] to compute the bounding box for.
		</div>
		<div>
		Computes the world-axis-aligned bounding box of an object (including its children), <br>
		accounting for both the object's, and childrens', world transforms
		</div>


		<h3>[method:Vector3 getSize]( [page:Vector3 optionalTarget] ) [page:Box3 this]</h3>
		<div>
		optionalTarget -- If specified, the result will be copied here.
		</div>
		<div>
		Returns the width, height, and depth of this box.
		</div>

		<h3>[method:Box3 union]( [page:Box3 box] ) [page:Box3 this]</h3>
		<div>
		box -- Box that will be unioned with this box.
		</div>
		<div>
		Unions this box with *box* setting the upper bound of this box to the greater of the <br>
		two boxes' upper bounds and the lower bound of this box to the lesser of the two boxes' <br>
		lower bounds.
		</div>

		<h3>[method:Vector3 getParameter]( [page:Vector3 point], [page:Vector3 optionalTarget] ) [page:Box3 this]</h3>
		<div>
		point -- Point to parametrize.
		optionalTarget -- If specified, the result will be copied here.
		</div>
		<div>
		Returns point as a proportion of this box's width and height.
		</div>

		<h3>[method:Box3 intersect]( [page:Box3 box] ) [page:Box3 this]</h3>
		<div>
		box -- Box to intersect with.
		</div>
		<div>
		Returns the intersection of this and *box*, setting the upper bound of this box to the lesser <br>
		of the two boxes' upper bounds and the lower bound of this box to the greater of the two boxes' <br>
		lower bounds.
		</div>

		<h3>[method:Boolean containsBox]( [page:Box3 box] ) [page:Box3 this]</h3>
		<div>
		box -- Box to test for inclusion.
		</div>
		<div>
		Returns true if this box includes the entirety of *box*. If this and *box* overlap exactly,<br>
		this function also returns true.
		</div>

		<h3>[method:Boolean containsPoint]( [page:Vector3 point] ) [page:Box3 this]</h3>
		<div>
		point -- [page:Vector3] to check for inclusion.
		</div>
		<div>
		Returns true if the specified point lies within the boundaries of this box.
		</div>

		<h3>[method:Box3 translate]( [page:Vector3 offset] ) [page:Box3 this]</h3>
		<div>
		offset -- Direction and distance of offset.
		</div>
		<div>
		Adds *offset* to both the upper and lower bounds of this box, effectively moving this box <br>
		*offset* units in 3D space.
		</div>

		<h3>[method:Boolean isEmpty]() [page:Box3 this]</h3>
		<div>
		Returns true if this box includes zero points within its bounds.<br>
		Note that a box with equal lower and upper bounds still includes one point, the <br>
		one both bounds share.
		</div>

		<h3>[method:Box3 clone]() [page:Box3 this]</h3>
		<div>
		Returns a copy of this box.
		</div>

		<h3>[method:Boolean equals]( [page:Box3 box] ) [page:Box3 this]</h3>
		<div>
		box -- Box to compare.
		</div>
		<div>
		Returns true if this box and *box* share the same lower and upper bounds.
		</div>

		<h3>[method:Box3 expandByPoint]( [page:Vector3 point] ) [page:Box3 this]</h3>
		<div>
		point -- Point that should be included in the box.
		</div>
		<div>
		Expands the boundaries of this box to include *point*.
		</div>

		<h3>[method:Box3 expandByScalar]( [page:float scalar] ) [page:Box3 this]</h3>
		<div>
		scalar -- Distance to expand.
		</div>
		<div>
		Expands each dimension of the box by *scalar*. If negative, the dimensions of the box <br/>
		will be contracted.
		</div>

		<h3>[method:Box3 expandByVector]( [page:Vector3 vector] ) [page:Box3 this]</h3>
		<div>
		vector -- Amount to expand this box in each dimension.
		</div>
		<div>
		Expands this box equilaterally by *vector*. The width of this box will be <br>
		expanded by the x component of *vector* in both directions. The height of <br>
		this box will be expanded by the y component of *vector* in both directions. <br>
		The depth of this box will be expanded by the z component of *vector* in <br>
		both directions.
		</div>

		<h3>[method:Box3 copy]( [page:Box3 box] ) [page:Box3 this]</h3>
		<div>
		box -- Box to copy.
		</div>
		<div>
		Copies the values of *box* to this box.
		</div>

		<h3>[method:Box3 makeEmpty]() [page:Box3 this]</h3>
		<div>
		Makes this box empty.
		</div>

		<h3>[method:Vector3 getCenter]( [page:Vector3 optionalTarget] ) [page:Box3 this]</h3>
		<div>
		optionalTarget -- If specified, the result will be copied here.
		</div>
		<div>
		Returns the center point of this box.
		</div>

		<h3>[method:Sphere getBoundingSphere]( [page:Sphere optionalTarget] ) [page:Box3 this]</h3>
		<div>
		optionalTarget -- [page:Sphere] to optionally set the result to.
		</div>
		<div>
		Gets a sphere that bounds the box.
		</div>

		<h3>[method:Float distanceToPoint]( [page:Vector3 point] ) [page:Box3 this]</h3>
		<div>
		point -- Point to measure distance to.
		</div>
		<div>
		Returns the distance from any edge of this box to the specified point. <br>
		If the point lies inside of this box, the distance will be 0.
		</div>

		<h2>Source</h2>

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