hytopia 0.2.1 → 0.2.3

package/docs/server.matrix4.multiplyscalar.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; [multiplyScalar](./server.matrix4.multiplyscalar.md)
+
+## Matrix4.multiplyScalar() method
+
+Multiplies each element of the current matrix by a scalar value.
+
+**Signature:**
+
+```typescript
+multiplyScalar(scalar: number): Matrix4;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+scalar
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The scalar value to multiply the current matrix elements by.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+The current matrix.
+

package/docs/server.matrix4.orthogonal.md

@@ -0,0 +1,135 @@
+<!-- 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)
+
+## Matrix4.orthogonal() method
+
+Sets the current matrix to an orthogonal matrix with the given bounds.
+
+**Signature:**
+
+```typescript
+orthogonal(left: number, right: number, bottom: number, top: number, near: number, far: number): Matrix4;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+left
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The left bound of the projection.
+
+
+</td></tr>
+<tr><td>
+
+right
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The right bound of the projection.
+
+
+</td></tr>
+<tr><td>
+
+bottom
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The bottom bound of the projection.
+
+
+</td></tr>
+<tr><td>
+
+top
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The top bound of the projection.
+
+
+</td></tr>
+<tr><td>
+
+near
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The near bound of the projection.
+
+
+</td></tr>
+<tr><td>
+
+far
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The far bound of the projection.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+The current matrix.
+

package/docs/server.matrix4.perspective.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; [perspective](./server.matrix4.perspective.md)
+
+## Matrix4.perspective() method
+
+Sets the current matrix to a perspective matrix with the given field of view, aspect ratio, and near and far bounds.
+
+**Signature:**
+
+```typescript
+perspective(fovy: number, aspect: number, near: number, far: number): Matrix4;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+fovy
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The field of view of the projection.
+
+
+</td></tr>
+<tr><td>
+
+aspect
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The aspect ratio of the projection.
+
+
+</td></tr>
+<tr><td>
+
+near
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The near bound of the projection.
+
+
+</td></tr>
+<tr><td>
+
+far
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The far bound of the projection.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+The current matrix.
+

package/docs/server.matrix4.rotate.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; [rotate](./server.matrix4.rotate.md)
+
+## Matrix4.rotate() method
+
+Rotates the current matrix by an angle in radians around an axis.
+
+**Signature:**
+
+```typescript
+rotate(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 current matrix by.
+
+
+</td></tr>
+<tr><td>
+
+axis
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The axis to rotate the current matrix around.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+The current matrix.
+

package/docs/server.matrix4.rotatex.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; [rotateX](./server.matrix4.rotatex.md)
+
+## Matrix4.rotateX() method
+
+Rotates the current matrix by an angle in radians around the x-axis.
+
+**Signature:**
+
+```typescript
+rotateX(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 current matrix by.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+The current matrix.
+

package/docs/server.matrix4.rotatey.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; [rotateY](./server.matrix4.rotatey.md)
+
+## Matrix4.rotateY() method
+
+Rotates the current matrix by an angle in radians around the y-axis.
+
+**Signature:**
+
+```typescript
+rotateY(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 current matrix by.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+The current matrix.
+

package/docs/server.matrix4.rotatez.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; [rotateZ](./server.matrix4.rotatez.md)
+
+## Matrix4.rotateZ() method
+
+Rotates the current matrix by an angle in radians around the z-axis.
+
+**Signature:**
+
+```typescript
+rotateZ(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 current matrix by.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+The current matrix.
+

package/docs/server.matrix4.scale.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; [scale](./server.matrix4.scale.md)
+
+## Matrix4.scale() method
+
+Scales the current matrix by a vector.
+
+**Signature:**
+
+```typescript
+scale(vector3: Vector3): Matrix4;
+```
+
+## 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 vector to scale the current matrix by.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+The current matrix.
+

package/docs/server.matrix4.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; [Matrix4](./server.matrix4.md) &gt; [subtract](./server.matrix4.subtract.md)
+
+## Matrix4.subtract() method
+
+Subtracts a matrix from the current matrix.
+
+**Signature:**
+
+```typescript
+subtract(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 subtract from the current matrix.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+The current matrix.
+

package/docs/server.matrix4.targetto.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; [targetTo](./server.matrix4.targetto.md)
+
+## Matrix4.targetTo() method
+
+Sets the current matrix to a matrix that looks at a target.
+
+**Signature:**
+
+```typescript
+targetTo(eye: Vector3, center: Vector3, up: Vector3): Matrix4;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+eye
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The eye vector of the camera.
+
+
+</td></tr>
+<tr><td>
+
+center
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The center vector of the camera.
+
+
+</td></tr>
+<tr><td>
+
+up
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The up vector of the camera.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Matrix4](./server.matrix4.md)
+
+The current matrix.
+