Skip to content

Docs: Clarified Raycaster.intersectObject(). #13614

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 17, 2018
Merged

Docs: Clarified Raycaster.intersectObject(). #13614

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions docs/api/core/Raycaster.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,20 +155,16 @@ <h3>[method:Array intersectObject]( [page:Object3D object], [param:Boolean recur
<div>
Checks all intersection between the ray and the object with or without the descendants. Intersections are returned sorted by distance, closest first. An array of intersections is returned...
<code>
[ { distance, point, face, faceIndex, indices, object }, ... ]
[ { distance, point, face, faceIndex, object }, ... ]
</code>
<p>
[page:Float distance] – distance between the origin of the ray and the intersection<br />
[page:Vector3 point] – point of intersection, in world coordinates<br />
[page:Face3 face] – intersected face<br />
[page:Integer faceIndex] – index of the intersected face<br />
[page:Array indices] – indices of vertices comprising the intersected face<br />
[page:Object3D object] – the intersected object<br />
[page:Vector2 uv] - U,V coordinates at point of intersection
</p>
<p>
When intersecting a [page:Mesh] with a [page:BufferGeometry], the *faceIndex* will be *undefined*, and *indices* will be set; when intersecting a [page:Mesh] with a [page:Geometry], *indices* will be *undefined*.
</p>
<p>
*Raycaster* delegates to the [page:Object3D.raycast raycast] method of the passed object, when evaluating whether the ray intersects the object or not. This allows [page:Mesh meshes] to respond differently to ray casting than [page:Line lines] and [page:Points pointclouds].
</p>
Expand Down