JOGL v2.6.0-rc-20250706
JOGL, High-Performance Graphics Binding for Java™ (public API).
Ray.java
Go to the documentation of this file.
1/**
2 * Copyright 2014-2023 JogAmp Community. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without modification, are
5 * permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice, this list of
8 * conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
11 * of conditions and the following disclaimer in the documentation and/or other materials
12 * provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
16 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 *
24 * The views and conclusions contained in the software and documentation are those of the
25 * authors and should not be interpreted as representing official policies, either expressed
26 * or implied, of JogAmp Community.
27 */
28package com.jogamp.math;
29
30import com.jogamp.math.geom.AABBox;
31
32/**
33 * Simple compound denoting a ray.
34 * <p>
35 * A ray, also known as a half line, consists out of it's <i>origin</i>
36 * and <i>direction</i>. Hence it is bound to only the <i>origin</i> side,
37 * where the other end is +infinitive.
38 * <pre>
39 * R(t) = R0 + Rd * t with R0 origin, Rd direction and t > 0.0
40 * </pre>
41 * </p>
42 * <p>
43 * A {@link Ray} maybe used for <i>picking</i>
44 * using a {@link AABBox bounding box} via
45 * {@link AABBox#intersectsRay(Ray) fast probe} or
46 * {@link AABBox#getRayIntersection(float[], Ray, float, boolean, float[], float[], float[]) returning the intersection}.
47 * </p>
48 */
49public class Ray {
50 /** Origin of Ray. */
51 public final Vec3f orig = new Vec3f();
52
53 /** Normalized direction vector of ray. */
54 public final Vec3f dir = new Vec3f();
55
56 @Override
57 public String toString() {
58 return "Ray[orig["+orig+"], dir["+dir+"]]";
59 }
60}
Simple compound denoting a ray.
Definition: Ray.java:49
String toString()
Definition: Ray.java:57
final Vec3f dir
Normalized direction vector of ray.
Definition: Ray.java:54
final Vec3f orig
Origin of Ray.
Definition: Ray.java:51
3D Vector based upon three float components.
Definition: Vec3f.java:37