aboutsummaryrefslogtreecommitdiffstats
path: root/src/jogl/classes
diff options
context:
space:
mode:
Diffstat (limited to 'src/jogl/classes')
-rw-r--r--src/jogl/classes/com/jogamp/graph/curve/opengl/GLRegion.java8
-rw-r--r--src/jogl/classes/com/jogamp/graph/curve/opengl/RegionRenderer.java9
-rw-r--r--src/jogl/classes/com/jogamp/opengl/math/FloatUtil.java18
-rw-r--r--src/jogl/classes/com/jogamp/opengl/math/Ray.java4
-rw-r--r--src/jogl/classes/com/jogamp/opengl/math/geom/AABBox.java6
-rw-r--r--src/jogl/classes/com/jogamp/opengl/math/geom/Frustum.java14
6 files changed, 42 insertions, 17 deletions
diff --git a/src/jogl/classes/com/jogamp/graph/curve/opengl/GLRegion.java b/src/jogl/classes/com/jogamp/graph/curve/opengl/GLRegion.java
index 8f3a10d9d..654f9a692 100644
--- a/src/jogl/classes/com/jogamp/graph/curve/opengl/GLRegion.java
+++ b/src/jogl/classes/com/jogamp/graph/curve/opengl/GLRegion.java
@@ -37,6 +37,7 @@ import jogamp.graph.curve.opengl.VBORegionSPES2;
import com.jogamp.opengl.util.PMVMatrix;
import com.jogamp.opengl.util.texture.TextureSequence;
import com.jogamp.graph.curve.Region;
+import com.jogamp.graph.curve.OutlineShape;
/** A GLRegion is the OGL binding of one or more OutlineShapes
* Defined by its vertices and generated triangles. The Region
@@ -46,7 +47,8 @@ import com.jogamp.graph.curve.Region;
* Implementations of the GLRegion shall take care of the OGL
* binding of the depending on its context, profile.
*
- * @see Region, RegionFactory, OutlineShape
+ * @see Region
+ * @see OutlineShape
*/
public abstract class GLRegion extends Region {
@@ -118,7 +120,7 @@ public abstract class GLRegion extends Region {
* it afterwards when used in conjunction with other renderer.
* </p>
* <p>
- * Users shall also consider setting the {@link GL#glClearColor(float, float, float, float) Clear Color}
+ * Users shall also consider setting the {@link GL#glClearColor(float, float, float, float) clear-color}
* appropriately:
* <ul>
* <li>If {@link GL#GL_BLEND blending} is enabled, <i>RGB</i> shall be set to text color, otherwise
@@ -129,7 +131,7 @@ public abstract class GLRegion extends Region {
* Note: If {@link GL#GL_BLEND blending} is enabled, the
* {@link RegionRenderer} might need to be
* {@link RegionRenderer#create(RenderState, com.jogamp.graph.curve.opengl.RegionRenderer.GLCallback, com.jogamp.graph.curve.opengl.RegionRenderer.GLCallback) created}
- * with the appropriate {@link {@link RegionRenderer.GLCallback callbacks}.
+ * with the appropriate {@link RegionRenderer.GLCallback callbacks}.
* </p>
* @param matrix current {@link PMVMatrix}.
* @param renderer the {@link RegionRenderer} to be used
diff --git a/src/jogl/classes/com/jogamp/graph/curve/opengl/RegionRenderer.java b/src/jogl/classes/com/jogamp/graph/curve/opengl/RegionRenderer.java
index 23b82639f..a0f54d3b5 100644
--- a/src/jogl/classes/com/jogamp/graph/curve/opengl/RegionRenderer.java
+++ b/src/jogl/classes/com/jogamp/graph/curve/opengl/RegionRenderer.java
@@ -59,6 +59,15 @@ public class RegionRenderer {
protected static final boolean DEBUG = Region.DEBUG;
protected static final boolean DEBUG_INSTANCE = Region.DEBUG_INSTANCE;
+ /**
+ * May be passed to
+ * {@link RegionRenderer#create(RenderState, com.jogamp.graph.curve.opengl.RegionRenderer.GLCallback, com.jogamp.graph.curve.opengl.RegionRenderer.GLCallback) RegionRenderer ctor},
+ * e.g.
+ * <ul>
+ * <li>{@link RegionRenderer#defaultBlendEnable}</li>
+ * <li>{@link RegionRenderer#defaultBlendDisable}</li>
+ * </ul>
+ */
public interface GLCallback {
/**
* @param gl a current GL object
diff --git a/src/jogl/classes/com/jogamp/opengl/math/FloatUtil.java b/src/jogl/classes/com/jogamp/opengl/math/FloatUtil.java
index 3a3568697..1a8924c8f 100644
--- a/src/jogl/classes/com/jogamp/opengl/math/FloatUtil.java
+++ b/src/jogl/classes/com/jogamp/opengl/math/FloatUtil.java
@@ -42,15 +42,15 @@ import com.jogamp.opengl.math.geom.AABBox;
* Implementation assumes linear matrix layout in column-major order
* matching OpenGL's implementation, illustration:
* <pre>
- Row-Major Column-Major (OpenGL):
-
- | 0 1 2 3 | | 0 4 8 12 |
- | | | |
- | 4 5 6 7 | | 1 5 9 13 |
- M = | | M = | |
- | 8 9 10 11 | | 2 6 10 14 |
- | | | |
- | 12 13 14 15 | | 3 7 11 15 |
+ Row-Major Column-Major (OpenGL):
+
+ | 0 1 2 3 | | 0 4 8 12 |
+ | | | |
+ | 4 5 6 7 | | 1 5 9 13 |
+ M = | | M = | |
+ | 8 9 10 11 | | 2 6 10 14 |
+ | | | |
+ | 12 13 14 15 | | 3 7 11 15 |
C R C R
m[0*4+3] = tx; m[0+4*3] = tx;
diff --git a/src/jogl/classes/com/jogamp/opengl/math/Ray.java b/src/jogl/classes/com/jogamp/opengl/math/Ray.java
index 0daca2504..4d651d1c3 100644
--- a/src/jogl/classes/com/jogamp/opengl/math/Ray.java
+++ b/src/jogl/classes/com/jogamp/opengl/math/Ray.java
@@ -41,7 +41,9 @@ import com.jogamp.opengl.math.geom.AABBox;
* </p>
* <p>
* A {@link Ray} maybe used for <i>picking</i>
- * using a {@link AABBox#getRayIntersection(Ray, float[]) bounding box}.
+ * using a {@link AABBox bounding box} via
+ * {@link AABBox#intersectsRay(Ray) fast probe} or
+ * {@link AABBox#getRayIntersection(float[], Ray, float, boolean, float[], float[], float[]) returning the intersection}.
* </p>
*/
public class Ray {
diff --git a/src/jogl/classes/com/jogamp/opengl/math/geom/AABBox.java b/src/jogl/classes/com/jogamp/opengl/math/geom/AABBox.java
index 4caff95ea..29cc2b51a 100644
--- a/src/jogl/classes/com/jogamp/opengl/math/geom/AABBox.java
+++ b/src/jogl/classes/com/jogamp/opengl/math/geom/AABBox.java
@@ -440,12 +440,16 @@ public class AABBox {
* <li>Optimized code by Pierre Terdiman, 2000 (~20-30% faster on my Celeron 500)</li>
* <li>Epsilon value added by Klaus Hartmann.</li>
* </ul>
+ * </p>
+ * <p>
* Method is based on the requirements:
* <ul>
* <li>the integer representation of 0.0f is 0x00000000</li>
* <li>the sign bit of the float is the most significant one</li>
* </ul>
- * Report bugs: [email protected]
+ * </p>
+ * <p>
+ * Report bugs: [email protected] (original author)
* </p>
* <pre>
* [1] http://www.codercorner.com/RayAABB.cpp
diff --git a/src/jogl/classes/com/jogamp/opengl/math/geom/Frustum.java b/src/jogl/classes/com/jogamp/opengl/math/geom/Frustum.java
index f6d3c0dfa..b73bad613 100644
--- a/src/jogl/classes/com/jogamp/opengl/math/geom/Frustum.java
+++ b/src/jogl/classes/com/jogamp/opengl/math/geom/Frustum.java
@@ -33,9 +33,17 @@ import com.jogamp.common.os.Platform;
/**
* Providing frustum {@link #getPlanes() planes} derived by different inputs
- * ({@link #updateByPMV(float[], int) P*MV}, ..)
- * used to {@link #classifySphere(float[], float) classify objects} and to test
- * whether they are {@link #isOutside(AABBox) outside}.
+ * ({@link #updateByPMV(float[], int) P*MV}, ..) used to classify objects
+ * <ul>
+ * <li> {@link #classifyPoint(float[]) point} </li>
+ * <li> {@link #classifySphere(float[], float) sphere} </li>
+ * </ul>
+ * and to test whether they are outside
+ * <ul>
+ * <li> {@link #isPointOutside(float[]) point} </li>
+ * <li> {@link #isSphereOutside(float[], float) sphere} </li>
+ * <li> {@link #isAABBoxOutside(AABBox) bounding-box} </li>
+ * </ul>
*
* <p>
* Extracting the world-frustum planes from the P*Mv: