Class PMVMatrix

Method Details

• isMatrixModeName

  public static final boolean isMatrixModeName(int matrixModeName)

  Parameters:

  matrixModeName - One of GL_MODELVIEW, GL_PROJECTION or GL_TEXTURE

  Returns:

  true if the given matrix-mode name is valid, otherwise false.

• matrixModeName2MatrixGetName

  public static final int matrixModeName2MatrixGetName(int matrixModeName)

  Parameters:

  matrixModeName - One of GL_MODELVIEW, GL_PROJECTION or GL_TEXTURE

  Returns:

  The corresponding matrix-get name, one of GL_MODELVIEW_MATRIX, GL_PROJECTION_MATRIX or GL_TEXTURE_MATRIX

• isMatrixGetName

  public static final boolean isMatrixGetName(int matrixGetName)

  Parameters:

  matrixGetName - One of GL_MODELVIEW_MATRIX, GL_PROJECTION_MATRIX or GL_TEXTURE_MATRIX

  Returns:

  true if the given matrix-get name is valid, otherwise false.

• matrixGetName2MatrixModeName

  public static final int matrixGetName2MatrixModeName(int matrixGetName)

  Parameters:

  matrixGetName - One of GL_MODELVIEW_MATRIX, GL_PROJECTION_MATRIX or GL_TEXTURE_MATRIX

  Returns:

  The corresponding matrix-mode name, one of GL_MODELVIEW, GL_PROJECTION or GL_TEXTURE

• matrixToString

  public static StringBuilder matrixToString(StringBuilder sb, String f, FloatBuffer a)

  Parameters:

  sb - optional passed StringBuilder instance to be used

  f - the format string of one floating point, i.e. "%10.5f", see Formatter

  a - 4x4 matrix in column major order (OpenGL)

  Returns:

  matrix string representation

• matrixToString

  public static StringBuilder matrixToString(StringBuilder sb, String f, FloatBuffer a, FloatBuffer b)

  Parameters:

  sb - optional passed StringBuilder instance to be used

  f - the format string of one floating point, i.e. "%10.5f", see Formatter

  a - 4x4 matrix in column major order (OpenGL)

  b - 4x4 matrix in column major order (OpenGL)

  Returns:

  side by side representation

• reset

  public final void reset()

  Issues glLoadIdentity() on all matrices, i.e. GL_MODELVIEW, GL_PROJECTION or GL_TEXTURE and resets all internal states.

• glGetMatrixMode

  public final int glGetMatrixMode()

  Returns the current matrix-mode, one of GL_MODELVIEW, GL_PROJECTION or GL_TEXTURE.

• glGetTMatrixf

  public final FloatBuffer glGetTMatrixf()

  Returns the texture matrix (T).

  See matrix storage details.

• glGetPMatrixf

  public final FloatBuffer glGetPMatrixf()

  Returns the projection matrix (P).

  See matrix storage details.

• glGetMvMatrixf

  public final FloatBuffer glGetMvMatrixf()

  Returns the modelview matrix (Mv).

  See matrix storage details.

• glGetMviMatrixf

  public final FloatBuffer glGetMviMatrixf()

  Returns the inverse modelview matrix (Mvi).

  Method enables the Mvi matrix update, and performs it's update w/o clearing the modified bits.

  See update() and matrix storage details.

  See Also:

  • update()
  • clearAllUpdateRequests()

• glGetMvitMatrixf

  public final FloatBuffer glGetMvitMatrixf()

  Returns the inverse transposed modelview matrix (Mvit).

  Method enables the Mvit matrix update, and performs it's update w/o clearing the modified bits.

  See update() and matrix storage details.

  See Also:

  • update()
  • clearAllUpdateRequests()

• glGetPMvMatrixf

  public final FloatBuffer glGetPMvMatrixf()

  Returns 2 matrices within one FloatBuffer: P and Mv.

  See matrix storage details.

