From a90f4a51dffec3247278e3c683ed4462b1dd9ab5 Mon Sep 17 00:00:00 2001 From: Sven Gothel Date: Thu, 3 Jul 2014 15:06:12 +0200 Subject: FloatUtil.makePick(..): Refine API doc, incl. PMVMatrix.gluPickMatrix(..) --- .../classes/com/jogamp/opengl/math/FloatUtil.java | 14 ++++++++--- .../classes/com/jogamp/opengl/util/PMVMatrix.java | 29 ++++++++++++---------- 2 files changed, 26 insertions(+), 17 deletions(-) (limited to 'src/jogl/classes/com') diff --git a/src/jogl/classes/com/jogamp/opengl/math/FloatUtil.java b/src/jogl/classes/com/jogamp/opengl/math/FloatUtil.java index eeedf531c..3c6a867e6 100644 --- a/src/jogl/classes/com/jogamp/opengl/math/FloatUtil.java +++ b/src/jogl/classes/com/jogamp/opengl/math/FloatUtil.java @@ -735,14 +735,20 @@ public final class FloatUtil { * *

*

+ * To effectively use the generated pick matrix for picking, + * call {@link #makePick(float[], int, float, float, float, float, int[], int, float[]) makePick} + * and multiply a {@link #makePerspective(float[], int, boolean, float, float, float, float) custom perspective matrix} + * by this pick matrix. Then you may load the result onto the perspective matrix stack. + *

+ *

* All matrix fields are set. *

* @param m 4x4 matrix in column-major order, result only * @param m_offset offset in given array m, i.e. start of the 4x4 matrix - * @param x - * @param y - * @param deltaX - * @param deltaY + * @param x the center x-component of a picking region in window coordinates + * @param y the center y-component of a picking region in window coordinates + * @param deltaX the width of the picking region in window coordinates. + * @param deltaY the height of the picking region in window coordinates. * @param viewport 4 component viewport vector * @param viewport_offset * @param mat4Tmp temp float[16] storage diff --git a/src/jogl/classes/com/jogamp/opengl/util/PMVMatrix.java b/src/jogl/classes/com/jogamp/opengl/util/PMVMatrix.java index 079bd2987..71d880a44 100644 --- a/src/jogl/classes/com/jogamp/opengl/util/PMVMatrix.java +++ b/src/jogl/classes/com/jogamp/opengl/util/PMVMatrix.java @@ -175,7 +175,7 @@ public final class PMVMatrix implements GLMatrixFunc { * @return matrix string representation */ @SuppressWarnings("deprecation") - public static StringBuilder matrixToString(StringBuilder sb, String f, FloatBuffer a) { + public static StringBuilder matrixToString(final StringBuilder sb, final String f, final FloatBuffer a) { return FloatUtil.matrixToString(sb, null, f, a, 0, 4, 4, false); } @@ -187,7 +187,7 @@ public final class PMVMatrix implements GLMatrixFunc { * @return side by side representation */ @SuppressWarnings("deprecation") - public static StringBuilder matrixToString(StringBuilder sb, String f, FloatBuffer a, FloatBuffer b) { + public static StringBuilder matrixToString(final StringBuilder sb, final String f, final FloatBuffer a, final FloatBuffer b) { return FloatUtil.matrixToString(sb, null, f, a, 0, b, 0, 4, 4, false); } @@ -450,7 +450,7 @@ public final class PMVMatrix implements GLMatrixFunc { @Override public final void glGetFloatv(final int matrixGetName, final FloatBuffer params) { - int pos = params.position(); + final int pos = params.position(); if(matrixGetName==GL_MATRIX_MODE) { params.put(matrixMode); } else { @@ -462,7 +462,7 @@ public final class PMVMatrix implements GLMatrixFunc { } @Override - public final void glGetFloatv(final int matrixGetName, float[] params, final int params_offset) { + public final void glGetFloatv(final int matrixGetName, final float[] params, final int params_offset) { if(matrixGetName==GL_MATRIX_MODE) { params[params_offset]=matrixMode; } else { @@ -474,7 +474,7 @@ public final class PMVMatrix implements GLMatrixFunc { @Override public final void glGetIntegerv(final int pname, final IntBuffer params) { - int pos = params.position(); + final int pos = params.position(); if(pname==GL_MATRIX_MODE) { params.put(matrixMode); } else { @@ -513,7 +513,7 @@ public final class PMVMatrix implements GLMatrixFunc { @Override public final void glLoadMatrixf(final java.nio.FloatBuffer m) { - int spos = m.position(); + final int spos = m.position(); if(matrixMode==GL_MODELVIEW) { matrixMv.put(m); matrixMv.reset(); @@ -787,10 +787,13 @@ public final class PMVMatrix implements GLMatrixFunc { *

* Traditional gluPickMatrix implementation. *

- * @param x - * @param y - * @param deltaX - * @param deltaY + *

+ * See {@link FloatUtil#makePick(float[], int, float, float, float, float, int[], int, float[]) FloatUtil.makePick(..)} for details. + *

+ * @param x the center x-component of a picking region in window coordinates + * @param y the center y-component of a picking region in window coordinates + * @param deltaX the width of the picking region in window coordinates. + * @param deltaY the height of the picking region in window coordinates. * @param viewport 4 component viewport vector * @param viewport_offset */ @@ -834,7 +837,7 @@ public final class PMVMatrix implements GLMatrixFunc { mat4Tmp1, mat4Tmp2, mat4Tmp3); } - public StringBuilder toString(StringBuilder sb, String f) { + public StringBuilder toString(StringBuilder sb, final String f) { if(null == sb) { sb = new StringBuilder(); } @@ -885,7 +888,7 @@ public final class PMVMatrix implements GLMatrixFunc { * @see #MODIFIED_MODELVIEW * @see #MODIFIED_TEXTURE */ - public final int getModifiedBits(boolean clear) { + public final int getModifiedBits(final boolean clear) { final int r = modifiedBits; if(clear) { modifiedBits = 0; @@ -1002,7 +1005,7 @@ public final class PMVMatrix implements GLMatrixFunc { public final boolean update() { return updateImpl(true); } - private final boolean updateImpl(boolean clearModBits) { + private final boolean updateImpl(final boolean clearModBits) { boolean mod = 0 != modifiedBits; if(clearModBits) { modifiedBits = 0; -- cgit v1.2.3