Matrix

Artifact: androidx.compose.ui:ui-graphics

View Source

Added in 1.0.0

Common/AllAndroid/JVM

• Cmn

  value class Matrix

---

Summary

Constants
const Int	Perspective0 = 3 Index of the flattened array that represents the perspective factor along the X axis	Cmn
const Int	Perspective1 = 7 Index of the flattened array that represents the perspective factor along the Y axis	Cmn
const Int	Perspective2 = 15 Index of the flattened array that represents the perspective factor along the Z axis	Cmn
const Int	ScaleX = 0 Index of the flattened array that represents the scale factor along the X axis	Cmn
const Int	ScaleY = 5 Index of the flattened array that represents the scale factor along the Y axis	Cmn
const Int	ScaleZ = 10 Index of the flattened array that represents the scale factor along the Z axis	Cmn
const Int	SkewX = 4 Index of the flattened array that represents the skew factor along the X axis	Cmn
const Int	SkewY = 1 Index of the flattened array that represents the skew factor along the Y axis	Cmn
const Int	TranslateX = 12 Index of the flattened array that represents the translation along the X axis	Cmn
const Int	TranslateY = 13 Index of the flattened array that represents the translation along the Y axis	Cmn
const Int	TranslateZ = 14 Index of the flattened array that represents the translation along the Z axis	Cmn

Public constructors
Matrix(values: FloatArray)	Cmn

Public functions
inline operator Float	get(row: Int, column: Int)	Cmn
Unit	invert() Invert this Matrix.	Cmn
Offset	map(point: Offset) Does the 3D transform on point and returns the x and y values in an Offset.	Cmn
Unit	map(rect: MutableRect) Does a 3D transform on rect, transforming rect with the results.	Cmn
Rect	map(rect: Rect) Does a 3D transform on rect and returns its bounds after the transform.	Cmn
Unit	reset() Resets the this to the identity matrix.	Cmn
Unit	resetToPivotedTransform(     pivotX: Float,     pivotY: Float,     translationX: Float,     translationY: Float,     translationZ: Float,     rotationX: Float,     rotationY: Float,     rotationZ: Float,     scaleX: Float,     scaleY: Float,     scaleZ: Float ) Resets this matrix to a "TRS" (translation, rotation, scale) transform around a pivot point.	Cmn
Unit	rotateX(degrees: Float) Applies a degrees rotation around X to this.	Cmn
Unit	rotateY(degrees: Float) Applies a degrees rotation around Y to this.	Cmn
Unit	rotateZ(degrees: Float) Applies a degrees rotation around Z to this.	Cmn
Unit	scale(x: Float, y: Float, z: Float) Scale this matrix by x, y, z	Cmn
inline operator Unit	set(row: Int, column: Int, v: Float)	Cmn
Unit	setFrom(matrix: Matrix) Sets the entire matrix to the matrix in matrix.	Cmn
operator Unit	timesAssign(m: Matrix) Multiply this matrix by m and assign the result to this matrix.	Cmn
open String	toString()	Cmn
Unit	translate(x: Float, y: Float, z: Float) Translate this matrix by x, y, z	Cmn

Public properties
FloatArray	values	Cmn

Extension functions
Unit	Matrix.setFrom(matrix: Matrix) Set the matrix values the native android.graphics.Matrix.	android
Boolean	Matrix.isIdentity() Whether the given matrix is the identity matrix.	Cmn

Constants

Perspective0

Cmn

const val Perspective0 = 3: Int

Index of the flattened array that represents the perspective factor along the X axis

Perspective1

Cmn

const val Perspective1 = 7: Int

Index of the flattened array that represents the perspective factor along the Y axis

Perspective2

Cmn

const val Perspective2 = 15: Int

Index of the flattened array that represents the perspective factor along the Z axis

ScaleX

Cmn

const val ScaleX = 0: Int

Index of the flattened array that represents the scale factor along the X axis

ScaleY

Cmn

const val ScaleY = 5: Int

Index of the flattened array that represents the scale factor along the Y axis

ScaleZ

Cmn

const val ScaleZ = 10: Int

Index of the flattened array that represents the scale factor along the Z axis

SkewX

Cmn

const val SkewX = 4: Int

Index of the flattened array that represents the skew factor along the X axis

SkewY

Cmn

const val SkewY = 1: Int

Index of the flattened array that represents the skew factor along the Y axis

