thothbot.parallax.core.shared.core

Class Raycaster

java.lang.Object

thothbot.parallax.core.shared.core.Raycaster

public class Raycaster
extends java.lang.Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Raycaster.Intersect

Field Summary

Fields

Modifier and Type	Field and Description
static double	LINE_PRECISION The precision factor of the raycaster when intersecting Line objects.
static double	PRECISION The precision factor of the raycaster when intersecting Mesh objects.

Constructor Summary

Constructors

Constructor and Description
Raycaster()
Raycaster(Vector3 origin, Vector3 direction)
Raycaster(Vector3 origin, Vector3 direction, double near, double far) This creates a new raycaster object.

Method Summary

Modifier and Type	Method and Description
double	getFar() The far factor of the raycaster.
double	getNear() The near factor of the raycaster.
Ray	getRay() The Ray used for the raycasting.
java.util.List<Raycaster.Intersect>	intersectObject(GeometryObject object, boolean recursive) Checks all intersection between the ray and the object with or without the descendants.
java.util.List<Raycaster.Intersect>	intersectObjects(java.util.List<? extends Object3D> objects, boolean recursive) Checks all intersection between the ray and the objects with or without the descendants.
void	set(Vector3 origin, Vector3 direction)
void	setFar(double far)
void	setNear(double near)
void	setRay(Ray ray)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PRECISION

public static final double PRECISION

The precision factor of the raycaster when intersecting Mesh objects.

See Also:

Constant Field Values

LINE_PRECISION

public static final double LINE_PRECISION

The precision factor of the raycaster when intersecting Line objects.

See Also:

Constant Field Values

Constructor Detail

Raycaster

public Raycaster()

Raycaster

public Raycaster(Vector3 origin,
                 Vector3 direction)

Raycaster

public Raycaster(Vector3 origin,
                 Vector3 direction,
                 double near,
                 double far)

This creates a new raycaster object.

Parameters:

origin - The origin vector where the ray casts from.

direction - The direction vector that gives direction to the ray.

near - All results returned are further away than near. Near can't be negative. Default value is 0.

far - All results returned are closer then far. Far can't be lower then near . Default value is Infinity.

Method Detail

getRay

public Ray getRay()

The Ray used for the raycasting.

Returns:

setRay

public void setRay(Ray ray)

getNear

public double getNear()

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 than the far property.

Returns:

setNear

public void setNear(double near)

getFar

public double getFar()

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 larger than the near property.

Returns:

setFar

public void setFar(double far)

set

public void set(Vector3 origin,
                Vector3 direction)

intersectObjects

public java.util.List<Raycaster.Intersect> intersectObjects(java.util.List<? extends Object3D> objects,
                                                            boolean recursive)

Checks all intersection between the ray and the objects with or without the descendants. Intersections are returned sorted by distance, closest first. Intersections are of the same form as those returned by intersectObject(GeometryObject, boolean)

Parameters:

objects - The objects to check for intersection with the ray.

recursive - If set, it also checks all descendants of the objects. Otherwise it only checks intersecton with the objects.

Returns:

intersectObject

public java.util.List<Raycaster.Intersect> intersectObject(GeometryObject object,
                                                           boolean recursive)

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...

Parameters:

object - The object to check for intersection with the ray.

recursive - If set, it also checks all descendants. Otherwise it only checks intersecton with the object.

Returns: