|
@@ -16,7 +16,7 @@
|
|
|
<h2>Constructor</h2>
|
|
|
|
|
|
|
|
|
- <h3>[name]([page:Vector3 origin], [page:Vector3 direction])</h3>
|
|
|
+ <h3>[name]( [page:Vector3 origin], [page:Vector3 direction] )</h3>
|
|
|
<div>
|
|
|
origin -- [page:Vector3] The origin of the [page:Ray].<br />
|
|
|
direction -- [page:Vector3] The direction of the [page:Ray]. This must be normalized (with [page:Vector3].normalize) for the methods to operate properly.
|
|
@@ -39,7 +39,7 @@
|
|
|
|
|
|
<h2>Methods</h2>
|
|
|
|
|
|
- <h3>[method:Ray applyMatrix4]([page:Matrix4 matrix4])</h3>
|
|
|
+ <h3>[method:Ray applyMatrix4]( [page:Matrix4 matrix4] )</h3>
|
|
|
<div>
|
|
|
matrix4 -- [page:Matrix4] The [page:Matrix4] to transform this [page:Ray] by.
|
|
|
</div>
|
|
@@ -47,7 +47,7 @@
|
|
|
Transform this [page:Ray] by the [page:Matrix4].
|
|
|
</div>
|
|
|
|
|
|
- <h3>.at([page:Float t], [page:Vector3 optionalTarget] = null) [page:Vector3]</h3>
|
|
|
+ <h3>[method:Vector3 at]( [page:Float t], [page:Vector3 optionalTarget] = null ) [page:Vector3]</h3>
|
|
|
<div>
|
|
|
t -- [page:Float] The distance along the [page:Ray] to retrieve a position for.<br />
|
|
|
optionalTarget -- [page:Vector3] Receives the position along the [page:Ray] if passed; otherwise a new [page:Vector3] is created.
|
|
@@ -61,7 +61,7 @@
|
|
|
Create a clone of this [page:Ray].
|
|
|
</div>
|
|
|
|
|
|
- <h3>[method:Vector3 closestPointToPoint]([page:Vector3 point], [page:Vector3 optionalTarget])</h3>
|
|
|
+ <h3>[method:Vector3 closestPointToPoint]( [page:Vector3 point], [page:Vector3 optionalTarget] )</h3>
|
|
|
<div>
|
|
|
point -- [page:Vector3] The point to get the closest approach to. <br />
|
|
|
optionalTarget -- [page:Vector3] Receives the return value if passed; otherwise a new [page:Vector3] is created.
|
|
@@ -70,7 +70,7 @@
|
|
|
Get the point along this [page:Ray] that is closest to the [page:Vector3] provided.
|
|
|
</div>
|
|
|
|
|
|
- <h3>[method:Ray copy]([page:Ray ray])</h3>
|
|
|
+ <h3>[method:Ray copy]( [page:Ray ray] )</h3>
|
|
|
<div>
|
|
|
ray -- [page:Ray] The [page:Ray] to copy values from.
|
|
|
</div>
|
|
@@ -78,7 +78,7 @@
|
|
|
Copy the properties of the provided [page:Ray], then return this [page:Ray].
|
|
|
</div>
|
|
|
|
|
|
- <h3>.distanceSqToSegment([page:Vector3 v0], [page:Vector3 v1], [page:Vector3 optionalPointOnRay] = null, [page:Vector3 optionalPointOnSegment] = null) [page:Float]</h3>
|
|
|
+ <h3>[method:Float distanceSqToSegment]( [page:Vector3 v0], [page:Vector3 v1], [page:Vector3 optionalPointOnRay] = null, [page:Vector3 optionalPointOnSegment] = null ) [page:Float]</h3>
|
|
|
<div>
|
|
|
v0 -- [page:Vector3] The start of the line segment.
|
|
|
v1 -- [page:Vector3] The end of the line segment.
|
|
@@ -89,7 +89,7 @@
|
|
|
Get the squared distance between this [page:Ray] and a line segment.
|
|
|
</div>
|
|
|
|
|
|
- <h3>[method:Float distanceToPlane]([page:Plane plane])</h3>
|
|
|
+ <h3>[method:Float distanceToPlane]( [page:Plane plane] )</h3>
|
|
|
<div>
|
|
|
plane -- [page:Plane] The [page:Plane] to get the distance to.
|
|
|
</div>
|
|
@@ -97,7 +97,7 @@
|
|
|
Get the distance from the 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>
|
|
|
+ <h3>[method:Float distanceToPoint]( [page:Vector3 point] )</h3>
|
|
|
<div>
|
|
|
point -- [page:Vector3] The [page:Vector3] to compute a distance to.
|
|
|
</div>
|
|
@@ -105,7 +105,7 @@
|
|
|
Get the distance of the closest approach between the [page:Ray] and the [page:Vector3].
|
|
|
</div>
|
|
|
|
|
|
- <h3>[method:Float distanceSqToPoint]([page:Vector3 point])</h3>
|
|
|
+ <h3>[method:Float distanceSqToPoint]( [page:Vector3 point] )</h3>
|
|
|
<div>
|
|
|
point -- [page:Vector3] The [page:Vector3] to compute a distance to.
|
|
|
</div>
|
|
@@ -113,7 +113,7 @@
|
|
|
Get the squared distance of the closest approach between the [page:Ray] and the [page:Vector3].
|
|
|
</div>
|
|
|
|
|
|
- <h3>[method:Boolean equals]([page:Ray ray])</h3>
|
|
|
+ <h3>[method:Boolean equals]( [page:Ray ray] )</h3>
|
|
|
<div>
|
|
|
ray -- [page:Ray] The [page:Ray] to compare to.
|
|
|
</div>
|
|
@@ -121,7 +121,7 @@
|
|
|
Return whether this and the other [page:Ray] have equal offsets and directions.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.intersectBox([page:Box3 box], [page:Vector3 optionalTarget] = null) [page:Vector3]?</h3>
|
|
|
+ <h3>[method:Vector3 intersectBox]( [page:Box3 box], [page:Vector3 optionalTarget] = null ) [page:Vector3]?</h3>
|
|
|
<div>
|
|
|
box -- [page:Box3] The [page:Box3] to intersect with.<br />
|
|
|
optionalTarget -- [page:Vector3] The [page:Vector3] to store the result in, or *null* to create a new [page:Vector3].
|
|
@@ -130,7 +130,7 @@
|
|
|
Intersect this [page:Ray] with a [page:Box3], returning the intersection point or *null* if there is no intersection.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.intersectPlane([page:Plane plane], [page:Vector3 optionalTarget] = null) [page:Vector3]?</h3>
|
|
|
+ <h3>[method:Vector3 intersectPlane]( [page:Plane plane], [page:Vector3 optionalTarget] = null ) [page:Vector3]?</h3>
|
|
|
<div>
|
|
|
plane -- [page:Plane] The [page:Plane] to intersect with.<br />
|
|
|
optionalTarget -- [page:Vector3] The [page:Vector3] to store the result in, or *null* to create a new [page:Vector3].
|
|
@@ -140,7 +140,7 @@
|
|
|
</div>
|
|
|
function ( a, b, c, backfaceCulling, optionalTarget )
|
|
|
|
|
|
- <h3>.intersectTriangle([page:Vector3 a], [page:Vector3 b], [page:Vector3 c], [page:Boolean backfaceCulling], [page:Vector3 optionalTarget] = null) [page:Vector3]?</h3>
|
|
|
+ <h3>[method:Vector3 intersectTriangle]( [page:Vector3 a], [page:Vector3 b], [page:Vector3 c], [page:Boolean backfaceCulling], [page:Vector3 optionalTarget] = null ) [page:Vector3]?</h3>
|
|
|
<div>
|
|
|
a, b, c -- [page:Vector3] The [page:Vector3] points on the triangle.<br />
|
|
|
backfaceCulling -- [page:Boolean] Whether to use backface culling.<br />
|
|
@@ -150,7 +150,7 @@
|
|
|
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>
|
|
|
+ <h3>[method:Boolean intersectsBox]( [page:Box3 box] )</h3>
|
|
|
<div>
|
|
|
box -- [page:Box3] The [page:Box3] to intersect with.
|
|
|
</div>
|
|
@@ -158,7 +158,7 @@
|
|
|
Return whether or not this [page:Ray] intersects with the [page:Box3].
|
|
|
</div>
|
|
|
|
|
|
- <h3>[method:Boolean intersectsPlane]([page:Plane plane])</h3>
|
|
|
+ <h3>[method:Boolean intersectsPlane]( [page:Plane plane] )</h3>
|
|
|
<div>
|
|
|
plane -- [page:Plane] The [page:Plane] to intersect with.
|
|
|
</div>
|
|
@@ -166,7 +166,7 @@
|
|
|
Return whether or not this [page:Ray] intersects with the [page:Plane].
|
|
|
</div>
|
|
|
|
|
|
- <h3>[method:Boolean intersectsSphere]([page:Sphere sphere])</h3>
|
|
|
+ <h3>[method:Boolean intersectsSphere]( [page:Sphere sphere] )</h3>
|
|
|
<div>
|
|
|
sphere -- [page:Sphere] The [page:Sphere] to intersect with.
|
|
|
</div>
|
|
@@ -174,7 +174,7 @@
|
|
|
Return whether or not this [page:Ray] intersects with the [page:Sphere].
|
|
|
</div>
|
|
|
|
|
|
- <h3>[method:Ray recast]([page:Float t])</h3>
|
|
|
+ <h3>[method:Ray recast]( [page:Float t] )</h3>
|
|
|
<div>
|
|
|
t -- The distance along the [page:Ray] to interpolate.
|
|
|
</div>
|
|
@@ -182,7 +182,7 @@
|
|
|
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>
|
|
|
+ <h3>[method:Ray set]( [page:Vector3 origin], [page:Vector3 direction] )</h3>
|
|
|
<div>
|
|
|
origin -- [page:Vector3] The origin of the [page:Ray].<br />
|
|
|
direction -- [page:Vector3] The direction of the [page:Ray]. This must be normalized (with [page:Vector3].normalize) for the methods to operate properly.
|
|
@@ -191,7 +191,7 @@
|
|
|
Copy the parameters to the origin and direction properties.
|
|
|
</div>
|
|
|
|
|
|
- <h3>[method:Ray lookAt]([page:Vector3 v])</h3>
|
|
|
+ <h3>[method:Ray lookAt]( [page:Vector3 v] )</h3>
|
|
|
<div>
|
|
|
v -- [page:Vector3] The vector to look at.
|
|
|
</div>
|