hytopia 0.2.3 → 0.2.4

package/docs/server.matrix3.md

@@ -97,7 +97,7 @@ The determinant of the matrix.
 </td></tr>
 <tr><td>
 
-[frobeniusNormal](./server.matrix3.frobeniusnormal.md)
+[frobeniusNorm](./server.matrix3.frobeniusnorm.md)
 
 
 </td><td>
@@ -112,7 +112,7 @@ number
 
 </td><td>
 
-The frobenius normal of the matrix.
+The frobenius norm of the matrix.
 
 
 </td></tr>
@@ -312,7 +312,7 @@ Creates a new `Matrix3` instance from a scale of identity matrix.
 
 </td><td>
 
-Creates a new `Matrix3` instance from a translation of identity matrix.
+Creates a new `Matrix3` instance from a translation of identity matrix. This is used only when working with two-dimensional homogeneous coordinates, which is why the `translation` parameter is a `Vector2`<!-- -->.
 
 
 </td></tr>
@@ -382,7 +382,7 @@ Multiplies each element of the current matrix by a scalar value.
 
 </td><td>
 
-Sets the current matrix to a projection matrix with the given bounds.
+Sets the current matrix to a orthographic projection matrix with the given bounds.
 
 
 </td></tr>
@@ -427,6 +427,20 @@ Subtracts a matrix from the current matrix.
 Returns a string representation of the current matrix.
 
 
+</td></tr>
+<tr><td>
+
+[transformVector(vector)](./server.matrix3.transformvector.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Multiplies the provided vector3 by this matrix. This modifies the vector in-place, but also returns the transformed vector.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.matrix3.projection.md

@@ -4,7 +4,7 @@
 
 ## Matrix3.projection() method
 
-Sets the current matrix to a projection matrix with the given bounds.
+Sets the current matrix to a orthographic projection matrix with the given bounds.
 
 **Signature:**
 

package/docs/server.matrix3.transformvector.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; [transformVector](./server.matrix3.transformvector.md)
+
+## Matrix3.transformVector() method
+
+Multiplies the provided vector3 by this matrix. This modifies the vector in-place, but also returns the transformed vector.
+
+**Signature:**
+
+```typescript
+transformVector(vector: Vector3): Vector3;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+vector
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The vector to multiply by this.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector3](./server.vector3.md)
+
+The transformed vector.
+

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

package/docs/server.matrix4.md

@@ -97,7 +97,7 @@ The determinant of the matrix.
 </td></tr>
 <tr><td>
 
-[frobeniusNormal](./server.matrix4.frobeniusnormal.md)
+[frobeniusNorm](./server.matrix4.frobeniusnorm.md)
 
 
 </td><td>
@@ -112,7 +112,7 @@ number
 
 </td><td>
 
-The frobenius normal of the matrix.
+The frobenius norm of the matrix.
 
 
 </td></tr>
@@ -482,7 +482,7 @@ Multiplies each element of the current matrix by a scalar value.
 </td></tr>
 <tr><td>
 
-[orthogonal(left, right, bottom, top, near, far)](./server.matrix4.orthogonal.md)
+[orthographic(left, right, bottom, top, near, far)](./server.matrix4.orthographic.md)
 
 
 </td><td>
@@ -490,7 +490,7 @@ Multiplies each element of the current matrix by a scalar value.
 
 </td><td>
 
-Sets the current matrix to an orthogonal matrix with the given bounds.
+Sets the current matrix to an orthographic projection matrix with the given bounds.
 
 
 </td></tr>

package/docs/{server.matrix4.orthogonal.md → server.matrix4.orthographic.md}

@@ -1,15 +1,15 @@
 <!-- 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; [orthogonal](./server.matrix4.orthogonal.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [Matrix4](./server.matrix4.md) &gt; [orthographic](./server.matrix4.orthographic.md)
 
-## Matrix4.orthogonal() method
+## Matrix4.orthographic() method
 
-Sets the current matrix to an orthogonal matrix with the given bounds.
+Sets the current matrix to an orthographic projection matrix with the given bounds.
 
 **Signature:**
 
 ```typescript
-orthogonal(left: number, right: number, bottom: number, top: number, near: number, far: number): Matrix4;
+orthographic(left: number, right: number, bottom: number, top: number, near: number, far: number): Matrix4;
 ```
 
 ## Parameters
@@ -42,7 +42,7 @@ number
 
 </td><td>
 
-The left bound of the projection.
+The left bound of the frustum.
 
 
 </td></tr>
@@ -58,7 +58,7 @@ number
 
 </td><td>
 
-The right bound of the projection.
+The right bound of the frustum.
 
 
 </td></tr>
@@ -74,7 +74,7 @@ number
 
 </td><td>
 
-The bottom bound of the projection.
+The bottom bound of the frustum.
 
 
 </td></tr>
@@ -90,7 +90,7 @@ number
 
 </td><td>
 
-The top bound of the projection.
+The top bound of the frustum.
 
 
 </td></tr>
@@ -106,7 +106,7 @@ number
 
 </td><td>
 
-The near bound of the projection.
+The near bound of the frustum.
 
 
 </td></tr>
@@ -122,7 +122,7 @@ number
 
 </td><td>
 
-The far bound of the projection.
+The far bound of the frustum.
 
 
 </td></tr>

package/docs/server.quaternion.md

@@ -609,5 +609,19 @@ Spherically interpolates between the current quaternion and another quaternion.
 Returns a string representation of the quaternion in x,y,z,w format.
 
 
+</td></tr>
+<tr><td>
+
+[transformVector(vector)](./server.quaternion.transformvector.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Rotates the provided vector by the rotation this quaternion represents. This modifies the vector in-place, but also returns the rotated vector.
+
+
 </td></tr>
 </tbody></table>

package/docs/server.quaternion.transformvector.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; [Quaternion](./server.quaternion.md) &gt; [transformVector](./server.quaternion.transformvector.md)
+
+## Quaternion.transformVector() method
+
+Rotates the provided vector by the rotation this quaternion represents. This modifies the vector in-place, but also returns the rotated vector.
+
+**Signature:**
+
+```typescript
+transformVector(vector: Vector3): Vector3;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+vector
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+the vector to rotate
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector3](./server.vector3.md)
+
+the rotated vector.
+

package/docs/server.vector2.md

@@ -303,20 +303,6 @@ Copies the components of a vector to the current vector.
 Creates a new `Vector2` instance.
 
 
-</td></tr>
-<tr><td>
-
-[cross(vector2)](./server.vector2.cross.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Calculates the cross product of the current vector and another vector.
-
-
 </td></tr>
 <tr><td>
 

package/docs/server.vector3.dot.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; [Vector3](./server.vector3.md) &gt; [dot](./server.vector3.dot.md)
+
+## Vector3.dot() method
+
+Returns the dot product of this vector and another vector.
+
+**Signature:**
+
+```typescript
+dot(vector3: Vector3): number;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+vector3
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+the other vector
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+number
+
+the dot product of this and vector3
+

package/docs/server.vector3.md

@@ -350,6 +350,20 @@ Calculates the distance between the current vector and another vector.
 Divides each component of the current vector by the corresponding component of another vector.
 
 
+</td></tr>
+<tr><td>
+
+[dot(vector3)](./server.vector3.dot.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Returns the dot product of this vector and another vector.
+
+
 </td></tr>
 <tr><td>