hytopia 0.2.2 → 0.2.4

package/docs/server.matrix2._constructor_.md

@@ -0,0 +1,89 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Matrix2](./server.matrix2.md) &gt; [(constructor)](./server.matrix2._constructor_.md)
+
+## Matrix2.(constructor)
+
+Constructs a new instance of the `Matrix2` class
+
+**Signature:**
+
+```typescript
+constructor(m00: number, m01: number, m10: number, m11: number);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+m00
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+m01
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+m10
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+m11
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.matrix2.add.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Matrix2](./server.matrix2.md) &gt; [add](./server.matrix2.add.md)
+
+## Matrix2.add() method
+
+Adds a matrix to the current matrix.
+
+**Signature:**
+
+```typescript
+add(matrix2: Matrix2): Matrix2;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+matrix2
+
+
+</td><td>
+
+[Matrix2](./server.matrix2.md)
+
+
+</td><td>
+
+The matrix to add to the current matrix.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix2](./server.matrix2.md)
+
+The current matrix.
+

package/docs/server.matrix2.adjoint.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Matrix2](./server.matrix2.md) &gt; [adjoint](./server.matrix2.adjoint.md)
+
+## Matrix2.adjoint() method
+
+Sets the adjugate of the current matrix.
+
+**Signature:**
+
+```typescript
+adjoint(): Matrix2;
+```
+**Returns:**
+
+[Matrix2](./server.matrix2.md)
+
+The current matrix.
+

package/docs/server.matrix2.clone.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Matrix2](./server.matrix2.md) &gt; [clone](./server.matrix2.clone.md)
+
+## Matrix2.clone() method
+
+Clones the current matrix.
+
+**Signature:**
+
+```typescript
+clone(): Matrix2;
+```
+**Returns:**
+
+[Matrix2](./server.matrix2.md)
+
+A clone of the current matrix.
+

package/docs/server.matrix2.copy.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Matrix2](./server.matrix2.md) &gt; [copy](./server.matrix2.copy.md)
+
+## Matrix2.copy() method
+
+Copies a matrix to the current matrix.
+
+**Signature:**
+
+```typescript
+copy(matrix2: Matrix2): Matrix2;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+matrix2
+
+
+</td><td>
+
+[Matrix2](./server.matrix2.md)
+
+
+</td><td>
+
+The matrix2 to copy to the current matrix.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix2](./server.matrix2.md)
+
+The current matrix.
+

package/docs/server.matrix2.create.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Matrix2](./server.matrix2.md) &gt; [create](./server.matrix2.create.md)
+
+## Matrix2.create() method
+
+Creates a new `Matrix2` instance.
+
+**Signature:**
+
+```typescript
+static create(): Matrix2;
+```
+**Returns:**
+
+[Matrix2](./server.matrix2.md)
+
+A new `Matrix2` instance.
+

package/docs/server.matrix2.determinant.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Matrix2](./server.matrix2.md) &gt; [determinant](./server.matrix2.determinant.md)
+
+## Matrix2.determinant property
+
+The determinant of the matrix.
+
+**Signature:**
+
+```typescript
+get determinant(): number;
+```

package/docs/server.matrix2.equals.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Matrix2](./server.matrix2.md) &gt; [equals](./server.matrix2.equals.md)
+
+## Matrix2.equals() method
+
+Checks if the current matrix is approximately equal to another matrix.
+
+**Signature:**
+
+```typescript
+equals(matrix2: Matrix2): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+matrix2
+
+
+</td><td>
+
+[Matrix2](./server.matrix2.md)
+
+
+</td><td>
+
+The matrix to compare to the current matrix.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+boolean
+
+`true` if the current matrix is equal to the provided matrix, `false` otherwise.
+

package/docs/server.matrix2.exactequals.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Matrix2](./server.matrix2.md) &gt; [exactEquals](./server.matrix2.exactequals.md)
+
+## Matrix2.exactEquals() method
+
+Checks if the current matrix is exactly equal to another matrix.
+
+**Signature:**
+
+```typescript
+exactEquals(matrix2: Matrix2): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+matrix2
+
+
+</td><td>
+
+[Matrix2](./server.matrix2.md)
+
+
+</td><td>
+
+The matrix to compare to the current matrix.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+boolean
+
+`true` if the current matrix is equal to the provided matrix, `false` otherwise.
+

package/docs/server.matrix2.frobeniusnorm.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Matrix2](./server.matrix2.md) &gt; [frobeniusNorm](./server.matrix2.frobeniusnorm.md)
+
+## Matrix2.frobeniusNorm property
+
+The frobenius normal of the matrix.
+
+**Signature:**
+
+```typescript
+get frobeniusNorm(): number;
+```

package/docs/server.matrix2.fromrotation.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Matrix2](./server.matrix2.md) &gt; [fromRotation](./server.matrix2.fromrotation.md)
+
+## Matrix2.fromRotation() method
+
+Creates a new `Matrix2` instance from a rotation of identity matrix.
+
+**Signature:**
+
+```typescript
+static fromRotation(angle: number): Matrix2;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+angle
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The angle in radians to rotate the matrix by.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix2](./server.matrix2.md)
+
+A new `Matrix2` instance.
+

package/docs/server.matrix2.fromscaling.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Matrix2](./server.matrix2.md) &gt; [fromScaling](./server.matrix2.fromscaling.md)
+
+## Matrix2.fromScaling() method
+
+Creates a new `Matrix2` instance from a scale of identity matrix.
+
+**Signature:**
+
+```typescript
+static fromScaling(scale: Vector2): Matrix2;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+scale
+
+
+</td><td>
+
+[Vector2](./server.vector2.md)
+
+
+</td><td>
+
+The scale of the matrix.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix2](./server.matrix2.md)
+
+A new `Matrix2` instance.
+

package/docs/server.matrix2.identity.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Matrix2](./server.matrix2.md) &gt; [identity](./server.matrix2.identity.md)
+
+## Matrix2.identity() method
+
+Sets the current matrix to the identity matrix.
+
+**Signature:**
+
+```typescript
+identity(): Matrix2;
+```
+**Returns:**
+
+[Matrix2](./server.matrix2.md)
+
+The current matrix.
+

package/docs/server.matrix2.invert.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Matrix2](./server.matrix2.md) &gt; [invert](./server.matrix2.invert.md)
+
+## Matrix2.invert() method
+
+Inverts the current matrix.
+
+**Signature:**
+
+```typescript
+invert(): Matrix2;
+```
+**Returns:**
+
+[Matrix2](./server.matrix2.md)
+
+The current matrix.
+