Module org.praxislive.libp5x.core

Package processing.core

Class PMatrix3D

java.lang.Object

processing.core.PMatrix3D

All Implemented Interfaces:

PMatrix

public final class PMatrix3D
extends Object
implements PMatrix

4x4 matrix implementation. Matrices are used to describe a transformation; see PMatrix for a general description. This matrix looks like the following when multiplying a vector (x, y, z, w) in mult().

 [m00 m01 m02 m03][x]   [m00*x + m01*y + m02*z + m03*w]   [x']
 [m10 m11 m12 m13][y] = [m10*x + m11*y + m12*z + m13*w] = [y']
 [m20 m21 m22 m23][z]   [m20*x + m21*y + m22*z + m23*w]   [z']
 [m30 m31 m32 m33][w]   [m30*x + m31*y + m32*z + m33*w]   [w']

(x', y', z', w') is returned. The values in the matrix determine the transformation. They are modified by the various transformation functions. To transform 3D coordinates, w is set to 1, amd w' is made to be 1 by setting the bottom row of the matrix to [0 0 0 1]. The resulting point is then (x', y', z').

Field Summary

Fields

Modifier and Type	Field	Description
protected PMatrix3D	inverseCopy
float	m00
float	m01
float	m02
float	m03
float	m10
float	m11
float	m12
float	m13
float	m20
float	m21
float	m22
float	m23
float	m30
float	m31
float	m32
float	m33

Constructor Summary

Constructors

Constructor	Description
PMatrix3D()
PMatrix3D(float m00, float m01, float m02, float m10, float m11, float m12)
PMatrix3D(float m00, float m01, float m02, float m03, float m10, float m11, float m12, float m13, float m20, float m21, float m22, float m23, float m30, float m31, float m32, float m33)
PMatrix3D(PMatrix matrix)

Method Summary

Modifier and Type	Method	Description
void	apply(float n00, float n01, float n02, float n10, float n11, float n12)	Multiply this matrix by another.
void	apply(float n00, float n01, float n02, float n03, float n10, float n11, float n12, float n13, float n20, float n21, float n22, float n23, float n30, float n31, float n32, float n33)	Multiply this matrix by another.
void	apply(PMatrix source)	Multiply this matrix by another.
void	apply(PMatrix2D source)	Multiply this matrix by another.
void	apply(PMatrix3D source)	Multiply this matrix by another.
float	determinant()
PMatrix3D	get()	Returns a copy of this PMatrix.
float[]	get(float[] target)	Copies the matrix contents into a 16 entry float array.
protected boolean	invApply(float n00, float n01, float n02, float n03, float n10, float n11, float n12, float n13, float n20, float n21, float n22, float n23, float n30, float n31, float n32, float n33)
boolean	invert()	Invert this matrix.
protected void	invRotate(float angle, float v0, float v1, float v2)
protected void	invRotateX(float angle)
protected void	invRotateY(float angle)
protected void	invRotateZ(float angle)
protected void	invScale(float x, float y, float z)
protected void	invTranslate(float tx, float ty, float tz)
float[]	mult(float[] source, float[] target)	Multiply a three or four element vector against this matrix.
PVector	mult(PVector source, PVector target)	Multiply source by this matrix, and return the result.
float	multW(float x, float y, float z)	Returns the fourth element of the result of multiplying the vector (x, y, z) by this matrix.
float	multW(float x, float y, float z, float w)	Returns the w-coordinate of the result of multiplying the vector (x, y, z, w) by this matrix.
float	multX(float x, float y)	Returns the x-coordinate of the result of multiplying the point (x, y) by this matrix.
float	multX(float x, float y, float z)	Returns the x-coordinate of the result of multiplying the point (x, y, z) by this matrix.
float	multX(float x, float y, float z, float w)	Returns the x-coordinate of the result of multiplying the vector (x, y, z, w) by this matrix.
float	multY(float x, float y)	Returns the y-coordinate of the result of multiplying the point (x, y) by this matrix.
float	multY(float x, float y, float z)	Returns the y-coordinate of the result of multiplying the point (x, y, z) by this matrix.
float	multY(float x, float y, float z, float w)	Returns the y-coordinate of the result of multiplying the vector (x, y, z, w) by this matrix.
float	multZ(float x, float y, float z)	Returns the z-coordinate of the result of multiplying the point (x, y, z) by this matrix.
float	multZ(float x, float y, float z, float w)	Returns the z-coordinate of the result of multiplying the vector (x, y, z, w) by this matrix.
void	preApply(float n00, float n01, float n02, float n10, float n11, float n12)	Apply the 3D equivalent of the 2D matrix supplied to the left of this one.
void	preApply(float n00, float n01, float n02, float n03, float n10, float n11, float n12, float n13, float n20, float n21, float n22, float n23, float n30, float n31, float n32, float n33)	Apply another matrix to the left of this one.
void	preApply(PMatrix source)	Apply another matrix to the left of this one.
void	preApply(PMatrix2D left)	Apply the 3D equivalent of the 2D matrix supplied to the left of this one.
void	preApply(PMatrix3D left)	Apply another matrix to the left of this one.
void	print()
void	reset()	Make this an identity matrix.
void	rotate(float angle)
void	rotate(float angle, float v0, float v1, float v2)
void	rotateX(float angle)
void	rotateY(float angle)
void	rotateZ(float angle)
void	scale(float s)
void	scale(float sx, float sy)
void	scale(float x, float y, float z)
void	set(float[] source)	Set the contents of this matrix to the contents of source.
void	set(float m00, float m01, float m02, float m10, float m11, float m12)	Set the matrix content to this 2D matrix or its 3D equivalent.
void	set(float m00, float m01, float m02, float m03, float m10, float m11, float m12, float m13, float m20, float m21, float m22, float m23, float m30, float m31, float m32, float m33)	Set the matrix content to the 3D matrix supplied, if this matrix is 3D.
void	set(PMatrix matrix)	Make this matrix become a copy of src.
void	shearX(float angle)
void	shearY(float angle)
void	translate(float tx, float ty)
void	translate(float tx, float ty, float tz)
void	transpose()	Transpose this matrix; rows become columns and columns rows.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m00

public float m00

m01

public float m01

m02

public float m02

m03

public float m03

m10

public float m10

m11

public float m11

m12

public float m12

m13

public float m13

m20

public float m20

m21

public float m21

m22

public float m22

m23

public float m23

m30

public float m30

m31

public float m31

m32

public float m32

m33

public float m33

inverseCopy

protected PMatrix3D inverseCopy

Constructor Detail

PMatrix3D

public PMatrix3D()

PMatrix3D

public PMatrix3D(float m00,
                 float m01,
                 float m02,
                 float m10,
                 float m11,
                 float m12)

PMatrix3D

public PMatrix3D(float m00,
                 float m01,
                 float m02,
                 float m03,
                 float m10,
                 float m11,
                 float m12,
                 float m13,
                 float m20,
                 float m21,
                 float m22,
                 float m23,
                 float m30,
                 float m31,
                 float m32,
                 float m33)

PMatrix3D

public PMatrix3D(PMatrix matrix)

Method Detail

reset

public void reset()

Description copied from interface: PMatrix

Make this an identity matrix. Multiplying by it will have no effect.

Specified by:

reset in interface PMatrix

get

public PMatrix3D get()

Returns a copy of this PMatrix.

Specified by:

get in interface PMatrix

get

public float[] get(float[] target)

Copies the matrix contents into a 16 entry float array. If target is null (or not the correct size), a new array will be created.

Specified by:

get in interface PMatrix

set

public void set(PMatrix matrix)

Description copied from interface: PMatrix

Make this matrix become a copy of src.

Specified by:

set in interface PMatrix

set

public void set(float[] source)

Description copied from interface: PMatrix

Set the contents of this matrix to the contents of source. Fills the matrix left-to-right, starting in the top row.

Specified by:

set in interface PMatrix

set

public void set(float m00,
                float m01,
                float m02,
                float m10,
                float m11,
                float m12)

Description copied from interface: PMatrix

Set the matrix content to this 2D matrix or its 3D equivalent.

Specified by:

set in interface PMatrix

set

public void set(float m00,
                float m01,
                float m02,
                float m03,
                float m10,
                float m11,
                float m12,
                float m13,
                float m20,
                float m21,
                float m22,
                float m23,
                float m30,
                float m31,
                float m32,
                float m33)

Description copied from interface: PMatrix

Set the matrix content to the 3D matrix supplied, if this matrix is 3D.

Specified by:

set in interface PMatrix

translate

public void translate(float tx,
                      float ty)

Specified by:

translate in interface PMatrix

translate

public void translate(float tx,
                      float ty,
                      float tz)

Specified by:

translate in interface PMatrix

rotate

public void rotate(float angle)

Specified by:

rotate in interface PMatrix

rotateX

public void rotateX(float angle)

Specified by:

rotateX in interface PMatrix

rotateY

public void rotateY(float angle)

Specified by:

rotateY in interface PMatrix

rotateZ

public void rotateZ(float angle)

Specified by:

rotateZ in interface PMatrix

rotate

public void rotate(float angle,
                   float v0,
                   float v1,
                   float v2)

Specified by:

rotate in interface PMatrix

scale

public void scale(float s)

Specified by:

scale in interface PMatrix

scale

public void scale(float sx,
                  float sy)

Specified by:

scale in interface PMatrix

scale

public void scale(float x,
                  float y,
                  float z)

Specified by:

scale in interface PMatrix

shearX

public void shearX(float angle)

Specified by:

shearX in interface PMatrix

shearY

public void shearY(float angle)

Specified by:

shearY in interface PMatrix

apply

public void apply(PMatrix source)

Description copied from interface: PMatrix

Multiply this matrix by another.

Specified by:

apply in interface PMatrix

apply

public void apply(PMatrix2D source)

Description copied from interface: PMatrix

Multiply this matrix by another.

Specified by:

apply in interface PMatrix

apply

public void apply(PMatrix3D source)

Description copied from interface: PMatrix

Multiply this matrix by another.

Specified by:

apply in interface PMatrix

apply

public void apply(float n00,
                  float n01,
                  float n02,
                  float n10,
                  float n11,
                  float n12)

Description copied from interface: PMatrix

Multiply this matrix by another.

Specified by:

apply in interface PMatrix

apply

public void apply(float n00,
                  float n01,
                  float n02,
                  float n03,
                  float n10,
                  float n11,
                  float n12,
                  float n13,
                  float n20,
                  float n21,
                  float n22,
                  float n23,
                  float n30,
                  float n31,
                  float n32,
                  float n33)

Description copied from interface: PMatrix

Multiply this matrix by another.

Specified by:

apply in interface PMatrix

preApply

public void preApply(PMatrix2D left)

Apply the 3D equivalent of the 2D matrix supplied to the left of this one.

Specified by:

preApply in interface PMatrix

preApply

public void preApply(PMatrix source)

Apply another matrix to the left of this one.

Specified by:

preApply in interface PMatrix

preApply

public void preApply(PMatrix3D left)

Apply another matrix to the left of this one.

Specified by:

preApply in interface PMatrix

preApply

public void preApply(float n00,
                     float n01,
                     float n02,
                     float n10,
                     float n11,
                     float n12)

Apply the 3D equivalent of the 2D matrix supplied to the left of this one.

Specified by:

preApply in interface PMatrix

preApply

public void preApply(float n00,
                     float n01,
                     float n02,
                     float n03,
                     float n10,
                     float n11,
                     float n12,
                     float n13,
                     float n20,
                     float n21,
                     float n22,
                     float n23,
                     float n30,
                     float n31,
                     float n32,
                     float n33)

Apply another matrix to the left of this one.

Specified by:

preApply in interface PMatrix

mult

public PVector mult(PVector source,
                    PVector target)

Multiply source by this matrix, and return the result. The result will be stored in target if target is non-null, and target will then be the matrix returned. This improves performance if you reuse target, so it's recommended if you call this many times in draw().

Specified by:

mult in interface PMatrix

mult

public float[] mult(float[] source,
                    float[] target)

Multiply a three or four element vector against this matrix. If out is null or not length 3 or 4, a new float array (length 3) will be returned. Supplying and recycling a target array improves performance, so it's recommended if you call this many times in draw.

Specified by:

mult in interface PMatrix

multX

public float multX(float x,
                   float y)

Returns the x-coordinate of the result of multiplying the point (x, y) by this matrix.

multY

public float multY(float x,
                   float y)

Returns the y-coordinate of the result of multiplying the point (x, y) by this matrix.

multX

public float multX(float x,
                   float y,
                   float z)

Returns the x-coordinate of the result of multiplying the point (x, y, z) by this matrix.

multY

public float multY(float x,
                   float y,
                   float z)

Returns the y-coordinate of the result of multiplying the point (x, y, z) by this matrix.

multZ

public float multZ(float x,
                   float y,
                   float z)

Returns the z-coordinate of the result of multiplying the point (x, y, z) by this matrix.

multW

public float multW(float x,
                   float y,
                   float z)

Returns the fourth element of the result of multiplying the vector (x, y, z) by this matrix. (Acts as if w = 1 was supplied.)

multX

public float multX(float x,
                   float y,
                   float z,
                   float w)

Returns the x-coordinate of the result of multiplying the vector (x, y, z, w) by this matrix.

multY

public float multY(float x,
                   float y,
                   float z,
                   float w)

Returns the y-coordinate of the result of multiplying the vector (x, y, z, w) by this matrix.

multZ

public float multZ(float x,
                   float y,
                   float z,
                   float w)

Returns the z-coordinate of the result of multiplying the vector (x, y, z, w) by this matrix.

multW

public float multW(float x,
                   float y,
                   float z,
                   float w)

Returns the w-coordinate of the result of multiplying the vector (x, y, z, w) by this matrix.

transpose

public void transpose()

Transpose this matrix; rows become columns and columns rows.

Specified by:

transpose in interface PMatrix

invert

public boolean invert()

Invert this matrix. Will not necessarily succeed, because some matrices map more than one point to the same image point, and so are irreversible.

Specified by:

invert in interface PMatrix

Returns:

true if successful

determinant

public float determinant()

Specified by:

determinant in interface PMatrix

Returns:

the determinant of the matrix

invTranslate

protected void invTranslate(float tx,
                            float ty,
                            float tz)

invRotateX

protected void invRotateX(float angle)

invRotateY

protected void invRotateY(float angle)

invRotateZ

protected void invRotateZ(float angle)

invRotate

protected void invRotate(float angle,
                         float v0,
                         float v1,
                         float v2)

invScale

protected void invScale(float x,
                        float y,
                        float z)

invApply

protected boolean invApply(float n00,
                           float n01,
                           float n02,
                           float n03,
                           float n10,
                           float n11,
                           float n12,
                           float n13,
                           float n20,
                           float n21,
                           float n22,
                           float n23,
                           float n30,
                           float n31,
                           float n32,
                           float n33)

print

public void print()