Matrix44

Matrix44

Matrix44()

The default Matrix44 constructor will instantiate an identity matrix.

Matrix44

Matrix44(mat: Matrix)

Creates and returns a Matrix44 by taking the 3x3 Matrix and placing it on the 0 of the z-axis by setting row 2 and column 2 to the identity as seen in the following operation:

[ a b c ]      [ a b 0 c ]
  [ d e f ]  ->  [ d e 0 f ]
  [ g h i ]      [ 0 0 1 0 ]
                 [ g h 0 i ]
  

concat

open fun concat(b: Matrix44): Matrix44

Multiplies `this` matrix (A) and provided Matrix (B) in the order of A * B. The result is saved in `this` Matrix.

equals

open fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

get

open fun get(
    row: Int, 
    col: Int
): Float

Gets the value at the matrix's row and column.

getValues

open fun getValues(dst: FloatArray): Unit

Copies matrix values into the provided array in row-major order.

hashCode

open fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

invert

open fun invert(): Boolean

Inverts the Matrix44, then return true if successful, false if unable to invert.

isIdentity

open fun isIdentity(): Boolean

Returns true if Matrix44 is equal to identity matrix.

map

open fun map(
    x: Float, 
    y: Float, 
    z: Float, 
    w: Float
): FloatArray

Multiplies (x, y, z, w) vector by the Matrix44, then returns the new (x, y, z, w). Users should set w to 1 to indicate the coordinates are normalized.

map

open fun map(
    x: Float, 
    y: Float, 
    z: Float, 
    w: Float, 
    dst: FloatArray
): Unit

Multiplies (x, y, z, w) vector by the Matrix44, then returns the new (x, y, z, w). Users should set w to 1 to indicate the coordinates are normalized.

reset

open fun reset(): Unit

Sets the Matrix44 to the identity matrix.

rotate

open fun rotate(
    deg: Float, 
    xComp: Float, 
    yComp: Float, 
    zComp: Float
): Matrix44

Applies a rotation around a given axis, then returns self. x, y, z represent the axis by which to rotate around. For example, pass in 1, 0, 0 to rotate around the x-axis. The axis provided will be normalized.

scale

open fun scale(
    x: Float, 
    y: Float, 
    z: Float
): Matrix44

Applies scaling factors to `this` Matrix44, then returns self. Pass 1s for no change.

set

open fun set(
    row: Int, 
    col: Int, 
    val: Float
): Unit

Sets the value at the matrix's row and column to the provided value.

setValues

open fun setValues(src: FloatArray): Unit

Replaces the Matrix's values with the values in the provided array.

toString

open fun toString(): String

Returns a string representation of the object.

translate

open fun translate(
    x: Float, 
    y: Float, 
    z: Float
): Matrix44

Applies a translation to `this` Matrix44, then returns self.