Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation - Getting start #18

Merged
merged 13 commits into from
Sep 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ const main = new Main();
```
</details>

## Override Typescript Type Definition
## Override TypeScript Type Definition

To extend the definitions of `three`, go into `ts.config` and add this path:

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/api/classes/Cameras.OrthographicCameraAuto.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ OrthographicCamera.constructor

#### Defined in

[src/cameras/OrthographicCameraAuto.ts:36](https://github.com/agargaro/three.ez/blob/46fae0a/src/cameras/OrthographicCameraAuto.ts#L36)
[src/cameras/OrthographicCameraAuto.ts:36](https://github.com/agargaro/three.ez/blob/ba52259/src/cameras/OrthographicCameraAuto.ts#L36)

## Accessors

Expand All @@ -52,7 +52,7 @@ If true, the 'size' property will refer to the width. If not, to the height.

#### Defined in

[src/cameras/OrthographicCameraAuto.ts:24](https://github.com/agargaro/three.ez/blob/46fae0a/src/cameras/OrthographicCameraAuto.ts#L24)
[src/cameras/OrthographicCameraAuto.ts:24](https://github.com/agargaro/three.ez/blob/ba52259/src/cameras/OrthographicCameraAuto.ts#L24)

___

Expand All @@ -68,4 +68,4 @@ Fixed width or height dimension based on the 'fixedWidth' property.

#### Defined in

[src/cameras/OrthographicCameraAuto.ts:15](https://github.com/agargaro/three.ez/blob/46fae0a/src/cameras/OrthographicCameraAuto.ts#L15)
[src/cameras/OrthographicCameraAuto.ts:15](https://github.com/agargaro/three.ez/blob/ba52259/src/cameras/OrthographicCameraAuto.ts#L15)
2 changes: 1 addition & 1 deletion docs/docs/api/classes/Cameras.PerspectiveCameraAuto.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ PerspectiveCamera.constructor

#### Defined in

[src/cameras/PerspectiveCameraAuto.ts:13](https://github.com/agargaro/three.ez/blob/46fae0a/src/cameras/PerspectiveCameraAuto.ts#L13)
[src/cameras/PerspectiveCameraAuto.ts:13](https://github.com/agargaro/three.ez/blob/ba52259/src/cameras/PerspectiveCameraAuto.ts#L13)
48 changes: 24 additions & 24 deletions docs/docs/api/classes/Core.Main.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ It provides configuration options and methods for setting up and controlling the

#### Defined in

[src/core/Main.ts:140](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L140)
[src/core/Main.ts:140](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L140)

## Properties

Expand All @@ -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/46fae0a/src/core/Main.ts#L42)
[src/core/Main.ts:42](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L42)

## Accessors

Expand All @@ -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/46fae0a/src/core/Main.ts#L74)
[src/core/Main.ts:74](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L74)

___

Expand All @@ -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/46fae0a/src/core/Main.ts#L79)
[src/core/Main.ts:79](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L79)

___

Expand All @@ -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/46fae0a/src/core/Main.ts#L69)
[src/core/Main.ts:69](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L69)

___

Expand All @@ -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/46fae0a/src/core/Main.ts#L64)
[src/core/Main.ts:64](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L64)

___

Expand All @@ -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/46fae0a/src/core/Main.ts#L128)
[src/core/Main.ts:128](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L128)

___

Expand All @@ -132,7 +132,7 @@ The default background color used in the application.

#### Defined in

[src/core/Main.ts:122](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L122)
[src/core/Main.ts:122](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L122)

___

Expand All @@ -148,7 +148,7 @@ A boolean flag indicating whether to enable cursor handling in the application.

#### Defined in

[src/core/Main.ts:105](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L105)
[src/core/Main.ts:105](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L105)

___

Expand All @@ -165,7 +165,7 @@ 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/46fae0a/src/core/Main.ts#L135)
[src/core/Main.ts:135](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L135)

___

Expand All @@ -181,7 +181,7 @@ A boolean flag indicating whether to enable multitouch interactions.

#### Defined in

[src/core/Main.ts:99](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L99)
[src/core/Main.ts:99](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L99)

___

Expand All @@ -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/46fae0a/src/core/Main.ts#L117)
[src/core/Main.ts:117](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L117)

___

Expand All @@ -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/46fae0a/src/core/Main.ts#L111)
[src/core/Main.ts:111](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L111)

___

Expand All @@ -229,7 +229,7 @@ The WebGLRenderer instance used for rendering the 3D scene.

#### Defined in

[src/core/Main.ts:53](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L53)
[src/core/Main.ts:53](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L53)

___

Expand All @@ -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/46fae0a/src/core/Main.ts#L85)
[src/core/Main.ts:85](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L85)

___

Expand All @@ -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/46fae0a/src/core/Main.ts#L59)
[src/core/Main.ts:59](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L59)

## Methods

Expand All @@ -285,7 +285,7 @@ Adds a RenderView to the RenderManager.

#### Defined in

[src/core/Main.ts:212](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L212)
[src/core/Main.ts:212](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L212)

___

Expand All @@ -301,7 +301,7 @@ Clears all RenderViews from the RenderManager.

#### Defined in

[src/core/Main.ts:244](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L244)
[src/core/Main.ts:244](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L244)

___

Expand All @@ -325,7 +325,7 @@ The created RenderView instance.

#### Defined in

[src/core/Main.ts:204](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L204)
[src/core/Main.ts:204](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L204)

___

Expand All @@ -347,7 +347,7 @@ Retrieves a RenderView by mouse position.

#### Defined in

[src/core/Main.ts:252](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L252)
[src/core/Main.ts:252](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L252)

___

Expand All @@ -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/46fae0a/src/core/Main.ts#L221)
[src/core/Main.ts:221](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L221)

___

Expand All @@ -393,7 +393,7 @@ Removes a RenderView from the RenderManager.

#### Defined in

[src/core/Main.ts:229](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L229)
[src/core/Main.ts:229](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L229)

___

Expand All @@ -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/46fae0a/src/core/Main.ts#L237)
[src/core/Main.ts:237](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L237)

___

Expand All @@ -437,4 +437,4 @@ Sets active RenderViews by tag.

#### Defined in

[src/core/Main.ts:260](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L260)
[src/core/Main.ts:260](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L260)
Loading