• glGetPMvMviMatrixf

  public final FloatBuffer glGetPMvMviMatrixf()

  Returns 3 matrices within one FloatBuffer: P, Mv and Mvi.

  Method enables the Mvi matrix update, and performs it's update w/o clearing the modified bits.

  See update() and matrix storage details.

  See Also:

  • update()
  • clearAllUpdateRequests()

• glGetPMvMvitMatrixf

  public final FloatBuffer glGetPMvMvitMatrixf()

  Returns 4 matrices within one FloatBuffer: P, Mv, Mvi and Mvit.

  Method enables the Mvi and Mvit matrix update, and performs it's update w/o clearing the modified bits.

  See update() and matrix storage details.

  See Also:

  • update()
  • clearAllUpdateRequests()

• glGetFrustum

  public final Frustum glGetFrustum()

  Returns the frustum, derived from projection * modelview

• glGetMatrixf

  public final FloatBuffer glGetMatrixf()

• glGetMatrixf

  public final FloatBuffer glGetMatrixf(int matrixName)

  Parameters:

  matrixName - Either a matrix-get-name, i.e. GL_MODELVIEW_MATRIX, GL_PROJECTION_MATRIX or GL_TEXTURE_MATRIX, or a matrix-mode-name, i.e. GL_MODELVIEW, GL_PROJECTION or GL_TEXTURE

  Returns:

  the named matrix, not a copy!

• multPMvMatrixf

  public final float[] multPMvMatrixf(float[] mat4PMv, int mat4PMv_offset)

  Multiplies the P and Mv matrix, i.e.

      mat4PMv = P x Mv
   

  Parameters:

  mat4PMv - 4x4 matrix storage for result

  mat4PMv_offset -

  Returns:

  given matrix for chaining

• multMvPMatrixf

  public final float[] multMvPMatrixf(float[] mat4MvP, int mat4MvP_offset)

  Multiplies the Mv and P matrix, i.e.

      mat4MvP = Mv x P
   

  Parameters:

  mat4MvP - 4x4 matrix storage for result

  mat4MvP_offset -

  Returns:

  given matrix for chaining

• glMatrixMode

  public final void glMatrixMode(int matrixName)

  Description copied from interface: GLMatrixFunc

  Sets the current matrix mode.

  Specified by:

  glMatrixMode in interface GLMatrixFunc

  Parameters:

  matrixName - GLMatrixFunc.GL_MODELVIEW, GLMatrixFunc.GL_PROJECTION or GL_TEXTURE.

• glGetFloatv

  public final void glGetFloatv(int matrixGetName, FloatBuffer params)

  Description copied from interface: GLMatrixFunc

  Copy the named matrix into the given storage.

  Specified by:

  glGetFloatv in interface GLMatrixFunc

  Parameters:

  matrixGetName - GLMatrixFunc.GL_MODELVIEW_MATRIX, GLMatrixFunc.GL_PROJECTION_MATRIX or GLMatrixFunc.GL_TEXTURE_MATRIX

  params - the FloatBuffer's position remains unchanged, which is the same behavior than the native JOGL GL impl

• glGetFloatv

  public final void glGetFloatv(int matrixGetName, float[] params, int params_offset)

  Description copied from interface: GLMatrixFunc

  Copy the named matrix to the given storage at offset.

  Specified by:

  glGetFloatv in interface GLMatrixFunc

  Parameters:

  matrixGetName - GLMatrixFunc.GL_MODELVIEW_MATRIX, GLMatrixFunc.GL_PROJECTION_MATRIX or GLMatrixFunc.GL_TEXTURE_MATRIX

  params - storage

  params_offset - storage offset

• glGetIntegerv

  public final void glGetIntegerv(int pname, IntBuffer params)

  Description copied from interface: GLMatrixFunc

  glGetIntegerv

  Specified by:

  glGetIntegerv in interface GLMatrixFunc

  Parameters:

  pname - GLMatrixFunc.GL_MATRIX_MODE to receive the current matrix mode

  params - the FloatBuffer's position remains unchanged which is the same behavior than the native JOGL GL impl