TranslateX

Cmn

const val TranslateX = 12: Int

Index of the flattened array that represents the translation along the X axis

TranslateY

Cmn

const val TranslateY = 13: Int

Index of the flattened array that represents the translation along the Y axis

TranslateZ

Cmn

const val TranslateZ = 14: Int

Index of the flattened array that represents the translation along the Z axis

Public constructors

Matrix

Cmn

Added in 1.2.0

Matrix(
    values: FloatArray = floatArrayOf(1f, 0f, 0f, 0f, 0f, 1f, 0f, 0f, 0f, 0f, 1f, 0f, 0f, 0f, 0f, 1f)
)

Public functions

get

Cmn

Added in 1.1.0

inline operator fun get(row: Int, column: Int): Float

invert

Cmn

Added in 1.2.0

fun invert(): Unit

Invert this Matrix.

map

Cmn

fun map(point: Offset): Offset

Does the 3D transform on point and returns the x and y values in an Offset.

map

Cmn

Added in 1.2.0

fun map(rect: MutableRect): Unit

Does a 3D transform on rect, transforming rect with the results.

map

Cmn

Added in 1.2.0

fun map(rect: Rect): Rect

Does a 3D transform on rect and returns its bounds after the transform.

reset

Cmn

Added in 1.2.0

fun reset(): Unit

Resets the this to the identity matrix.

resetToPivotedTransform

Cmn

Added in 1.8.0

fun resetToPivotedTransform(
    pivotX: Float = 0.0f,
    pivotY: Float = 0.0f,
    translationX: Float = 0.0f,
    translationY: Float = 0.0f,
    translationZ: Float = 0.0f,
    rotationX: Float = 0.0f,
    rotationY: Float = 0.0f,
    rotationZ: Float = 0.0f,
    scaleX: Float = 1.0f,
    scaleY: Float = 1.0f,
    scaleZ: Float = 1.0f
): Unit

Resets this matrix to a "TRS" (translation, rotation, scale) transform around a pivot point. The transform operations encoded in the matrix are the following, in this specific order:

• A translation by -pivotX, -pivotY

• A translation by translationX, translationY, and translationZ

• An X rotation by rotationX

• A Y rotation by rotationY

• A Z rotation by rotationZ

• A scale by scaleX and scaleY

• A translation by pivotX, pivotY

Calling this method is equivalent to the following code:

val m: Matrix ...
m.reset()
m.translate(-pivotX, -pivotY)
m *= Matrix().apply {
    translate(translationX, translationY)
    rotateX(rotationX)
    rotateY(rotationY)
    rotateZ(rotationZ)
    scale(scaleX, scaleY)
}
m *= Matrix().apply { translate(pivotX, pivotY) }

rotateX

Cmn

Added in 1.2.0

fun rotateX(degrees: Float): Unit

Applies a degrees rotation around X to this.

rotateY

Cmn

Added in 1.2.0

fun rotateY(degrees: Float): Unit

Applies a degrees rotation around Y to this.

rotateZ

Cmn

Added in 1.2.0

fun rotateZ(degrees: Float): Unit

Applies a degrees rotation around Z to this.

scale

Cmn

Added in 1.2.0

fun scale(x: Float = 1.0f, y: Float = 1.0f, z: Float = 1.0f): Unit

Scale this matrix by x, y, z

set

Cmn

Added in 1.1.0

inline operator fun set(row: Int, column: Int, v: Float): Unit

setFrom

Cmn

fun setFrom(matrix: Matrix): Unit

Sets the entire matrix to the matrix in matrix.

timesAssign

Cmn

operator fun timesAssign(m: Matrix): Unit

Multiply this matrix by m and assign the result to this matrix.

toString

Cmn

open fun toString(): String

translate

Cmn

Added in 1.2.0

fun translate(x: Float = 0.0f, y: Float = 0.0f, z: Float = 0.0f): Unit

Translate this matrix by x, y, z

Public properties

values

Cmn

Added in 1.0.0

val values: FloatArray

Extension functions

setFrom

android

Artifact: androidx.compose.ui:ui-graphics

View Source

fun Matrix.setFrom(matrix: Matrix): Unit

Set the matrix values the native android.graphics.Matrix.

isIdentity

Cmn

Artifact: androidx.compose.ui:ui-graphics

View Source

fun Matrix.isIdentity(): Boolean

Whether the given matrix is the identity matrix.