From 6f30f4863b22065060515aeaf3caba843f7de233 Mon Sep 17 00:00:00 2001 From: OpenShift guest Date: Fri, 25 Jan 2013 05:08:41 -0500 Subject: [PATCH] update Raycaster documentation --- docs/api/core/Raycaster.html | 63 +++++++++++++++++++++++++++++++++--- 1 file changed, 58 insertions(+), 5 deletions(-) diff --git a/docs/api/core/Raycaster.html b/docs/api/core/Raycaster.html index 8ad6d52df4..ea51850b70 100644 --- a/docs/api/core/Raycaster.html +++ b/docs/api/core/Raycaster.html @@ -9,24 +9,77 @@

[name]

-
todo
+
+ This class makes raycasting easier. Raycasting is used for picking and more. + +

Constructor

-

[name]()

+

[name]( [page:Vector3 origin], [page:Vector3 direction], [page:Float near], [page:Float far] ) {

+
+ [page:Vector3 origin] — The origin vector where the ray casts from.
+ [page:Vector3 direction] — The direction vector that gives direction to the ray.
+ [page:Float near] — All results returned are further away then near. Near can't be negative. Default value is 0.
+ [page:Float far] — All results returned are closer then far. Far can't be lower then near . Default value is Infinity. +
+
+ This creates a new raycaster object.
+

Properties

-

.[page:Vector3 todo]

+

.[page:Ray ray]

+
+ The Ray used for the raycasting. +
+ +

.[page:float near]

+
+ The near factor of the raycaster. This value indicates which objects can be discarded based on the distance.
+ This value shouldn't be negative and should be smaller then the far property. +
+

.[page:float far]

+
+ The far factor of the raycaster. This value indicates which objects can be discarded based on the distance.
+ This value shouldn't be negative and should be smaller then the far property. +
+ +

.[page:float precision]

+
+ The precision factor of the raycaster. +

Methods

-

.todo( [page:Vector3 todo] )

+

.set( [page:Vector3 origin], [page:Vector3 direction] )

+
+ [page:Vector3 origin] — The origin vector where the ray casts from.
+ [page:Vector3 direction] — The direction vector that gives direction to the ray. +
+
+ Updates the ray with a new origin and direction. +
+ +

.intersectObject( [page:Object3D object], [page:Boolean recursive] )

+
+ [page:Object3D object] — The object to check for intersection with the ray.
+ [page:Boolean recursive] — If set, it also checks all descendants. Otherwise it only checks intersecton with the object. +
+
+ checks all intersection between the ray and the object with or without the descendants. +
+ +

.intersectObjects( [page:Array objects], [page:Boolean recursive] )

+
+ [page:Array objects] — The objects to check for intersection with the ray.
+ [page:Boolean recursive] — If set, it also checks all descendants of the objects. Otherwise it only checks intersecton with the objects. +
- todo — todo
+ checks all intersection between the ray and the objects with or without the descendants.
-- GitLab