hytopia 0.2.2 → 0.2.3

package/docs/server.matrix3.rotate.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; [Matrix3](./server.matrix3.md) &gt; [rotate](./server.matrix3.rotate.md)
+
+## Matrix3.rotate() method
+
+Rotates the current matrix by an angle in radians.
+
+**Signature:**
+
+```typescript
+rotate(angle: number): Matrix3;
+```
+
+## 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 current matrix by.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix3](./server.matrix3.md)
+
+The current matrix.
+

package/docs/server.matrix3.subtract.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; [Matrix3](./server.matrix3.md) &gt; [subtract](./server.matrix3.subtract.md)
+
+## Matrix3.subtract() method
+
+Subtracts a matrix from the current matrix.
+
+**Signature:**
+
+```typescript
+subtract(matrix3: Matrix3): Matrix3;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+matrix3
+
+
+</td><td>
+
+[Matrix3](./server.matrix3.md)
+
+
+</td><td>
+
+The matrix to subtract from the current matrix.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix3](./server.matrix3.md)
+
+The current matrix.
+

package/docs/server.matrix3.tostring.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; [Matrix3](./server.matrix3.md) &gt; [toString](./server.matrix3.tostring.md)
+
+## Matrix3.toString() method
+
+Returns a string representation of the current matrix.
+
+**Signature:**
+
+```typescript
+toString(): string;
+```
+**Returns:**
+
+string
+
+A string representation of the current matrix.
+

package/docs/server.matrix3.transpose.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; [Matrix3](./server.matrix3.md) &gt; [transpose](./server.matrix3.transpose.md)
+
+## Matrix3.transpose() method
+
+Transposes the current matrix.
+
+**Signature:**
+
+```typescript
+transpose(): Matrix3;
+```
+**Returns:**
+
+[Matrix3](./server.matrix3.md)
+
+The current matrix.
+

package/docs/server.matrix4._constructor_.md

@@ -0,0 +1,257 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Matrix4](./server.matrix4.md) &gt; [(constructor)](./server.matrix4._constructor_.md)
+
+## Matrix4.(constructor)
+
+Constructs a new instance of the `Matrix4` class
+
+**Signature:**
+
+```typescript
+constructor(m00: number, m01: number, m02: number, m03: number, m10: number, m11: number, m12: number, m13: number, m20: number, m21: number, m22: number, m23: number, m30: number, m31: number, m32: number, m33: 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>
+
+m02
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+m03
+
+
+</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>
+<tr><td>
+
+m12
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+m13
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+m20
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+m21
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+m22
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+m23
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+m30
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+m31
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+m32
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+m33
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.matrix4.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; [Matrix4](./server.matrix4.md) &gt; [add](./server.matrix4.add.md)
+
+## Matrix4.add() method
+
+Adds a matrix to the current matrix.
+
+**Signature:**
+
+```typescript
+add(matrix4: Matrix4): Matrix4;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+matrix4
+
+
+</td><td>
+
+[Matrix4](./server.matrix4.md)
+
+
+</td><td>
+
+The matrix to add to the current matrix.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+The current matrix.
+

package/docs/server.matrix4.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; [Matrix4](./server.matrix4.md) &gt; [adjoint](./server.matrix4.adjoint.md)
+
+## Matrix4.adjoint() method
+
+Sets the adjugate of the current matrix.
+
+**Signature:**
+
+```typescript
+adjoint(): Matrix4;
+```
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+The current matrix.
+

package/docs/server.matrix4.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; [Matrix4](./server.matrix4.md) &gt; [clone](./server.matrix4.clone.md)
+
+## Matrix4.clone() method
+
+Clones the current matrix.
+
+**Signature:**
+
+```typescript
+clone(): Matrix4;
+```
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+A clone of the current matrix.
+

package/docs/server.matrix4.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; [Matrix4](./server.matrix4.md) &gt; [copy](./server.matrix4.copy.md)
+
+## Matrix4.copy() method
+
+Copies a matrix to the current matrix.
+
+**Signature:**
+
+```typescript
+copy(matrix4: Matrix4): Matrix4;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+matrix4
+
+
+</td><td>
+
+[Matrix4](./server.matrix4.md)
+
+
+</td><td>
+
+The matrix to copy to the current matrix.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+The current matrix.
+

package/docs/server.matrix4.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; [Matrix4](./server.matrix4.md) &gt; [create](./server.matrix4.create.md)
+
+## Matrix4.create() method
+
+Creates a new `Matrix4` instance.
+
+**Signature:**
+
+```typescript
+static create(): Matrix4;
+```
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+A new `Matrix4` instance.
+

package/docs/server.matrix4.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; [Matrix4](./server.matrix4.md) &gt; [determinant](./server.matrix4.determinant.md)
+
+## Matrix4.determinant property
+
+The determinant of the matrix.
+
+**Signature:**
+
+```typescript
+get determinant(): number;
+```

package/docs/server.matrix4.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; [Matrix4](./server.matrix4.md) &gt; [equals](./server.matrix4.equals.md)
+
+## Matrix4.equals() method
+
+Checks if the current matrix is approximately equal to another matrix.
+
+**Signature:**
+
+```typescript
+equals(matrix4: Matrix4): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+matrix4
+
+
+</td><td>
+
+[Matrix4](./server.matrix4.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.matrix4.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; [Matrix4](./server.matrix4.md) &gt; [exactEquals](./server.matrix4.exactequals.md)
+
+## Matrix4.exactEquals() method
+
+Checks if the current matrix is exactly equal to another matrix.
+
+**Signature:**
+
+```typescript
+exactEquals(matrix4: Matrix4): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+matrix4
+
+
+</td><td>
+
+[Matrix4](./server.matrix4.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.matrix4.frobeniusnormal.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; [Matrix4](./server.matrix4.md) &gt; [frobeniusNormal](./server.matrix4.frobeniusnormal.md)
+
+## Matrix4.frobeniusNormal property
+
+The frobenius normal of the matrix.
+
+**Signature:**
+
+```typescript
+get frobeniusNormal(): number;
+```