• glGetIntegerv

  public final void glGetIntegerv(int pname, int[] params, int params_offset)

  Specified by:

  glGetIntegerv in interface GLMatrixFunc

• glLoadMatrixf

  public final void glLoadMatrixf(float[] values, int offset)

  Description copied from interface: GLMatrixFunc

  Load the current matrix w/ the provided one.

  Specified by:

  glLoadMatrixf in interface GLMatrixFunc

• glLoadMatrixf

  public final void glLoadMatrixf(FloatBuffer m)

  Description copied from interface: GLMatrixFunc

  Load the current matrix w/ the provided one.

  Specified by:

  glLoadMatrixf in interface GLMatrixFunc

• glLoadMatrix

  public final void glLoadMatrix(Quaternion quat)

  Load the current matrix with the values of the given Quaternion's rotation matrix representation.

• glPopMatrix

  public final void glPopMatrix()

  Description copied from interface: GLMatrixFunc

  Pop the current matrix from it's stack.

  Specified by:

  glPopMatrix in interface GLMatrixFunc

  See Also:

  • GLMatrixFunc.glPushMatrix()

• glPushMatrix

  public final void glPushMatrix()

  Description copied from interface: GLMatrixFunc

  Push the current matrix to it's stack, while preserving it's values.

  There exist one stack per matrix mode, i.e. GLMatrixFunc.GL_MODELVIEW, GLMatrixFunc.GL_PROJECTION and GL_TEXTURE.

  Specified by:

  glPushMatrix in interface GLMatrixFunc

• glLoadIdentity

  public final void glLoadIdentity()

  Description copied from interface: GLMatrixFunc

  Load the current matrix with the identity matrix

  Specified by:

  glLoadIdentity in interface GLMatrixFunc

• glMultMatrixf

  public final void glMultMatrixf(FloatBuffer m)

  Description copied from interface: GLMatrixFunc

  Multiply the current matrix: [c] = [c] x [m]

  Specified by:

  glMultMatrixf in interface GLMatrixFunc

  Parameters:

  m - the FloatBuffer's position remains unchanged, which is the same behavior than the native JOGL GL impl

• glMultMatrixf

  public final void glMultMatrixf(float[] m, int m_offset)

  Description copied from interface: GLMatrixFunc

  Multiply the current matrix: [c] = [c] x [m]

  Specified by:

  glMultMatrixf in interface GLMatrixFunc

• glTranslatef

  public final void glTranslatef(float x, float y, float z)

  Description copied from interface: GLMatrixFunc

  Translate the current matrix.

  Specified by:

  glTranslatef in interface GLMatrixFunc

• glScalef

  public final void glScalef(float x, float y, float z)

  Description copied from interface: GLMatrixFunc

  Scale the current matrix.

  Specified by:

  glScalef in interface GLMatrixFunc

• glRotatef

  public final void glRotatef(float ang_deg, float x, float y, float z)

  Description copied from interface: GLMatrixFunc

  Rotate the current matrix.

  Specified by:

  glRotatef in interface GLMatrixFunc

• glRotate

  public final void glRotate(Quaternion quat)

  Rotate the current matrix with the given Quaternion's rotation matrix representation.

• glOrthof

  public final void glOrthof(float left, float right, float bottom, float top, float zNear, float zFar)

  Description copied from interface: GLMatrixFunc

  Multiply the current matrix with the orthogonal matrix.

  Specified by:

  glOrthof in interface GLMatrixFunc

• glFrustumf

  public final void glFrustumf(float left, float right, float bottom, float top, float zNear, float zFar) throws GLException

  Multiply the current matrix with the frustum matrix.

  Specified by:

  glFrustumf in interface GLMatrixFunc

  Throws:

  GLException - if zNear <= 0 or zFar <= zNear or left == right, or bottom == top.

  See Also:

  • FloatUtil.makeFrustum(float[], int, boolean, float, float, float, float, float, float)

