Update api documentation (#35)

agargaro · Sep 24, 2023 · ff1590a · ff1590a
1 parent a81f57c
commit ff1590a
Show file tree

Hide file tree

Showing 39 changed files with 2,767 additions and 547 deletions.
diff --git a/docs/docs/api/classes/Cameras.OrthographicCameraAuto.md b/docs/docs/api/classes/Cameras.OrthographicCameraAuto.md
diff --git a/docs/docs/api/classes/Cameras.PerspectiveCameraAuto.md b/docs/docs/api/classes/Cameras.PerspectiveCameraAuto.md
diff --git a/docs/docs/api/classes/Core.Main.md b/docs/docs/api/classes/Core.Main.md
@@ -20,11 +20,11 @@ It provides configuration options and methods for setting up and controlling the
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `parameters` | [`MainParameters`](../interfaces/Core.MainParameters.md) | Represents the configuration parameters for initializing the Main class. |
+| `parameters` | [`MainParameters`](../interfaces/Core.MainParameters.md) | Configuration parameters for initializing the Main class. |
 
 #### Defined in
 
-[src/core/Main.ts:140](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L140)
+[src/core/Main.ts:140](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L140)
 
 ## Properties
 
@@ -36,7 +36,7 @@ A static counter representing the number of animation frames elapsed.
 
 #### Defined in
 
-[src/core/Main.ts:42](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L42)
+[src/core/Main.ts:42](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L42)
 
 ## Accessors
 
@@ -52,7 +52,7 @@ The Camera associated with the currently active RenderView.
 
 #### Defined in
 
-[src/core/Main.ts:74](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L74)
+[src/core/Main.ts:74](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L74)
 
 ___
 
@@ -68,7 +68,7 @@ The EffectComposer (used for post-processing) associated with the currently acti
 
 #### Defined in
 
-[src/core/Main.ts:79](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L79)
+[src/core/Main.ts:79](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L79)
 
 ___
 
@@ -84,7 +84,7 @@ The Scene associated with the currently active RenderView.
 
 #### Defined in
 
-[src/core/Main.ts:69](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L69)
+[src/core/Main.ts:69](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L69)
 
 ___
 
@@ -100,7 +100,7 @@ The currently active RenderView (activated by mouse position).
 
 #### Defined in
 
-[src/core/Main.ts:64](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L64)
+[src/core/Main.ts:64](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L64)
 
 ___
 
@@ -116,7 +116,7 @@ The default alpha (transparency) value for the background.
 
 #### Defined in
 
-[src/core/Main.ts:128](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L128)
+[src/core/Main.ts:128](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L128)
 
 ___
 
@@ -132,23 +132,23 @@ The default background color used in the application.
 
 #### Defined in
 
-[src/core/Main.ts:122](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L122)
+[src/core/Main.ts:122](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L122)
 
 ___
 
 ### enableCursor
 
 • `get` **enableCursor**(): `boolean`
 
-A boolean flag indicating whether to enable cursor handling in the application.
+Indicates whether to enable cursor handling in the application.
 
 #### Returns
 
 `boolean`
 
 #### Defined in
 
-[src/core/Main.ts:105](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L105)
+[src/core/Main.ts:105](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L105)
 
 ___
 
@@ -165,23 +165,23 @@ Provides the x and y coordinates of the mouse pointer within the application.
 
 #### Defined in
 
-[src/core/Main.ts:135](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L135)
+[src/core/Main.ts:135](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L135)
 
 ___
 
 ### multitouch
 
 • `get` **multitouch**(): `boolean`
 
-A boolean flag indicating whether to enable multitouch interactions.
+Indicates whether to enable multitouch interactions.
 
 #### Returns
 
 `boolean`
 
 #### Defined in
 
-[src/core/Main.ts:99](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L99)
+[src/core/Main.ts:99](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L99)
 
 ___
 
@@ -197,7 +197,7 @@ A Raycaster instance responsible for handling raycasting operations in the appli
 
 #### Defined in
 
-[src/core/Main.ts:117](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L117)
+[src/core/Main.ts:117](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L117)
 
 ___
 
@@ -213,7 +213,7 @@ A custom sorting comparer function used to order intersections when performing r
 
 #### Defined in
 
-[src/core/Main.ts:111](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L111)
+[src/core/Main.ts:111](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L111)
 
 ___
 
@@ -229,15 +229,15 @@ The WebGLRenderer instance used for rendering the 3D scene.
 
 #### Defined in
 
-[src/core/Main.ts:53](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L53)
+[src/core/Main.ts:53](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L53)
 
 ___
 
 ### showStats
 
 • `get` **showStats**(): `boolean`
 
-A boolean flag indicating whether to display performance statistics.
+Indicates whether to display performance statistics.
 If set to true, statistics will be shown; otherwise, they will be hidden.
 
 #### Returns
@@ -246,7 +246,7 @@ If set to true, statistics will be shown; otherwise, they will be hidden.
 
 #### Defined in
 
-[src/core/Main.ts:85](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L85)
+[src/core/Main.ts:85](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L85)
 
 ___
 
@@ -263,7 +263,7 @@ Lists all views created and managed by the application, each representing a sepa
 
 #### Defined in
 
-[src/core/Main.ts:59](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L59)
+[src/core/Main.ts:59](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L59)
 
 ## Methods
 
@@ -285,7 +285,7 @@ Adds a RenderView to the RenderManager.
 
 #### Defined in
 
-[src/core/Main.ts:212](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L212)
+[src/core/Main.ts:212](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L212)
 
 ___
 
@@ -301,7 +301,7 @@ Clears all RenderViews from the RenderManager.
 
 #### Defined in
 
-[src/core/Main.ts:244](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L244)
+[src/core/Main.ts:244](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L244)
 
 ___
 
@@ -325,7 +325,7 @@ The created RenderView instance.
 
 #### Defined in
 
-[src/core/Main.ts:204](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L204)
+[src/core/Main.ts:204](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L204)
 
 ___
 
@@ -347,7 +347,7 @@ Retrieves a RenderView by mouse position.
 
 #### Defined in
 
-[src/core/Main.ts:252](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L252)
+[src/core/Main.ts:252](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L252)
 
 ___
 
@@ -371,7 +371,7 @@ The RenderView with the specified tag, if found, otherwise, undefined.
 
 #### Defined in
 
-[src/core/Main.ts:221](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L221)
+[src/core/Main.ts:221](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L221)
 
 ___
 
@@ -393,7 +393,7 @@ Removes a RenderView from the RenderManager.
 
 #### Defined in
 
-[src/core/Main.ts:229](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L229)
+[src/core/Main.ts:229](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L229)
 
 ___
 
@@ -415,7 +415,7 @@ Removes a RenderView from the RenderManager by its tag.
 
 #### Defined in
 
-[src/core/Main.ts:237](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L237)
+[src/core/Main.ts:237](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L237)
 
 ___
 
@@ -437,4 +437,4 @@ Sets active RenderViews by tag.
 
 #### Defined in
 
-[src/core/Main.ts:260](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L260)
+[src/core/Main.ts:260](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L260)