MatrixNf (Flow Math 1.0.3 API)

java.lang.Object
- com.flowpowered.math.matrix.MatrixNf

All Implemented Interfaces:: Matrixf, Serializable, Cloneable

public class MatrixNf
extends Object
implements Matrixf, Serializable, Cloneable

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static MatrixNf IDENTITY_2

static MatrixNf IDENTITY_3

static MatrixNf IDENTITY_4

Fields
Modifier and Type	Field and Description
`static MatrixNf`	`IDENTITY_2`
`static MatrixNf`	`IDENTITY_3`
`static MatrixNf`	`IDENTITY_4`

Constructor Summary

Constructors
Constructor and Description

MatrixNf(float... m)

MatrixNf(int size)

MatrixNf(Matrix2f m)

MatrixNf(Matrix3f m)

MatrixNf(Matrix4f m)

MatrixNf(MatrixNf m)

Constructors
Constructor and Description
`MatrixNf(float... m)`
`MatrixNf(int size)`
`MatrixNf(Matrix2f m)`
`MatrixNf(Matrix3f m)`
`MatrixNf(Matrix4f m)`
`MatrixNf(MatrixNf m)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MatrixNf`	`abs()`
`MatrixNf`	`add(MatrixNf m)`
`MatrixNf`	`ceil()`
`MatrixNf`	`clone()`
`static MatrixNf`	`createLookAt(int size, Vector3f eye, Vector3f at, Vector3f up)` Creates a "look at" matrix for the given eye point.
`static MatrixNf`	`createOrthographic(int size, double right, double left, double top, double bottom, double near, double far)` Creates an orthographic viewing frustum built from the provided values
`static MatrixNf`	`createOrthographic(int size, float right, float left, float top, float bottom, float near, float far)` Creates an orthographic viewing frustum built from the provided values
`static MatrixNf`	`createPerspective(int size, double fov, double aspect, double near, double far)` Creates a perspective projection matrix with the given (x) FOV, aspect, near and far planes
`static MatrixNf`	`createPerspective(int size, float fov, float aspect, float near, float far)` Creates a perspective projection matrix with the given (x) FOV, aspect, near and far planes
`static MatrixNf`	`createRotation(int size, Complexf rot)`
`static MatrixNf`	`createRotation(int size, Quaternionf rot)`
`static MatrixNf`	`createScaling(float... vec)`
`static MatrixNf`	`createScaling(VectorNf v)`
`static MatrixNf`	`createTranslation(float... vec)`
`static MatrixNf`	`createTranslation(VectorNf v)`
`float`	`determinant()`
`MatrixNf`	`div(double a)`
`MatrixNf`	`div(float a)`
`MatrixNf`	`div(MatrixNf m)`
`boolean`	`equals(Object obj)`
`MatrixNf`	`floor()`
`float`	`get(int row, int col)`
`VectorNf`	`getColumn(int col)`
`VectorNf`	`getRow(int row)`
`int`	`hashCode()`
`MatrixNf`	`invert()`
`MatrixNf`	`mul(double a)`
`MatrixNf`	`mul(float a)`
`MatrixNf`	`mul(MatrixNf m)`
`MatrixNf`	`negate()`
`MatrixNf`	`pow(double pow)`
`MatrixNf`	`pow(float pow)`
`MatrixNf`	`resize(int size)`
`MatrixNf`	`rotate(Complexf rot)`
`MatrixNf`	`rotate(Quaternionf rot)`
`MatrixNf`	`round()`
`MatrixNf`	`scale(float... v)`
`MatrixNf`	`scale(VectorNf v)`
`void`	`set(int row, int col, double val)`
`void`	`set(int row, int col, float val)`
`void`	`setIdentity()`
`void`	`setZero()`
`int`	`size()`
`MatrixNf`	`sub(MatrixNf m)`
`float[]`	`toArray()`
`float[]`	`toArray(boolean columnMajor)`
`MatrixNd`	`toDouble()`
`MatrixNf`	`toFloat()`
`Matrix2f`	`toMatrix2()`
`Matrix3f`	`toMatrix3()`
`Matrix4f`	`toMatrix4()`
`String`	`toString()`
`float`	`trace()`
`VectorNf`	`transform(float... vec)`
`VectorNf`	`transform(VectorNf v)`
`MatrixNf`	`translate(float... v)`
`MatrixNf`	`translate(VectorNf v)`
`MatrixNf`	`transpose()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

IDENTITY_2

public static final MatrixNf IDENTITY_2

IDENTITY_3

public static final MatrixNf IDENTITY_3

IDENTITY_4

public static final MatrixNf IDENTITY_4

Constructor Detail

MatrixNf
```
public MatrixNf(int size)
```

MatrixNf
```
public MatrixNf(Matrix2f m)
```

MatrixNf
```
public MatrixNf(Matrix3f m)
```

MatrixNf
```
public MatrixNf(Matrix4f m)
```

MatrixNf
```
public MatrixNf(float... m)
```

MatrixNf
```
public MatrixNf(MatrixNf m)
```

Method Detail

size
```
public int size()
```

get

public float get(int row,
                 int col)

Specified by:: get in interface Matrixf

getRow
```
public VectorNf getRow(int row)
```
Specified by:

getRow in interface Matrixf

getColumn
```
public VectorNf getColumn(int col)
```
Specified by:

getColumn in interface Matrixf

set

public void set(int row,
                int col,
                double val)

set

public void set(int row,
                int col,
                float val)

setIdentity
```
public final void setIdentity()
```

setZero
```
public void setZero()
```

resize
```
public MatrixNf resize(int size)
```

add
```
public MatrixNf add(MatrixNf m)
```

sub
```
public MatrixNf sub(MatrixNf m)
```

mul
```
public MatrixNf mul(double a)
```

mul
```
public MatrixNf mul(float a)
```
Specified by:

mul in interface Matrixf

mul
```
public MatrixNf mul(MatrixNf m)
```

div
```
public MatrixNf div(double a)
```

div
```
public MatrixNf div(float a)
```
Specified by:

div in interface Matrixf

div
```
public MatrixNf div(MatrixNf m)
```

pow
```
public MatrixNf pow(double pow)
```

pow
```
public MatrixNf pow(float pow)
```
Specified by:

pow in interface Matrixf

translate

public MatrixNf translate(VectorNf v)

translate

public MatrixNf translate(float... v)

scale
```
public MatrixNf scale(VectorNf v)
```

scale
```
public MatrixNf scale(float... v)
```

rotate
```
public MatrixNf rotate(Complexf rot)
```

rotate

public MatrixNf rotate(Quaternionf rot)

transform

public VectorNf transform(VectorNf v)

transform

public VectorNf transform(float... vec)

floor
```
public MatrixNf floor()
```
Specified by:

floor in interface Matrixf

ceil
```
public MatrixNf ceil()
```
Specified by:

ceil in interface Matrixf

round
```
public MatrixNf round()
```
Specified by:

round in interface Matrixf

abs
```
public MatrixNf abs()
```
Specified by:

abs in interface Matrixf

negate
```
public MatrixNf negate()
```
Specified by:

negate in interface Matrixf

transpose
```
public MatrixNf transpose()
```
Specified by:

transpose in interface Matrixf

trace
```
public float trace()
```
Specified by:

trace in interface Matrixf

determinant
```
public float determinant()
```
Specified by:

determinant in interface Matrixf

invert
```
public MatrixNf invert()
```
Specified by:

invert in interface Matrixf

toMatrix2
```
public Matrix2f toMatrix2()
```

toMatrix3
```
public Matrix3f toMatrix3()
```

toMatrix4
```
public Matrix4f toMatrix4()
```

toArray
```
public float[] toArray()
```

toFloat
```
public MatrixNf toFloat()
```
Specified by:

toFloat in interface Matrixf

toDouble
```
public MatrixNd toDouble()
```
Specified by:

toDouble in interface Matrixf

toArray

public float[] toArray(boolean columnMajor)

Specified by:: toArray in interface Matrixf

toString
```
public String toString()
```
Overrides:

toString in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

clone
```
public MatrixNf clone()
```
Overrides:

clone in class Object

createScaling

public static MatrixNf createScaling(VectorNf v)

createScaling

public static MatrixNf createScaling(float... vec)

createTranslation

public static MatrixNf createTranslation(VectorNf v)

createTranslation

public static MatrixNf createTranslation(float... vec)

createRotation

public static MatrixNf createRotation(int size,
                                      Complexf rot)

createRotation

public static MatrixNf createRotation(int size,
                                      Quaternionf rot)

createLookAt

public static MatrixNf createLookAt(int size,
                                    Vector3f eye,
                                    Vector3f at,
                                    Vector3f up)

Creates a "look at" matrix for the given eye point.

Parameters:: size - The size of the matrix, minimum of 4; eye - The position of the camera; at - The point that the camera is looking at; up - The "up" vector
Returns:: A rotational transform that corresponds to a camera looking at the given point

createPerspective
```
public static MatrixNf createPerspective(int size,
                                         double fov,
                                         double aspect,
                                         double near,
                                         double far)