• gluPerspective

  public final void gluPerspective(float fovy_deg, float aspect, float zNear, float zFar) throws GLException

  Multiply the current matrix with the perspective/frustum matrix.

  Parameters:

  fovy_deg - fov angle in degrees

  aspect - aspect ratio width / height

  zNear -

  zFar -

  Throws:

  GLException - if zNear <= 0 or zFar <= zNear

  See Also:

  • FloatUtil.makePerspective(float[], int, boolean, float, float, float, float)

• gluLookAt

  public final void gluLookAt(float eyex, float eyey, float eyez, float centerx, float centery, float centerz, float upx, float upy, float upz)

  Multiply and translate the current matrix with the eye, object and orientation.

• gluProject

  public final boolean gluProject(float objx, float objy, float objz, int[] viewport, int viewport_offset, float[] win_pos, int win_pos_offset)

  Map object coordinates to window coordinates.

  Traditional gluProject implementation.

  Parameters:

  objx -

  objy -

  objz -

  viewport - 4 component viewport vector

  viewport_offset -

  win_pos - 3 component window coordinate, the result

  win_pos_offset -

  Returns:

  true if successful, otherwise false (z is 1)

• gluUnProject

  public final boolean gluUnProject(float winx, float winy, float winz, int[] viewport, int viewport_offset, float[] obj_pos, int obj_pos_offset)

  Map window coordinates to object coordinates.

  Traditional gluUnProject implementation.

  Parameters:

  winx -

  winy -

  winz -

  viewport - 4 component viewport vector

  viewport_offset -

  obj_pos - 3 component object coordinate, the result

  obj_pos_offset -

  Returns:

  true if successful, otherwise false (failed to invert matrix, or becomes infinity due to zero z)

• gluUnProject4

  public boolean gluUnProject4(float winx, float winy, float winz, float clipw, int[] viewport, int viewport_offset, float near, float far, float[] obj_pos, int obj_pos_offset)

  Map window coordinates to object coordinates.

  Traditional gluUnProject4 implementation.

  Parameters:

  winx -

  winy -

  winz -

  clipw -

  modelMatrix - 4x4 modelview matrix

  modelMatrix_offset -

  projMatrix - 4x4 projection matrix

  projMatrix_offset -

  viewport - 4 component viewport vector

  viewport_offset -

  near -

  far -

  obj_pos - 4 component object coordinate, the result

  obj_pos_offset -

  Returns:

  true if successful, otherwise false (failed to invert matrix, or becomes infinity due to zero z)

• gluPickMatrix

  public final void gluPickMatrix(float x, float y, float deltaX, float deltaY, int[] viewport, int viewport_offset)

  Make given matrix the pick matrix based on given parameters.

  Traditional gluPickMatrix implementation.

  See FloatUtil.makePick(..) for details.

  Parameters:

  x - the center x-component of a picking region in window coordinates

  y - the center y-component of a picking region in window coordinates

  deltaX - the width of the picking region in window coordinates.

  deltaY - the height of the picking region in window coordinates.

  viewport - 4 component viewport vector

  viewport_offset -

• gluUnProjectRay

  public final boolean gluUnProjectRay(float winx, float winy, float winz0, float winz1, int[] viewport, int viewport_offset, Ray ray)

  Map two window coordinates w/ shared X/Y and distinctive Z to a Ray. The resulting Ray maybe used for picking using a bounding box.

  Notes for picking winz0 and winz1:

  • see FloatUtil.getZBufferEpsilon(int, float, float)
  • see FloatUtil.getZBufferValue(int, float, float, float)
  • see FloatUtil.getOrthoWinZ(float, float, float)

  Parameters:

  winx -

  winy -

  winz0 -

  winz1 -

  viewport -

  viewport_offset -

  ray - storage for the resulting Ray

  Returns:

  true if successful, otherwise false (failed to invert matrix, or becomes z is infinity)

• toString

  public StringBuilder toString(StringBuilder sb, String f)

