javax.media.j3d
Class PickRay

java.lang.Object
  javax.media.j3d.PickShape
      javax.media.j3d.PickRay

public final class PickRay
extends PickShape

PickRay is an infinite ray pick shape. It can be used as an argument to the picking methods in BranchGroup and Locale.

See Also:

BranchGroup.pickAll(javax.media.j3d.PickShape), Locale.pickAll(javax.media.j3d.PickShape)

Field Summary

(package private) Vector3d	direction
(package private) Point3d	origin

Fields inherited from class javax.media.j3d.PickShape

PICKBOUNDINGBOX, PICKBOUNDINGPOLYTOPE, PICKBOUNDINGSPHERE, PICKCONE, PICKCYLINDER, PICKPOINT, PICKRAY, PICKSEGMENT, PICKUNKNOWN

Constructor Summary

PickRay()
Constructs an empty PickRay.

PickRay(Point3d origin, Vector3d direction)
Constructs an infinite ray pick shape from the specified parameters.

Method Summary

void	get(Point3d origin, Vector3d direction) Retrieves the parameters from this PickRay.
(package private) int	getPickType()
(package private) Point3d	getStartPoint()
(package private) boolean	intersect(Bounds bounds, Point4d pickPos) Return true if shape intersect with bounds.
void	set(Point3d origin, Vector3d direction) Sets the parameters of this PickRay to the specified values.
(package private) PickShape	transform(Transform3D t3d)

Methods inherited from class javax.media.j3d.PickShape

distance

Methods inherited from class java.lang.Object

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

Field Detail

origin

Point3d origin

direction

Vector3d direction

Constructor Detail

PickRay

public PickRay()

Constructs an empty PickRay. The origin and direction of the ray are initialized to (0,0,0).

PickRay

public PickRay(Point3d origin,
               Vector3d direction)

Constructs an infinite ray pick shape from the specified parameters.

Parameters:

origin - the origin of the ray.

direction - the direction of the ray.

Method Detail

set

public void set(Point3d origin,
                Vector3d direction)

Sets the parameters of this PickRay to the specified values.

Parameters:

origin - the origin of the ray.

direction - the direction of the ray.

get

public void get(Point3d origin,
                Vector3d direction)

Retrieves the parameters from this PickRay.

Parameters:

origin - the Point3d object into which the origin will be copied.

direction - the Vector3d object into which the direction will be copied.

intersect

final boolean intersect(Bounds bounds,
                        Point4d pickPos)

Return true if shape intersect with bounds. The point of intersection is stored in pickPos.

Specified by:

intersect in class PickShape

transform

PickShape transform(Transform3D t3d)

Specified by:

transform in class PickShape

getStartPoint

Point3d getStartPoint()

Specified by:

getStartPoint in class PickShape

getPickType

int getPickType()

Specified by:

getPickType in class PickShape