hytopia 0.2.1 → 0.2.3

package/docs/server.matrix3._constructor_.md

@@ -0,0 +1,159 @@
+<!-- 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; [(constructor)](./server.matrix3._constructor_.md)
+
+## Matrix3.(constructor)
+
+Constructs a new instance of the `Matrix3` class
+
+**Signature:**
+
+```typescript
+constructor(m00: number, m01: number, m02: number, m10: number, m11: number, m12: number, m20: number, m21: number, m22: 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>
+
+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>
+
+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>
+</tbody></table>

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

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

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

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

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

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

package/docs/server.matrix3.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; [Matrix3](./server.matrix3.md) &gt; [equals](./server.matrix3.equals.md)
+
+## Matrix3.equals() method
+
+Checks if the current matrix is approximately equal to another matrix.
+
+**Signature:**
+
+```typescript
+equals(matrix3: Matrix3): boolean;
+```
+
+## 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 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.matrix3.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; [Matrix3](./server.matrix3.md) &gt; [exactEquals](./server.matrix3.exactequals.md)
+
+## Matrix3.exactEquals() method
+
+Checks if the current matrix is exactly equal to another matrix.
+
+**Signature:**
+
+```typescript
+exactEquals(matrix3: Matrix3): boolean;
+```
+
+## 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 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.matrix3.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; [Matrix3](./server.matrix3.md) &gt; [frobeniusNormal](./server.matrix3.frobeniusnormal.md)
+
+## Matrix3.frobeniusNormal property
+
+The frobenius normal of the matrix.
+
+**Signature:**
+
+```typescript
+get frobeniusNormal(): number;
+```

package/docs/server.matrix3.frommatrix4.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; [fromMatrix4](./server.matrix3.frommatrix4.md)
+
+## Matrix3.fromMatrix4() method
+
+Creates a new `Matrix3` instance from a `Matrix4` instance.
+
+**Signature:**
+
+```typescript
+static fromMatrix4(matrix4: Matrix4): Matrix3;
+```
+
+## 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 `Matrix4` instance to create the `Matrix3` instance from.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix3](./server.matrix3.md)
+
+A new `Matrix3` instance.
+

package/docs/server.matrix3.fromquaternion.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; [fromQuaternion](./server.matrix3.fromquaternion.md)
+
+## Matrix3.fromQuaternion() method
+
+Creates a new `Matrix3` instance from a `Quaternion` instance.
+
+**Signature:**
+
+```typescript
+static fromQuaternion(quaternion: Quaternion): Matrix3;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+quaternion
+
+
+</td><td>
+
+[Quaternion](./server.quaternion.md)
+
+
+</td><td>
+
+The `Quaternion` instance to create the `Matrix3` instance from.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix3](./server.matrix3.md)
+
+A new `Matrix3` instance.
+

package/docs/server.matrix3.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; [Matrix3](./server.matrix3.md) &gt; [fromRotation](./server.matrix3.fromrotation.md)
+
+## Matrix3.fromRotation() method
+
+Creates a new `Matrix3` instance from a rotation of identity matrix.
+
+**Signature:**
+
+```typescript
+static fromRotation(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 matrix by.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix3](./server.matrix3.md)
+
+A new `Matrix3` instance.
+

package/docs/server.matrix3.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; [Matrix3](./server.matrix3.md) &gt; [fromScaling](./server.matrix3.fromscaling.md)
+
+## Matrix3.fromScaling() method
+
+Creates a new `Matrix3` instance from a scale of identity matrix.
+
+**Signature:**
+
+```typescript
+static fromScaling(scale: Vector3): Matrix3;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+scale
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The scale of the matrix.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix3](./server.matrix3.md)
+
+A new `Matrix3` instance.
+