diff options
author | Sven Gothel <[email protected]> | 2023-03-14 14:23:16 +0100 |
---|---|---|
committer | Sven Gothel <[email protected]> | 2023-03-14 14:23:16 +0100 |
commit | f7e8f8467ced9f494f8cafc51ca9e77038042905 (patch) | |
tree | 7c06b61782ad63aa6556ebbbaf371abd42ae393c /src/jogl/classes/com/jogamp/opengl/math | |
parent | 5922ac12e89fd7b60e91b1b46dce93d0c35d2fd0 (diff) |
AABBox: Add API doc comment on reset() and hence default ctor regarding infinite dimension
Diffstat (limited to 'src/jogl/classes/com/jogamp/opengl/math')
-rw-r--r-- | src/jogl/classes/com/jogamp/opengl/math/geom/AABBox.java | 13 |
1 files changed, 10 insertions, 3 deletions
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 234b2121b..5a14406b0 100644 --- a/src/jogl/classes/com/jogamp/opengl/math/geom/AABBox.java +++ b/src/jogl/classes/com/jogamp/opengl/math/geom/AABBox.java @@ -56,8 +56,12 @@ public class AABBox { private final float[] center = new float[3]; /** - * Create an Axis Aligned bounding box (AABBox) - * where the low and and high MAX float Values. + * Create an Axis Aligned bounding box (AABBox) with the + * inverse low/high, allowing the next {@link #resize(float, float, float)} command to hit. + * <p> + * The dimension, i.e. {@link #getWidth()} abd {@link #getHeight()} is {@link Float#isInfinite()} thereafter. + * </p> + * @see #reset() */ public AABBox() { reset(); @@ -96,7 +100,10 @@ public class AABBox { } /** - * resets this box to the inverse low/high, allowing the next {@link #resize(float, float, float)} command to hit. + * Resets this box to the inverse low/high, allowing the next {@link #resize(float, float, float)} command to hit. + * <p> + * The dimension, i.e. {@link #getWidth()} abd {@link #getHeight()} is {@link Float#isInfinite()} thereafter. + * </p> * @return this AABBox for chaining */ public final AABBox reset() { |