2025-01-15 19:28:55 +01:00

1235 lines
67 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Matrix | openfl</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">openfl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">openfl</a>
</li>
<li>
<a href="../modules/openfl.geom.html">geom</a>
</li>
<li>
<a href="openfl.geom.matrix.html">Matrix</a>
</li>
</ul>
<h1>Class Matrix</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The Matrix class represents a transformation matrix that determines how to
map points from one coordinate space to another. You can perform various
graphical transformations on a display object by setting the properties of
a Matrix object, applying that Matrix object to the <code>matrix</code>
property of a Transform object, and then applying that Transform object as
the <code>transform</code> property of the display object. These
transformation functions include translation(<em>x</em> and <em>y</em>
repositioning), rotation, scaling, and skewing.</p>
</div>
<p>Together these types of transformations are known as <em>affine
transformations</em>. Affine transformations preserve the straightness of
lines while transforming, so that parallel lines stay parallel.</p>
<p>To apply a transformation matrix to a display object, you create a
Transform object, set its <code>matrix</code> property to the
transformation matrix, and then set the <code>transform</code> property of
the display object to the Transform object. Matrix objects are also used as
parameters of some methods, such as the following:</p>
<ul>
<li>The <code>draw()</code> method of a BitmapData object</li>
<li>The <code>beginBitmapFill()</code> method,
<code>beginGradientFill()</code> method, or
<code>lineGradientStyle()</code> method of a Graphics object</li>
</ul>
<p>A transformation matrix object is a 3 x 3 matrix with the following
contents:</p>
<p>In traditional transformation matrixes, the <code>u</code>,
<code>v</code>, and <code>w</code> properties provide extra capabilities.
The Matrix class can only operate in two-dimensional space, so it always
assumes that the property values <code>u</code> and <code>v</code> are 0.0,
and that the property value <code>w</code> is 1.0. The effective values of
the matrix are as follows:</p>
<p>You can get and set the values of all six of the other properties in a
Matrix object: <code>a</code>, <code>b</code>, <code>c</code>,
<code>d</code>, <code>tx</code>, and <code>ty</code>.</p>
<p>The Matrix class supports the four major types of transformations:
translation, scaling, rotation, and skewing. You can set three of these
transformations by using specialized methods, as described in the following
table:</p>
<p>Each transformation alters the current matrix properties so
that you can effectively combine multiple transformations. To do this, you
call more than one transformation before applying the matrix to
its display object target(by using the <code>transform</code> property of
that display object).</p>
<p>Use the <code>new Matrix()</code> constructor to create a Matrix object
before you can call the methods of the Matrix object.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Matrix</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-external">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#a" class="tsd-kind-icon">a</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#b" class="tsd-kind-icon">b</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#c" class="tsd-kind-icon">c</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#d" class="tsd-kind-icon">d</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#tx" class="tsd-kind-icon">tx</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#ty" class="tsd-kind-icon">ty</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#clone" class="tsd-kind-icon">clone</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#concat" class="tsd-kind-icon">concat</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#copycolumnfrom" class="tsd-kind-icon">copy<wbr>Column<wbr>From</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#copycolumnto" class="tsd-kind-icon">copy<wbr>Column<wbr>To</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#copyfrom" class="tsd-kind-icon">copy<wbr>From</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#copyrowfrom" class="tsd-kind-icon">copy<wbr>Row<wbr>From</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#copyrowto" class="tsd-kind-icon">copy<wbr>Row<wbr>To</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#createbox" class="tsd-kind-icon">create<wbr>Box</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#creategradientbox" class="tsd-kind-icon">create<wbr>Gradient<wbr>Box</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#deltatransformpoint" class="tsd-kind-icon">delta<wbr>Transform<wbr>Point</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#identity" class="tsd-kind-icon">identity</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#invert" class="tsd-kind-icon">invert</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#rotate" class="tsd-kind-icon">rotate</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#scale" class="tsd-kind-icon">scale</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#setto" class="tsd-kind-icon">set<wbr>To</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#transformpoint" class="tsd-kind-icon">transform<wbr>Point</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.geom.matrix.html#translate" class="tsd-kind-icon">translate</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">new <wbr>Matrix<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, b<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, c<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, d<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, tx<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, ty<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L98">lib/openfl/geom/Matrix.d.ts:98</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a new Matrix object with the specified parameters. In matrix
notation, the properties are organized like this:</p>
</div>
<p>If you do not provide any parameters to the <code>new Matrix()</code>
constructor, it creates an <em>identity matrix</em> with the following
values:</p>
<p>In matrix notation, the identity matrix looks like this:</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> a: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The value that affects the positioning of pixels along the
<em>x</em> axis when scaling or rotating an image.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> b: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The value that affects the positioning of pixels along the
<em>y</em> axis when rotating or skewing an image.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> c: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The value that affects the positioning of pixels along the
<em>x</em> axis when rotating or skewing an image.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> d: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The value that affects the positioning of pixels along the
<em>y</em> axis when scaling or rotating an image..</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> tx: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The distance by which to translate each point along the <em>x</em>
axis.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ty: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The distance by which to translate each point along the <em>y</em>
axis.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="a" class="tsd-anchor"></a>
<h3>a</h3>
<div class="tsd-signature tsd-kind-icon">a<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L70">lib/openfl/geom/Matrix.d.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The value that affects the positioning of pixels along the <em>x</em> axis
when scaling or rotating an image.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="b" class="tsd-anchor"></a>
<h3>b</h3>
<div class="tsd-signature tsd-kind-icon">b<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L76">lib/openfl/geom/Matrix.d.ts:76</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The value that affects the positioning of pixels along the <em>y</em> axis
when rotating or skewing an image.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="c" class="tsd-anchor"></a>
<h3>c</h3>
<div class="tsd-signature tsd-kind-icon">c<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L82">lib/openfl/geom/Matrix.d.ts:82</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The value that affects the positioning of pixels along the <em>x</em> axis
when rotating or skewing an image.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="d" class="tsd-anchor"></a>
<h3>d</h3>
<div class="tsd-signature tsd-kind-icon">d<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L88">lib/openfl/geom/Matrix.d.ts:88</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The value that affects the positioning of pixels along the <em>y</em> axis
when scaling or rotating an image.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="tx" class="tsd-anchor"></a>
<h3>tx</h3>
<div class="tsd-signature tsd-kind-icon">tx<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L93">lib/openfl/geom/Matrix.d.ts:93</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The distance by which to translate each point along the <em>x</em> axis.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="ty" class="tsd-anchor"></a>
<h3>ty</h3>
<div class="tsd-signature tsd-kind-icon">ty<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L98">lib/openfl/geom/Matrix.d.ts:98</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The distance by which to translate each point along the <em>y</em> axis.</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="clone" class="tsd-anchor"></a>
<h3>clone</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">clone<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L134">lib/openfl/geom/Matrix.d.ts:134</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a new Matrix object that is a clone of this matrix, with an exact
copy of the contained object.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a></h4>
<p>A Matrix object.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="concat" class="tsd-anchor"></a>
<h3>concat</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">concat<span class="tsd-signature-symbol">(</span>m<span class="tsd-signature-symbol">: </span><a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L155">lib/openfl/geom/Matrix.d.ts:155</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Concatenates a matrix with the current matrix, effectively combining the
geometric effects of the two. In mathematical terms, concatenating two
matrixes is the same as combining them using matrix multiplication.</p>
</div>
<p>For example, if matrix <code>m1</code> scales an object by a factor of
four, and matrix <code>m2</code> rotates an object by 1.5707963267949
radians(<code>Math.PI/2</code>), then <code>m1.concat(m2)</code>
transforms <code>m1</code> into a matrix that scales an object by a factor
of four and rotates the object by <code>Math.PI/2</code> radians.</p>
<p>This method replaces the source matrix with the concatenated matrix. If
you want to concatenate two matrixes without altering either of the two
source matrixes, first copy the source matrix by using the
<code>clone()</code> method, as shown in the Class Examples section.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>m: <a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a></h5>
<div class="tsd-comment tsd-typography">
<p>The matrix to be concatenated to the source matrix.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="copycolumnfrom" class="tsd-anchor"></a>
<h3>copy<wbr>Column<wbr>From</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">copy<wbr>Column<wbr>From<span class="tsd-signature-symbol">(</span>column<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, vector3D<span class="tsd-signature-symbol">: </span><a href="openfl.geom.vector3d.html" class="tsd-signature-type">Vector3D</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L158">lib/openfl/geom/Matrix.d.ts:158</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>column: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>vector3D: <a href="openfl.geom.vector3d.html" class="tsd-signature-type">Vector3D</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="copycolumnto" class="tsd-anchor"></a>
<h3>copy<wbr>Column<wbr>To</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">copy<wbr>Column<wbr>To<span class="tsd-signature-symbol">(</span>column<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, vector3D<span class="tsd-signature-symbol">: </span><a href="openfl.geom.vector3d.html" class="tsd-signature-type">Vector3D</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L161">lib/openfl/geom/Matrix.d.ts:161</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>column: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>vector3D: <a href="openfl.geom.vector3d.html" class="tsd-signature-type">Vector3D</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="copyfrom" class="tsd-anchor"></a>
<h3>copy<wbr>From</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">copy<wbr>From<span class="tsd-signature-symbol">(</span>sourceMatrix<span class="tsd-signature-symbol">: </span><a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L164">lib/openfl/geom/Matrix.d.ts:164</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>sourceMatrix: <a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="copyrowfrom" class="tsd-anchor"></a>
<h3>copy<wbr>Row<wbr>From</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">copy<wbr>Row<wbr>From<span class="tsd-signature-symbol">(</span>row<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, vector3D<span class="tsd-signature-symbol">: </span><a href="openfl.geom.vector3d.html" class="tsd-signature-type">Vector3D</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L167">lib/openfl/geom/Matrix.d.ts:167</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>row: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>vector3D: <a href="openfl.geom.vector3d.html" class="tsd-signature-type">Vector3D</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="copyrowto" class="tsd-anchor"></a>
<h3>copy<wbr>Row<wbr>To</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">copy<wbr>Row<wbr>To<span class="tsd-signature-symbol">(</span>row<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, vector3D<span class="tsd-signature-symbol">: </span><a href="openfl.geom.vector3d.html" class="tsd-signature-type">Vector3D</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L170">lib/openfl/geom/Matrix.d.ts:170</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>row: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>vector3D: <a href="openfl.geom.vector3d.html" class="tsd-signature-type">Vector3D</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="createbox" class="tsd-anchor"></a>
<h3>create<wbr>Box</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">create<wbr>Box<span class="tsd-signature-symbol">(</span>scaleX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, scaleY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, rotation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, tx<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, ty<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L191">lib/openfl/geom/Matrix.d.ts:191</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Includes parameters for scaling, rotation, and translation. When applied
to a matrix it sets the matrix&#39;s values based on those parameters.</p>
</div>
<p>Using the <code>createBox()</code> method lets you obtain the same
matrix as you would if you applied the <code>identity()</code>,
<code>rotate()</code>, <code>scale()</code>, and <code>translate()</code>
methods in succession. For example, <code>mat1.createBox(2,2,Math.PI/4,
100, 100)</code> has the same effect as the following:</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>scaleX: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The factor by which to scale horizontally.</p>
</div>
</li>
<li>
<h5>scaleY: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The factor by which scale vertically.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> rotation: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The amount to rotate, in radians.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> tx: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The number of pixels to translate(move) to the right
along the <em>x</em> axis.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ty: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The number of pixels to translate(move) down along the
<em>y</em> axis.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="creategradientbox" class="tsd-anchor"></a>
<h3>create<wbr>Gradient<wbr>Box</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">create<wbr>Gradient<wbr>Box<span class="tsd-signature-symbol">(</span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, rotation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, tx<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, ty<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L227">lib/openfl/geom/Matrix.d.ts:227</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates the specific style of matrix expected by the
<code>beginGradientFill()</code> and <code>lineGradientStyle()</code>
methods of the Graphics class. Width and height are scaled to a
<code>scaleX</code>/<code>scaleY</code> pair and the
<code>tx</code>/<code>ty</code> values are offset by half the width and
height.</p>
</div>
<p>For example, consider a gradient with the following
characteristics:</p>
<ul>
<li><code>GradientType.LINEAR</code></li>
<li>Two colors, green and blue, with the ratios array set to <code>[0,
255]</code></li>
<li><code>SpreadMethod.PAD</code></li>
<li><code>InterpolationMethod.LINEAR_RGB</code></li>
</ul>
<p>The following illustrations show gradients in which the matrix was
defined using the <code>createGradientBox()</code> method with different
parameter settings:</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>width: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The width of the gradient box.</p>
</div>
</li>
<li>
<h5>height: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The height of the gradient box.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> rotation: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The amount to rotate, in radians.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> tx: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The distance, in pixels, to translate to the right along
the <em>x</em> axis. This value is offset by half of the
<code>width</code> parameter.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ty: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The distance, in pixels, to translate down along the
<em>y</em> axis. This value is offset by half of the
<code>height</code> parameter.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="deltatransformpoint" class="tsd-anchor"></a>
<h3>delta<wbr>Transform<wbr>Point</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">delta<wbr>Transform<wbr>Point<span class="tsd-signature-symbol">(</span>point<span class="tsd-signature-symbol">: </span><a href="openfl.geom.point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="openfl.geom.point.html" class="tsd-signature-type">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L242">lib/openfl/geom/Matrix.d.ts:242</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Given a point in the pretransform coordinate space, returns the
coordinates of that point after the transformation occurs. Unlike the
standard transformation applied using the <code>transformPoint()</code>
method, the <code>deltaTransformPoint()</code> method&#39;s transformation
does not consider the translation parameters <code>tx</code> and
<code>ty</code>.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>point: <a href="openfl.geom.point.html" class="tsd-signature-type">Point</a></h5>
<div class="tsd-comment tsd-typography">
<p>The point for which you want to get the result of the matrix
transformation.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="openfl.geom.point.html" class="tsd-signature-type">Point</a></h4>
<p>The point resulting from applying the matrix transformation.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="identity" class="tsd-anchor"></a>
<h3>identity</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">identity<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L258">lib/openfl/geom/Matrix.d.ts:258</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sets each matrix property to a value that causes a null transformation. An
object transformed by applying an identity matrix will be identical to the
original.</p>
</div>
<p>After calling the <code>identity()</code> method, the resulting matrix
has the following properties: <code>a</code>=1, <code>b</code>=0,
<code>c</code>=0, <code>d</code>=1, <code>tx</code>=0,
<code>ty</code>=0.</p>
<p>In matrix notation, the identity matrix looks like this:</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="invert" class="tsd-anchor"></a>
<h3>invert</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">invert<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L267">lib/openfl/geom/Matrix.d.ts:267</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Performs the opposite transformation of the original matrix. You can apply
an inverted matrix to an object to undo the transformation performed when
applying the original matrix.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="rotate" class="tsd-anchor"></a>
<h3>rotate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">rotate<span class="tsd-signature-symbol">(</span>theta<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L280">lib/openfl/geom/Matrix.d.ts:280</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Applies a rotation transformation to the Matrix object.</p>
</div>
<p>The <code>rotate()</code> method alters the <code>a</code>,
<code>b</code>, <code>c</code>, and <code>d</code> properties of the
Matrix object. In matrix notation, this is the same as concatenating the
current matrix with the following:</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>theta: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="scale" class="tsd-anchor"></a>
<h3>scale</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">scale<span class="tsd-signature-symbol">(</span>sx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, sy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L296">lib/openfl/geom/Matrix.d.ts:296</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Applies a scaling transformation to the matrix. The <em>x</em> axis is
multiplied by <code>sx</code>, and the <em>y</em> axis it is multiplied by
<code>sy</code>.</p>
</div>
<p>The <code>scale()</code> method alters the <code>a</code> and
<code>d</code> properties of the Matrix object. In matrix notation, this
is the same as concatenating the current matrix with the following
matrix:</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>sx: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>A multiplier used to scale the object along the <em>x</em> axis.</p>
</div>
</li>
<li>
<h5>sy: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>A multiplier used to scale the object along the <em>y</em> axis.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="setto" class="tsd-anchor"></a>
<h3>set<wbr>To</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">set<wbr>To<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, b<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, c<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, d<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, tx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, ty<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L299">lib/openfl/geom/Matrix.d.ts:299</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>a: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>b: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>c: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>d: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>tx: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>ty: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="tostring" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L310">lib/openfl/geom/Matrix.d.ts:310</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a text value listing the properties of the Matrix object.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>A string containing the values of the properties of the Matrix
object: <code>a</code>, <code>b</code>, <code>c</code>,
<code>d</code>, <code>tx</code>, and <code>ty</code>.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="transformpoint" class="tsd-anchor"></a>
<h3>transform<wbr>Point</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">transform<wbr>Point<span class="tsd-signature-symbol">(</span>pos<span class="tsd-signature-symbol">: </span><a href="openfl.geom.point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="openfl.geom.point.html" class="tsd-signature-type">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L321">lib/openfl/geom/Matrix.d.ts:321</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the result of applying the geometric transformation represented by
the Matrix object to the specified point.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>pos: <a href="openfl.geom.point.html" class="tsd-signature-type">Point</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="openfl.geom.point.html" class="tsd-signature-type">Point</a></h4>
<p>The point resulting from applying the Matrix transformation.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="translate" class="tsd-anchor"></a>
<h3>translate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">translate<span class="tsd-signature-symbol">(</span>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/geom/Matrix.d.ts#L332">lib/openfl/geom/Matrix.d.ts:332</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Translates the matrix along the <em>x</em> and <em>y</em> axes, as specified
by the <code>dx</code> and <code>dy</code> parameters.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>dx: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The amount of movement along the <em>x</em> axis to the right, in
pixels.</p>
</div>
</li>
<li>
<h5>dy: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The amount of movement down along the <em>y</em> axis, in pixels.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="label tsd-is-external">
<span>Externals</span>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.desktop.html">openfl.desktop</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.display.html">openfl.display</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.display3d.html">openfl.display3D</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.errors.html">openfl.errors</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.events.html">openfl.events</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.external.html">openfl.external</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.filters.html">openfl.filters</a>
</li>
<li class="current tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.geom.html">openfl.geom</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.media.html">openfl.media</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.net.html">openfl.net</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.profiler.html">openfl.profiler</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.sensors.html">openfl.sensors</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.system.html">openfl.system</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.text.html">openfl.text</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.ui.html">openfl.ui</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/openfl.utils.html">openfl.utils</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-module tsd-is-external">
<a href="../enums/openfl.geom.orientation3d.html" class="tsd-kind-icon">Orientation3D</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="openfl.geom.colortransform.html" class="tsd-kind-icon">Color<wbr>Transform</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="openfl.geom.matrix.html" class="tsd-kind-icon">Matrix</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#a" class="tsd-kind-icon">a</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#b" class="tsd-kind-icon">b</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#c" class="tsd-kind-icon">c</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#d" class="tsd-kind-icon">d</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#tx" class="tsd-kind-icon">tx</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#ty" class="tsd-kind-icon">ty</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#clone" class="tsd-kind-icon">clone</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#concat" class="tsd-kind-icon">concat</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#copycolumnfrom" class="tsd-kind-icon">copy<wbr>Column<wbr>From</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#copycolumnto" class="tsd-kind-icon">copy<wbr>Column<wbr>To</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#copyfrom" class="tsd-kind-icon">copy<wbr>From</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#copyrowfrom" class="tsd-kind-icon">copy<wbr>Row<wbr>From</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#copyrowto" class="tsd-kind-icon">copy<wbr>Row<wbr>To</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#createbox" class="tsd-kind-icon">create<wbr>Box</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#creategradientbox" class="tsd-kind-icon">create<wbr>Gradient<wbr>Box</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#deltatransformpoint" class="tsd-kind-icon">delta<wbr>Transform<wbr>Point</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#identity" class="tsd-kind-icon">identity</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#invert" class="tsd-kind-icon">invert</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#rotate" class="tsd-kind-icon">rotate</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#scale" class="tsd-kind-icon">scale</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#setto" class="tsd-kind-icon">set<wbr>To</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#transformpoint" class="tsd-kind-icon">transform<wbr>Point</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="openfl.geom.matrix.html#translate" class="tsd-kind-icon">translate</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="openfl.geom.matrix3d.html" class="tsd-kind-icon">Matrix3D</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="openfl.geom.perspectiveprojection.html" class="tsd-kind-icon">Perspective<wbr>Projection</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="openfl.geom.point.html" class="tsd-kind-icon">Point</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="openfl.geom.rectangle.html" class="tsd-kind-icon">Rectangle</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="openfl.geom.transform.html" class="tsd-kind-icon">Transform</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="openfl.geom.utils3d.html" class="tsd-kind-icon">Utils3D</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="openfl.geom.vector3d.html" class="tsd-kind-icon">Vector3D</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>