hytopia 0.2.1 → 0.2.3

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

package/docs/server.matrix4.fromrotation.md

@@ -0,0 +1,71 @@
+<!-- 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; [fromRotation](./server.matrix4.fromrotation.md)
+
+## Matrix4.fromRotation() method
+
+Creates a new `Matrix4` instance from an angle and axis.
+
+**Signature:**
+
+```typescript
+static fromRotation(angle: number, axis: Vector3): Matrix4;
+```
+
+## 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>
+<tr><td>
+
+axis
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The axis to rotate the matrix around.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+A new `Matrix4` instance.
+

package/docs/server.matrix4.fromrotationtranslation.md

@@ -0,0 +1,71 @@
+<!-- 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; [fromRotationTranslation](./server.matrix4.fromrotationtranslation.md)
+
+## Matrix4.fromRotationTranslation() method
+
+Creates a new `Matrix4` instance from a rotation and translation.
+
+**Signature:**
+
+```typescript
+static fromRotationTranslation(rotation: Quaternion, translation: Vector3): Matrix4;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+rotation
+
+
+</td><td>
+
+[Quaternion](./server.quaternion.md)
+
+
+</td><td>
+
+The rotation of the matrix.
+
+
+</td></tr>
+<tr><td>
+
+translation
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The translation of the matrix.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+A new `Matrix4` instance.
+

package/docs/server.matrix4.fromrotationtranslationscale.md

@@ -0,0 +1,87 @@
+<!-- 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; [fromRotationTranslationScale](./server.matrix4.fromrotationtranslationscale.md)
+
+## Matrix4.fromRotationTranslationScale() method
+
+Creates a new `Matrix4` instance from a rotation, translation, and scale.
+
+**Signature:**
+
+```typescript
+static fromRotationTranslationScale(rotation: Quaternion, translation: Vector3, scale: Vector3): Matrix4;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+rotation
+
+
+</td><td>
+
+[Quaternion](./server.quaternion.md)
+
+
+</td><td>
+
+The rotation of the matrix.
+
+
+</td></tr>
+<tr><td>
+
+translation
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The translation of the matrix.
+
+
+</td></tr>
+<tr><td>
+
+scale
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The scale of the matrix.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+A new `Matrix4` instance.
+

package/docs/server.matrix4.fromrotationtranslationscaleorigin.md

@@ -0,0 +1,103 @@
+<!-- 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; [fromRotationTranslationScaleOrigin](./server.matrix4.fromrotationtranslationscaleorigin.md)
+
+## Matrix4.fromRotationTranslationScaleOrigin() method
+
+Creates a new `Matrix4` instance from a rotation, translation, scale, and origin.
+
+**Signature:**
+
+```typescript
+static fromRotationTranslationScaleOrigin(rotation: Quaternion, translation: Vector3, scale: Vector3, origin: Vector3): Matrix4;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+rotation
+
+
+</td><td>
+
+[Quaternion](./server.quaternion.md)
+
+
+</td><td>
+
+The rotation of the matrix.
+
+
+</td></tr>
+<tr><td>
+
+translation
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The translation of the matrix.
+
+
+</td></tr>
+<tr><td>
+
+scale
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The scale of the matrix.
+
+
+</td></tr>
+<tr><td>
+
+origin
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The origin of the matrix.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+A new `Matrix4` instance.
+

package/docs/server.matrix4.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; [Matrix4](./server.matrix4.md) &gt; [fromScaling](./server.matrix4.fromscaling.md)
+
+## Matrix4.fromScaling() method
+
+Creates a new `Matrix4` instance from a scale of identity matrix.
+
+**Signature:**
+
+```typescript
+static fromScaling(scale: Vector3): Matrix4;
+```
+
+## 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:**
+
+[Matrix4](./server.matrix4.md)
+
+A new `Matrix4` instance.
+

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

package/docs/server.matrix4.fromxrotation.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; [fromXRotation](./server.matrix4.fromxrotation.md)
+
+## Matrix4.fromXRotation() method
+
+Creates a new `Matrix4` instance from an x-rotation of identity matrix.
+
+**Signature:**
+
+```typescript
+static fromXRotation(angle: number): Matrix4;
+```
+
+## 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:**
+
+[Matrix4](./server.matrix4.md)
+
+A new `Matrix4` instance.
+

package/docs/server.matrix4.fromyrotation.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; [fromYRotation](./server.matrix4.fromyrotation.md)
+
+## Matrix4.fromYRotation() method
+
+Creates a new `Matrix4` instance from a y-rotation of identity matrix.
+
+**Signature:**
+
+```typescript
+static fromYRotation(angle: number): Matrix4;
+```
+
+## 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:**
+
+[Matrix4](./server.matrix4.md)
+
+A new `Matrix4` instance.
+

package/docs/server.matrix4.fromzrotation.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; [fromZRotation](./server.matrix4.fromzrotation.md)
+
+## Matrix4.fromZRotation() method
+
+Creates a new `Matrix4` instance from a z-rotation of identity matrix.
+
+**Signature:**
+
+```typescript
+static fromZRotation(angle: number): Matrix4;
+```
+
+## 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:**
+
+[Matrix4](./server.matrix4.md)
+
+A new `Matrix4` instance.
+