Skip to content

Commit 07c5085

Browse files
lejeunerenardmrdoob
authored andcommitted
Add missing intersectSphere() documentation for Ray (mrdoob#9412)
* Add intersectSphere() method to Ray docs * Remove ?s in Ray documentation after return values These are unique phenomenon in the current docs and don't seem to indicate anything meaningful.
1 parent 37a0af9 commit 07c5085

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

docs/api/math/Ray.html

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ <h3>[method:Boolean equals]( [page:Ray ray] )</h3>
121121
Return whether this and the other [page:Ray] have equal offsets and directions.
122122
</div>
123123

124-
<h3>[method:Vector3 intersectBox]( [page:Box3 box], [page:Vector3 optionalTarget] = null ) [page:Vector3]?</h3>
124+
<h3>[method:Vector3 intersectBox]( [page:Box3 box], [page:Vector3 optionalTarget] = null ) [page:Vector3]</h3>
125125
<div>
126126
box -- [page:Box3] The [page:Box3] to intersect with.<br />
127127
optionalTarget -- [page:Vector3] The [page:Vector3] to store the result in, or *null* to create a new [page:Vector3].
@@ -130,17 +130,25 @@ <h3>[method:Vector3 intersectBox]( [page:Box3 box], [page:Vector3 optionalTarget
130130
Intersect this [page:Ray] with a [page:Box3], returning the intersection point or *null* if there is no intersection.
131131
</div>
132132

133-
<h3>[method:Vector3 intersectPlane]( [page:Plane plane], [page:Vector3 optionalTarget] = null ) [page:Vector3]?</h3>
133+
<h3>[method:Vector3 intersectPlane]( [page:Plane plane], [page:Vector3 optionalTarget] = null ) [page:Vector3]</h3>
134134
<div>
135135
plane -- [page:Plane] The [page:Plane] to intersect with.<br />
136136
optionalTarget -- [page:Vector3] The [page:Vector3] to store the result in, or *null* to create a new [page:Vector3].
137137
</div>
138138
<div>
139139
Intersect this [page:Ray] with a [page:Plane], returning the intersection point or *null* if there is no intersection.
140140
</div>
141-
function ( a, b, c, backfaceCulling, optionalTarget )
142141

143-
<h3>[method:Vector3 intersectTriangle]( [page:Vector3 a], [page:Vector3 b], [page:Vector3 c], [page:Boolean backfaceCulling], [page:Vector3 optionalTarget] = null ) [page:Vector3]?</h3>
142+
<h3>[method:Vector3 intersectSphere]( [page:Sphere sphere], [page:Vector3 optionalTarget] = null ) [page:Vector3]</h3>
143+
<div>
144+
sphere -- [page:Sphere] The [page:Sphere] to intersect with.<br />
145+
optionalTarget -- [page:Vector3] The [page:Vector3] to store the result in, or *null* to create a new [page:Vector3].
146+
</div>
147+
<div>
148+
Intersect this [page:Ray] with a [page:Sphere], returning the intersection point or *null* if there is no intersection.
149+
</div>
150+
151+
<h3>[method:Vector3 intersectTriangle]( [page:Vector3 a], [page:Vector3 b], [page:Vector3 c], [page:Boolean backfaceCulling], [page:Vector3 optionalTarget] = null ) [page:Vector3]</h3>
144152
<div>
145153
a, b, c -- [page:Vector3] The [page:Vector3] points on the triangle.<br />
146154
backfaceCulling -- [page:Boolean] Whether to use backface culling.<br />

0 commit comments

Comments
 (0)