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


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221
							<!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">
			A ray that emits from an origin in a certain direction. This is used by the
			[page:RayCaster] to assist with [link:https://en.wikipedia.org/wiki/Ray_casting raycasting].
			Raycasting is used for mouse picking (working out what objects in the 3d space the mouse is over) amongst
			other things.
		</div>


		<h2>Constructor</h2>


		<h3>[name]( [page:Vector3 origin], [page:Vector3 direction] )</h3>
		<div>
		[page:Vector3 origin] - (optional) the origin of the [page:Ray]. Default is a [page:Vector3] at (0, 0, 0).<br />
		[page:Vector3 direction] - [page:Vector3] The direction of the [page:Ray]. This must be normalized
		 (with [page:Vector3.normalize]) for the methods to operate properly.  Default is a [page:Vector3] at (0, 0, 0).<br /><br />

		Creates a new [name] and initialises the origin and direction properties to the
		provided values.
		</div>

		<h2>Properties</h2>

		<h3>[property:Vector3 origin]</h3>
		<div>The origin of the [page:Ray]. Default is a [page:Vector3] at (0, 0, 0).</div>

		<h3>[property:Vector3 direction]</h3>
		<div>
		The direction of the [page:Ray]. This must be normalized (with [page:Vector3.normalize])
		for the methods to operate properly. Default is a [page:Vector3] at (0, 0, 0).
		</div>


		<h2>Methods</h2>

		<h3>[method:Ray applyMatrix4]( [page:Matrix4 matrix4] )</h3>
		<div>
		[page:Matrix4 matrix4] - the [page:Matrix4] to apply to this [page:Ray].<br /><br />

		Transform this [page:Ray] by the [page:Matrix4].
		</div>

		<h3>[method:Vector3 at]( [page:Float t], [page:Vector3 optionalTarget] ) </h3>
		<div>
		[page:Float t] - the distance along the [page:Ray] to retrieve a position for.<br />
		[page:Vector3 optionalTarget] - (optional) if specified, the result will be copied into this [page:Vector3],
		otherwise a new [page:Vector3] will be created.<br /><br />

		Get a [page:Vector3] that is a given distance along this [page:Ray].
		</div>

		<h3>[method:Ray clone]()</h3>
		<div>
			Creates a new Ray with identical [page:.origin origin] and [page:.direction direction]  to this one.
		</div>

		<h3>[method:Vector3 closestPointToPoint]( [page:Vector3 point], [page:Vector3 optionalTarget] )</h3>
		<div>
		[page:Vector3 point] - the point to get the closest approach to. <br />
		[page:Vector3 optionalTarget] - (optional) if specified, the result will be copied into this [page:Vector3],
		otherwise a new [page:Vector3] will be created.<br /><br />

		Get the point along this [page:Ray] that is closest to the [page:Vector3] provided.
		</div>

		<h3>[method:Ray copy]( [page:Ray ray] )</h3>
		<div>
			Copies the [page:.origin origin] and [page:.direction direction] properties
			of [page:Ray ray] into this ray.
		</div>

		<h3>[method:Float distanceSqToPoint]( [page:Vector3 point] )</h3>
		<div>
		[page:Vector3 point] - the [page:Vector3] to compute a distance to.<br /><br />

		Get the squared distance of the closest approach between the [page:Ray] and the [page:Vector3].
		</div>

		<h3>[method:Float distanceSqToSegment]( [page:Vector3 v0], [page:Vector3 v1], [page:Vector3 optionalPointOnRay] = null, [page:Vector3 optionalPointOnSegment] = null ) [page:Float]</h3>
		<div>
		[page:Vector3 v0] - the start of the line segment.
		[page:Vector3 v1] - the end of the line segment.
		optionalPointOnRay - (optional) if this is provided, it receives the point on this
			[page:Ray] that is closest to the segment.
		optionalPointOnSegment - (optional) if this is provided, it receives the point
			on the line segment that is closest to this [page:Ray].<br /><br />

		Get the squared distance between this [page:Ray] and a line segment.
		</div>

		<h3>[method:Float distanceToPlane]( [page:Plane plane] )</h3>
		<div>
		[page:Plane plane] - the [page:Plane] to get the distance to.<br /><br />

		Get the distance from [page:.origin origin] to the [page:Plane], or *null* if the [page:Ray] doesn't intersect the [page:Plane].
		</div>

		<h3>[method:Float distanceToPoint]( [page:Vector3 point] )</h3>
		<div>
		[page:Vector3 point] - [page:Vector3] The [page:Vector3] to compute a distance to.<br /><br />

		Get the distance of the closest approach between the [page:Ray] and the [page:Vector3 point].
		</div>


		<h3>[method:Boolean equals]( [page:Ray ray] )</h3>
		<div>
		[page:Ray ray] - the [page:Ray] to compare to.<br /><br />

		Returns true if this and the other [page:Ray ray] have equal [page:.offset offset]
		 and [page:.direction direction].
		</div>

		<h3>[method:Vector3 intersectBox]( [page:Box3 box], [page:Vector3 optionalTarget] = null ) [page:Vector3]</h3>
		<div>
		[page:Box3 box] - the [page:Box3] to intersect with.<br />
		[page:Vector3 optionalTarget] - (optional) if specified, the result will be copied into this [page:Vector3],
		otherwise a new [page:Vector3] will be created.<br /><br />

		Intersect this [page:Ray] with a [page:Box3], returning the intersection point or
		*null* if there is no intersection.
		</div>

		<h3>[method:Vector3 intersectPlane]( [page:Plane plane], [page:Vector3 optionalTarget] = null ) [page:Vector3]</h3>
		<div>
		[page:Plane plane] - the [page:Plane] to intersect with.<br />
		[page:Vector3 optionalTarget] - (optional) if specified, the result will be copied into this [page:Vector3],
		otherwise a new [page:Vector3] will be created.<br /><br />

		Intersect this [page:Ray] with a [page:Plane], returning the intersection point or
		*null* if there is no intersection.
		</div>

		<h3>[method:Vector3 intersectSphere]( [page:Sphere sphere], [page:Vector3 optionalTarget] = null ) [page:Vector3]</h3>
		<div>
		[page:Sphere sphere] - the [page:Sphere] to intersect with.<br />
		[page:Vector3 optionalTarget] - (optional) if specified, the result will be copied into this [page:Vector3],
		otherwise a new [page:Vector3] will be created.<br /><br />

		Intersect this [page:Ray] with a [page:Sphere], returning the intersection point or
		*null* if there is no intersection.
		</div>

		<h3>[method:Vector3 intersectTriangle]( [page:Vector3 a], [page:Vector3 b], [page:Vector3 c], [page:Boolean backfaceCulling], [page:Vector3 optionalTarget] )</h3>
		<div>
		[page:Vector3 a], [page:Vector3 b], [page:Vector3 c] - The [page:Vector3] points making up the triangle.<br />
		[page:Boolean backfaceCulling] - [page:Boolean] Whether to use backface culling.<br />
		[page:Vector3 optionalTarget] - (optional) if specified, the result will be copied into this [page:Vector3],
		otherwise a new [page:Vector3] will be created.<br /><br />

		Intersect this [page:Ray] with a triangle, returning the intersection point or *null*
		if there is no intersection.
		</div>

		<h3>[method:Boolean intersectsBox]( [page:Box3 box] )</h3>
		<div>
		[page:Box3 box] - the [page:Box3] to intersect with.<br /><br />

		Return true if this [page:Ray] intersects with the [page:Box3].
		</div>

		<h3>[method:Boolean intersectsPlane]( [page:Plane plane] )</h3>
		<div>
		[page:Plane plane] - the [page:Plane] to intersect with.<br /><br />

		Return true if this [page:Ray] intersects with the [page:Plane].
		</div>

		<h3>[method:Boolean intersectsSphere]( [page:Sphere sphere] )</h3>
		<div>
		[page:Sphere sphere] - the [page:Sphere] to intersect with.<br /><br />

		Return true if this [page:Ray] intersects with the [page:Sphere].
		</div>

		<h3>[method:Ray lookAt]( [page:Vector3 v] )</h3>
		<div>
		[page:Vector3 v] - The [page:Vector3] to look at.<br /><br />

		Adjusts the direction of the ray to point at the vector in world coordinates.
		</div>

		<h3>[method:Ray recast]( [page:Float t] )</h3>
		<div>
		[page:Float t] - The distance along the [page:Ray] to interpolate.<br /><br />

		Shift the origin of this [page:Ray] along its direction by the distance given.
		</div>

		<h3>[method:Ray set]( [page:Vector3 origin], [page:Vector3 direction] )</h3>
		<div>
		[page:Vector3 origin] - the [page:.origin origin] of the [page:Ray].<br />
		[page:Vector3 origin] - the [page:.direction direction] of the [page:Ray].
		This must be normalized (with [page:Vector3.normalize]) for the methods to operate
		properly.<br /><br />

		Copy the parameters to the [page:.origin origin] and [page:.direction direction] properties
		of this ray.
		</div>


		<h2>Source</h2>

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