• toString

  public String toString()

  Overrides:

  toString in class Object

• getModifiedBits

  public final int getModifiedBits(boolean clear)

  Returns the modified bits due to mutable operations..

  A modified bit is set, if the corresponding matrix had been modified by a mutable operation since last update() or getModifiedBits(true) call.

  Parameters:

  clear - if true, clears the modified bits, otherwise leaves them untouched.

  See Also:

  • MODIFIED_PROJECTION
  • MODIFIED_MODELVIEW
  • MODIFIED_TEXTURE

• getDirtyBits

  public final int getDirtyBits()

  Deprecated.

  Function is exposed for debugging purposes only.

  Returns the dirty bits due to mutable operations.

  A dirty bit is set , if the corresponding matrix had been modified by a mutable operation since last update() call. The latter clears the dirty state only if the dirty matrix (Mvi or Mvit) or Frustum has been requested by one of the Mvi get, Mvit get or Frustum get methods.

  See Also:

  • DIRTY_INVERSE_MODELVIEW
  • DIRTY_INVERSE_TRANSPOSED_MODELVIEW
  • DIRTY_FRUSTUM
  • glGetMviMatrixf()
  • glGetMvitMatrixf()
  • glGetPMvMviMatrixf()
  • glGetPMvMvitMatrixf()
  • glGetFrustum()

• getRequestMask

  public final int getRequestMask()

  Deprecated.

  Function is exposed for debugging purposes only.

  Returns the request bit mask, which uses bit values equal to the dirty mask.

  The request bit mask is set by one of the Mvi get, Mvit get or Frustum get methods.

  See Also:

  • clearAllUpdateRequests()
  • DIRTY_INVERSE_MODELVIEW
  • DIRTY_INVERSE_TRANSPOSED_MODELVIEW
  • DIRTY_FRUSTUM
  • glGetMviMatrixf()
  • glGetMvitMatrixf()
  • glGetPMvMviMatrixf()
  • glGetPMvMvitMatrixf()
  • glGetFrustum()

• clearAllUpdateRequests

  public final void clearAllUpdateRequests()

  Clears all update() requests of the Mvi and Mvit matrix and Frustum after it has been enabled by one of the Mvi get, Mvit get or Frustum get methods.

  Allows user to disable subsequent Mvi, Mvit and Frustum updates if no more required.

  See Also:

  • glGetMviMatrixf()
  • glGetMvitMatrixf()
  • glGetPMvMviMatrixf()
  • glGetPMvMvitMatrixf()
  • glGetFrustum()
  • getRequestMask()

• update

  public final boolean update()

  Update the derived inverse modelview (Mvi), inverse transposed modelview (Mvit) matrices and Frustum if they are dirty and they were requested by one of the Mvi get, Mvit get or Frustum get methods.

  The Mvi and Mvit matrices and Frustum are considered dirty, if their corresponding Mv matrix has been modified since their last update.

  Method should be called manually in case mutable operations has been called and caller operates on already fetched references, i.e. not calling Mvi get, Mvit get or Frustum get etc anymore.

  This method clears the modified bits like getModifiedBits(true), which are set by any mutable operation. The modified bits have no impact on this method, but the return value.

  Returns:

  true if any matrix has been modified since last update call or if the derived matrices Mvi and Mvit or Frustum were updated, otherwise false. In other words, method returns true if any matrix used by the caller must be updated, e.g. uniforms in a shader program.

  See Also:

  • getModifiedBits(boolean)
  • MODIFIED_PROJECTION
  • MODIFIED_MODELVIEW
  • MODIFIED_TEXTURE
  • DIRTY_INVERSE_MODELVIEW
  • DIRTY_INVERSE_TRANSPOSED_MODELVIEW
  • DIRTY_FRUSTUM
  • glGetMviMatrixf()
  • glGetMvitMatrixf()
  • glGetPMvMviMatrixf()
  • glGetPMvMvitMatrixf()
  • glGetFrustum()
  • clearAllUpdateRequests()