hytopia 0.1.44 → 0.1.46

package/docs/server.hytopia.quaternion.md

@@ -1,501 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Quaternion](./server.hytopia.quaternion.md)
-
-## HYTOPIA.Quaternion class
-
-Represents a quaternion.
-
-**Signature:**
-
-```typescript
-export default class Quaternion extends Float32Array implements QuaternionLike 
-```
-**Extends:** Float32Array
-
-**Implements:** [QuaternionLike](./server.quaternionlike.md)
-
-## Remarks
-
-All quaternion methods result in mutation of the quaternion instance. This class extends `Float32Array` to provide an efficient way to create and manipulate a quaternion. Various convenience methods are provided for common quaternion operations.
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(x, y, z, w)](./server.hytopia.quaternion._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Constructs a new instance of the `Quaternion` class
-
-
-</td></tr>
-</tbody></table>
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[magnitude](./server.hytopia.quaternion.magnitude.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-The magnitude of the quaternion. Also known as the length.
-
-
-</td></tr>
-<tr><td>
-
-[squaredMagnitude](./server.hytopia.quaternion.squaredmagnitude.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-The squared magnitude of the quaternion. Also known as the squared length.
-
-
-</td></tr>
-<tr><td>
-
-[w](./server.hytopia.quaternion.w.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-The w-component of the quaternion.
-
-
-</td></tr>
-<tr><td>
-
-[x](./server.hytopia.quaternion.x.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-The x-component of the quaternion.
-
-
-</td></tr>
-<tr><td>
-
-[y](./server.hytopia.quaternion.y.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-The y-component of the quaternion.
-
-
-</td></tr>
-<tr><td>
-
-[z](./server.hytopia.quaternion.z.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-The z-component of the quaternion.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[clone()](./server.hytopia.quaternion.clone.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Creates a clone of the current quaternion.
-
-
-</td></tr>
-<tr><td>
-
-[conjugate()](./server.hytopia.quaternion.conjugate.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Conjugates the current quaternion.
-
-
-</td></tr>
-<tr><td>
-
-[copy(quaternion)](./server.hytopia.quaternion.copy.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Copies the components of a `QuaternionLike` object to the current quaternion.
-
-
-</td></tr>
-<tr><td>
-
-[dot(quaternion)](./server.hytopia.quaternion.dot.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Calculates the dot product of the current quaternion and another quaternion.
-
-
-</td></tr>
-<tr><td>
-
-[equals(quaternion)](./server.hytopia.quaternion.equals.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Checks if the current quaternion is approximately equal to another quaternion.
-
-
-</td></tr>
-<tr><td>
-
-[exactEquals(quaternion)](./server.hytopia.quaternion.exactequals.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Checks if the current quaternion is exactly equal to another quaternion.
-
-
-</td></tr>
-<tr><td>
-
-[exponential()](./server.hytopia.quaternion.exponential.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Calculates and sets the current quaternion to its exponential.
-
-
-</td></tr>
-<tr><td>
-
-[fromEuler(x, y, z)](./server.hytopia.quaternion.fromeuler.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Creates a quaternion from Euler angles.
-
-
-</td></tr>
-<tr><td>
-
-[fromQuaternionLike(quaternionLike)](./server.hytopia.quaternion.fromquaternionlike.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Creates a quaternion from a `QuaternionLike` object.
-
-
-</td></tr>
-<tr><td>
-
-[getAngle(quaternion)](./server.hytopia.quaternion.getangle.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Calculates and returns the angle between the current quaternion and another quaternion.
-
-
-</td></tr>
-<tr><td>
-
-[invert()](./server.hytopia.quaternion.invert.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Inverts each component of the quaternion.
-
-
-</td></tr>
-<tr><td>
-
-[lerp(quaternion, t)](./server.hytopia.quaternion.lerp.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Linearly interpolates between the current quaternion and another quaternion.
-
-
-</td></tr>
-<tr><td>
-
-[multiply(quaternion)](./server.hytopia.quaternion.multiply.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Multiplies the quaternion by another quaternion.
-
-
-</td></tr>
-<tr><td>
-
-[normalize()](./server.hytopia.quaternion.normalize.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Normalizes the quaternion.
-
-
-</td></tr>
-<tr><td>
-
-[rotateX(angle)](./server.hytopia.quaternion.rotatex.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Rotates the quaternion around the x-axis.
-
-
-</td></tr>
-<tr><td>
-
-[rotateY(angle)](./server.hytopia.quaternion.rotatey.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Rotates the quaternion around the y-axis.
-
-
-</td></tr>
-<tr><td>
-
-[rotateZ(angle)](./server.hytopia.quaternion.rotatez.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Rotates the quaternion around the z-axis.
-
-
-</td></tr>
-<tr><td>
-
-[scale(scale)](./server.hytopia.quaternion.scale.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Scales the quaternion by a scalar value.
-
-
-</td></tr>
-<tr><td>
-
-[slerp(quaternion, t)](./server.hytopia.quaternion.slerp.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Spherically interpolates between the current quaternion and another quaternion.
-
-
-</td></tr>
-<tr><td>
-
-[toString()](./server.hytopia.quaternion.tostring.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Returns a string representation of the quaternion in x,y,z,w format.
-
-
-</td></tr>
-</tbody></table>

package/docs/server.hytopia.quaternion.multiply.md

@@ -1,53 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Quaternion](./server.hytopia.quaternion.md) &gt; [multiply](./server.hytopia.quaternion.multiply.md)
-
-## HYTOPIA.Quaternion.multiply() method
-
-Multiplies the quaternion by another quaternion.
-
-**Signature:**
-
-```typescript
-multiply(quaternion: Quaternion): Quaternion;
-```
-
-## 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>
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-[Quaternion](./server.quaternion.md)
-
-The current quaternion.
-

package/docs/server.hytopia.quaternion.normalize.md

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

package/docs/server.hytopia.quaternion.rotatex.md

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Quaternion](./server.hytopia.quaternion.md) &gt; [rotateX](./server.hytopia.quaternion.rotatex.md)
-
-## HYTOPIA.Quaternion.rotateX() method
-
-Rotates the quaternion around the x-axis.
-
-**Signature:**
-
-```typescript
-rotateX(angle: number): Quaternion;
-```
-
-## 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 to rotate in degrees.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-[Quaternion](./server.quaternion.md)
-
-The current quaternion.
-

package/docs/server.hytopia.quaternion.rotatey.md

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Quaternion](./server.hytopia.quaternion.md) &gt; [rotateY](./server.hytopia.quaternion.rotatey.md)
-
-## HYTOPIA.Quaternion.rotateY() method
-
-Rotates the quaternion around the y-axis.
-
-**Signature:**
-
-```typescript
-rotateY(angle: number): Quaternion;
-```
-
-## 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 to rotate in degrees.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-[Quaternion](./server.quaternion.md)
-
-The current quaternion.
-

package/docs/server.hytopia.quaternion.rotatez.md

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Quaternion](./server.hytopia.quaternion.md) &gt; [rotateZ](./server.hytopia.quaternion.rotatez.md)
-
-## HYTOPIA.Quaternion.rotateZ() method
-
-Rotates the quaternion around the z-axis.
-
-**Signature:**
-
-```typescript
-rotateZ(angle: number): Quaternion;
-```
-
-## 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 to rotate in degrees.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-[Quaternion](./server.quaternion.md)
-
-The current quaternion.
-