Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Core: Add Matrix2 class #28923

Merged
merged 5 commits into from
Jul 21, 2024
Merged

Core: Add Matrix2 class #28923

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
85a7f15
Add Matrix2 class to examples
gkjohnson Jul 20, 2024
f9641d1
Update "set" function body formatting
gkjohnson Jul 20, 2024
bc7b1dc
Add Matrix2 to core
gkjohnson Jul 20, 2024
7313d9b
Update WebGPU build
gkjohnson Jul 20, 2024
765dcf5
docs
gkjohnson Jul 21, 2024
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 132 additions & 0 deletions docs/api/en/math/Matrix2.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../../" />
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
<h1>[name]</h1>

<p class="desc">
A class representing a 2x2
[link:https://en.wikipedia.org/wiki/Matrix_(mathematics) matrix].
</p>

<h2>Code Example</h2>
<code>
const m = new Matrix2();
</code>

<h2>A Note on Row-Major and Column-Major Ordering</h2>
<p>
The constructor and [page:set]() method take arguments in
[link:https://en.wikipedia.org/wiki/Row-_and_column-major_order#Column-major_order row-major]
order, while internally they are stored in the [page:.elements elements]
array in column-major order.<br /><br />

This means that calling
<code>
m.set( 11, 12,
21, 22 );
</code>
will result in the [page:.elements elements] array containing:
<code>
m.elements = [ 11, 21,
12, 22 ];
</code>
and internally all calculations are performed using column-major ordering.
However, as the actual ordering makes no difference mathematically and
most people are used to thinking about matrices in row-major order, the
three.js documentation shows matrices in row-major order. Just bear in
mind that if you are reading the source code, you'll have to take the
[link:https://en.wikipedia.org/wiki/Transpose transpose] of any matrices
outlined here to make sense of the calculations.
</p>

<h2>Constructor</h2>

<h3>[name]( [param:Number n11], [param:Number n12],
[param:Number n21], [param:Number n22] )</h3>
<p>
Creates a 2x2 matrix with the given arguments in row-major order. If no arguments are provided, the constructor initializes
the [name] to the 3x3 [link:https://en.wikipedia.org/wiki/Identity_matrix identity matrix].
</p>

<h2>Properties</h2>

<h3>[property:Array elements]</h3>
<p>
A [link:https://en.wikipedia.org/wiki/Row-_and_column-major_order column-major] list of matrix values.
</p>

<h2>Methods</h2>

<h3>
[method:this fromArray]( [param:Array array], [param:Integer offset] )
</h3>
<p>
[page:Array array] - the array to read the elements from.<br />
[page:Integer offset] - (optional) index of first element in the array.
Default is `0`.<br /><br />

Sets the elements of this matrix based on an array in
[link:https://en.wikipedia.org/wiki/Row-_and_column-major_order#Column-major_order column-major] format.
</p>

<h3>[method:this identity]()</h3>
<p>
Resets this matrix to the 2x2 identity matrix:
</p>

<math display="block">
<mrow>
<mo>[</mo>
<mtable>
<mtr>
<mtd><mn>1</mn></mtd>
<mtd><mn>0</mn></mtd>
</mtr>
<mtr>
<mtd><mn>0</mn></mtd>
<mtd><mn>1</mn></mtd>
</mtr>
</mtable>
<mo>]</mo>
</mrow>
</math>

<h3>
[method:this set]( [param:Float n11], [param:Float n12], [param:Float n21], [param:Float n22] )
</h3>
<p>
Sets the 2x2 matrix values to the given
[link:https://en.wikipedia.org/wiki/Row-_and_column-major_order row-major]
sequence of values:
</p>

<math display="block">
<mrow>
<mo>[</mo>
<mtable>
<mtr>
<mtd><mi>n11</mi></mtd>
<mtd><mi>n12</mi></mtd>
</mtr>
<mtr>
<mtd><mi>n21</mi></mtd>
<mtd><mi>n22</mi></mtd>
</mtr>
</mtable>
<mo>]</mo>
</mrow>
</math>

<h2>Source</h2>

<p>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</p>
</body>
</html>
1 change: 1 addition & 0 deletions docs/list.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,7 @@
"Interpolant": "api/en/math/Interpolant",
"Line3": "api/en/math/Line3",
"MathUtils": "api/en/math/MathUtils",
"Matrix2": "api/en/math/Matrix2",
"Matrix3": "api/en/math/Matrix3",
"Matrix4": "api/en/math/Matrix4",
"Plane": "api/en/math/Plane",
Expand Down
1 change: 1 addition & 0 deletions src/Three.WebGPU.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ export { Sphere } from './math/Sphere.js';
export { Ray } from './math/Ray.js';
export { Matrix4 } from './math/Matrix4.js';
export { Matrix3 } from './math/Matrix3.js';
export { Matrix2 } from './math/Matrix2.js';
export { Box3 } from './math/Box3.js';
export { Box2 } from './math/Box2.js';
export { Line3 } from './math/Line3.js';
Expand Down
1 change: 1 addition & 0 deletions src/Three.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ export { Sphere } from './math/Sphere.js';
export { Ray } from './math/Ray.js';
export { Matrix4 } from './math/Matrix4.js';
export { Matrix3 } from './math/Matrix3.js';
export { Matrix2 } from './math/Matrix2.js';
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mind also adding the entry for Three.WebGPU.js?

Otherwise the WebGPU build won't have this class.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also docs. 🙏
export { Box3 } from './math/Box3.js';
export { Box2 } from './math/Box2.js';
export { Line3 } from './math/Line3.js';
Expand Down
54 changes: 54 additions & 0 deletions src/math/Matrix2.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
export class Matrix2 {

constructor( n11, n12, n21, n22 ) {

Matrix2.prototype.isMatrix2 = true;

this.elements = [
1, 0,
0, 1,
];

if ( n11 !== undefined ) {

this.set( n11, n12, n21, n22 );

}

}

identity() {

this.set(
1, 0,
0, 1,
);

return this;

}

fromArray( array, offset = 0 ) {

for ( let i = 0; i < 4; i ++ ) {

this.elements[ i ] = array[ i + offset ];

}

return this;

}

set( n11, n12, n21, n22 ) {

const te = this.elements;

te[ 0 ] = n11; te[ 2 ] = n12;
te[ 1 ] = n21; te[ 3 ] = n22;

return this;

}

}