```
Creates a perspective projection matrix with the given (x) FOV, aspect, near and far planes

Parameters:

size - The size of the matrix, minimum of 4

fov - The field of view in the x direction

aspect - The aspect ratio, usually width/height

near - The near plane, cannot be 0

far - the far plane, zFar cannot equal zNear

Returns:

A perspective projection matrix built from the given values

createPerspective
```
public static MatrixNf createPerspective(int size,
                                         float fov,
                                         float aspect,
                                         float near,
                                         float far)
```
Creates a perspective projection matrix with the given (x) FOV, aspect, near and far planes

Parameters:

size - The size of the matrix, minimum of 4

fov - The field of view in the x direction

aspect - The aspect ratio, usually width/height

near - The near plane, cannot be 0

far - the far plane, zFar cannot equal zNear

Returns:

A perspective projection matrix built from the given values

createOrthographic
```
public static MatrixNf createOrthographic(int size,
                                          double right,
                                          double left,
                                          double top,
                                          double bottom,
                                          double near,
                                          double far)
```
Creates an orthographic viewing frustum built from the provided values

Parameters:

size - The size of the matrix, minimum of 4

right - the right most plane of the viewing frustum

left - the left most plane of the viewing frustum

top - the top plane of the viewing frustum

bottom - the bottom plane of the viewing frustum

near - the near plane of the viewing frustum

far - the far plane of the viewing frustum

Returns:

A viewing frustum built from the provided values

createOrthographic
```
public static MatrixNf createOrthographic(int size,
                                          float right,
                                          float left,
                                          float top,
                                          float bottom,
                                          float near,
                                          float far)
```
Creates an orthographic viewing frustum built from the provided values

Parameters:

size - The size of the matrix, minimum of 4

right - the right most plane of the viewing frustum

left - the left most plane of the viewing frustum

top - the top plane of the viewing frustum

bottom - the bottom plane of the viewing frustum

near - the near plane of the viewing frustum

far - the far plane of the viewing frustum

Returns:

A viewing frustum built from the provided values

Class MatrixNf

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IDENTITY_2

IDENTITY_3

IDENTITY_4

Constructor Detail

MatrixNf

MatrixNf

MatrixNf

MatrixNf

MatrixNf

MatrixNf

Method Detail

size

get

getRow

getColumn

set

set

setIdentity

setZero

resize

add

sub

mul

mul

mul

div

div

div

pow

pow

translate

translate

scale

scale

rotate

rotate

transform

transform

floor

ceil

round

abs

negate

transpose

trace

determinant

invert

toMatrix2

toMatrix3

toMatrix4

toArray

toFloat

toDouble

toArray

toString

equals

hashCode

clone

createScaling

createScaling

createTranslation

createTranslation

createRotation

createRotation

createLookAt

createPerspective

createPerspective

createOrthographic

createOrthographic