diff --git a/README.md b/README.md index d46a7ee..0262e57 100644 --- a/README.md +++ b/README.md @@ -138,7 +138,7 @@ const main = new Main(); ``` -## Override Typescript Type Definition +## Override TypeScript Type Definition To extend the definitions of `three`, go into `ts.config` and add this path: diff --git a/docs/docs/api/classes/Cameras.OrthographicCameraAuto.md b/docs/docs/api/classes/Cameras.OrthographicCameraAuto.md index b68b7d2..4528c63 100644 --- a/docs/docs/api/classes/Cameras.OrthographicCameraAuto.md +++ b/docs/docs/api/classes/Cameras.OrthographicCameraAuto.md @@ -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 @@ -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) ___ @@ -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) diff --git a/docs/docs/api/classes/Cameras.PerspectiveCameraAuto.md b/docs/docs/api/classes/Cameras.PerspectiveCameraAuto.md index b1d5c54..c4df8aa 100644 --- a/docs/docs/api/classes/Cameras.PerspectiveCameraAuto.md +++ b/docs/docs/api/classes/Cameras.PerspectiveCameraAuto.md @@ -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) diff --git a/docs/docs/api/classes/Core.Main.md b/docs/docs/api/classes/Core.Main.md index 75b7773..c4e1793 100644 --- a/docs/docs/api/classes/Core.Main.md +++ b/docs/docs/api/classes/Core.Main.md @@ -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 @@ -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 @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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 @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) diff --git a/docs/docs/api/classes/Events.DragEventExt.md b/docs/docs/api/classes/Events.DragEventExt.md index e8cad60..166cf67 100644 --- a/docs/docs/api/classes/Events.DragEventExt.md +++ b/docs/docs/api/classes/Events.DragEventExt.md @@ -52,7 +52,7 @@ Represents a custom extended drag event. #### Defined in -[src/events/Events.ts:268](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L268) +[src/events/Events.ts:268](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L268) ## Properties @@ -68,7 +68,7 @@ A boolean value indicating whether the event is cancelable. #### Defined in -[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L115) +[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L115) ___ @@ -84,7 +84,7 @@ A reference to the currently registered target for the event. This is the object #### Defined in -[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L117) +[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L117) ___ @@ -100,7 +100,7 @@ The data that is transferred during a drag and drop interaction. #### Defined in -[src/events/Events.ts:256](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L256) +[src/events/Events.ts:256](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L256) ___ @@ -116,7 +116,7 @@ Returns the intersection information between the mouse event and 3D objects in t #### Defined in -[src/events/Events.ts:199](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L199) +[src/events/Events.ts:199](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L199) ___ @@ -128,7 +128,7 @@ Returns the new position of the dragged object.' #### Defined in -[src/events/Events.ts:258](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L258) +[src/events/Events.ts:258](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L258) ___ @@ -144,7 +144,7 @@ The secondary target for the event, if there is one. #### Defined in -[src/events/Events.ts:191](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L191) +[src/events/Events.ts:191](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L191) ___ @@ -160,7 +160,7 @@ The time at which the event was created (in milliseconds). By specification, thi #### Defined in -[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L123) +[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L123) ## Accessors @@ -180,7 +180,7 @@ PointerEventExt.altKey #### Defined in -[src/events/Events.ts:165](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L165) +[src/events/Events.ts:165](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L165) ___ @@ -200,7 +200,7 @@ PointerEventExt.bubbles #### Defined in -[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L113) +[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L113) ___ @@ -220,7 +220,7 @@ PointerEventExt.button #### Defined in -[src/events/Events.ts:167](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L167) +[src/events/Events.ts:167](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L167) ___ @@ -240,7 +240,7 @@ PointerEventExt.buttons #### Defined in -[src/events/Events.ts:169](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L169) +[src/events/Events.ts:169](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L169) ___ @@ -260,7 +260,7 @@ PointerEventExt.clientX #### Defined in -[src/events/Events.ts:171](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L171) +[src/events/Events.ts:171](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L171) ___ @@ -280,7 +280,7 @@ PointerEventExt.clientY #### Defined in -[src/events/Events.ts:173](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L173) +[src/events/Events.ts:173](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L173) ___ @@ -300,7 +300,7 @@ PointerEventExt.ctrlKey #### Defined in -[src/events/Events.ts:175](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L175) +[src/events/Events.ts:175](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L175) ___ @@ -320,7 +320,7 @@ PointerEventExt.defaultPrevented #### Defined in -[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L119) +[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L119) ___ @@ -340,7 +340,7 @@ PointerEventExt.height #### Defined in -[src/events/Events.ts:232](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L232) +[src/events/Events.ts:232](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L232) ___ @@ -360,7 +360,7 @@ PointerEventExt.isPrimary #### Defined in -[src/events/Events.ts:246](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L246) +[src/events/Events.ts:246](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L246) ___ @@ -380,7 +380,7 @@ PointerEventExt.metaKey #### Defined in -[src/events/Events.ts:177](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L177) +[src/events/Events.ts:177](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L177) ___ @@ -400,7 +400,7 @@ PointerEventExt.movementX #### Defined in -[src/events/Events.ts:179](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L179) +[src/events/Events.ts:179](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L179) ___ @@ -420,7 +420,7 @@ PointerEventExt.movementY #### Defined in -[src/events/Events.ts:181](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L181) +[src/events/Events.ts:181](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L181) ___ @@ -440,7 +440,7 @@ PointerEventExt.offsetX #### Defined in -[src/events/Events.ts:183](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L183) +[src/events/Events.ts:183](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L183) ___ @@ -460,7 +460,7 @@ PointerEventExt.offsetY #### Defined in -[src/events/Events.ts:185](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L185) +[src/events/Events.ts:185](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L185) ___ @@ -480,7 +480,7 @@ PointerEventExt.pageX #### Defined in -[src/events/Events.ts:187](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L187) +[src/events/Events.ts:187](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L187) ___ @@ -500,7 +500,7 @@ PointerEventExt.pageY #### Defined in -[src/events/Events.ts:189](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L189) +[src/events/Events.ts:189](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L189) ___ @@ -520,7 +520,7 @@ PointerEventExt.pointerId #### Defined in -[src/events/Events.ts:228](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L228) +[src/events/Events.ts:228](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L228) ___ @@ -540,7 +540,7 @@ PointerEventExt.pointerType #### Defined in -[src/events/Events.ts:244](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L244) +[src/events/Events.ts:244](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L244) ___ @@ -560,7 +560,7 @@ PointerEventExt.pressure #### Defined in -[src/events/Events.ts:234](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L234) +[src/events/Events.ts:234](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L234) ___ @@ -580,7 +580,7 @@ PointerEventExt.screenX #### Defined in -[src/events/Events.ts:193](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L193) +[src/events/Events.ts:193](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L193) ___ @@ -600,7 +600,7 @@ PointerEventExt.screenY #### Defined in -[src/events/Events.ts:195](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L195) +[src/events/Events.ts:195](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L195) ___ @@ -620,7 +620,7 @@ PointerEventExt.shiftKey #### Defined in -[src/events/Events.ts:197](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L197) +[src/events/Events.ts:197](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L197) ___ @@ -640,7 +640,7 @@ PointerEventExt.tangentialPressure #### Defined in -[src/events/Events.ts:236](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L236) +[src/events/Events.ts:236](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L236) ___ @@ -660,7 +660,7 @@ PointerEventExt.target #### Defined in -[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L121) +[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L121) ___ @@ -680,7 +680,7 @@ PointerEventExt.tiltX #### Defined in -[src/events/Events.ts:238](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L238) +[src/events/Events.ts:238](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L238) ___ @@ -700,7 +700,7 @@ PointerEventExt.tiltY #### Defined in -[src/events/Events.ts:240](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L240) +[src/events/Events.ts:240](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L240) ___ @@ -720,7 +720,7 @@ PointerEventExt.twist #### Defined in -[src/events/Events.ts:242](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L242) +[src/events/Events.ts:242](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L242) ___ @@ -740,7 +740,7 @@ PointerEventExt.type #### Defined in -[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L125) +[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L125) ___ @@ -760,7 +760,7 @@ PointerEventExt.width #### Defined in -[src/events/Events.ts:230](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L230) +[src/events/Events.ts:230](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L230) ## Methods @@ -786,7 +786,7 @@ Returns the current state of the specified modifier key. See KeyboardEvent.getMo #### Defined in -[src/events/Events.ts:215](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L215) +[src/events/Events.ts:215](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L215) ___ @@ -806,7 +806,7 @@ Cancels the event. #### Defined in -[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L141) +[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L141) ___ @@ -826,7 +826,7 @@ For this particular event, prevent all other listeners from being called. This i #### Defined in -[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L146) +[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L146) ___ @@ -846,4 +846,4 @@ Stops the propagation of events further along in the Object3D hierarchy. #### Defined in -[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L151) +[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L151) diff --git a/docs/docs/api/classes/Events.EventExt.md b/docs/docs/api/classes/Events.EventExt.md index 0e5575a..e9be1fe 100644 --- a/docs/docs/api/classes/Events.EventExt.md +++ b/docs/docs/api/classes/Events.EventExt.md @@ -47,7 +47,7 @@ Represents a custom extended event. #### Defined in -[src/events/Events.ts:136](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L136) +[src/events/Events.ts:136](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L136) ## Properties @@ -59,7 +59,7 @@ A boolean value indicating whether the event is cancelable. #### Defined in -[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L115) +[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L115) ___ @@ -71,7 +71,7 @@ A reference to the currently registered target for the event. This is the object #### Defined in -[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L117) +[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L117) ___ @@ -83,7 +83,7 @@ The time at which the event was created (in milliseconds). By specification, thi #### Defined in -[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L123) +[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L123) ## Accessors @@ -99,7 +99,7 @@ A boolean value indicating whether or not the event bubbles up through the DOM. #### Defined in -[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L113) +[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L113) ___ @@ -115,7 +115,7 @@ Indicates whether or not the call to event.preventDefault() canceled the event. #### Defined in -[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L119) +[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L119) ___ @@ -131,7 +131,7 @@ A reference to the object to which the event was originally dispatched. #### Defined in -[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L121) +[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L121) ___ @@ -147,7 +147,7 @@ keyof [`MiscEvents`](../interfaces/Events.MiscEvents.md) \| keyof [`InteractionE #### Defined in -[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L125) +[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L125) ## Methods @@ -163,7 +163,7 @@ Cancels the event. #### Defined in -[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L141) +[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L141) ___ @@ -179,7 +179,7 @@ For this particular event, prevent all other listeners from being called. This i #### Defined in -[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L146) +[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L146) ___ @@ -195,4 +195,4 @@ Stops the propagation of events further along in the Object3D hierarchy. #### Defined in -[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L151) +[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L151) diff --git a/docs/docs/api/classes/Events.FocusEventExt.md b/docs/docs/api/classes/Events.FocusEventExt.md index 34591ad..2a8c37b 100644 --- a/docs/docs/api/classes/Events.FocusEventExt.md +++ b/docs/docs/api/classes/Events.FocusEventExt.md @@ -47,7 +47,7 @@ Represents a custom extended focus event. #### Defined in -[src/events/Events.ts:360](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L360) +[src/events/Events.ts:360](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L360) ## Properties @@ -63,7 +63,7 @@ A boolean value indicating whether the event is cancelable. #### Defined in -[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L115) +[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L115) ___ @@ -79,7 +79,7 @@ A reference to the currently registered target for the event. This is the object #### Defined in -[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L117) +[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L117) ___ @@ -91,7 +91,7 @@ The secondary target for the event. #### Defined in -[src/events/Events.ts:355](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L355) +[src/events/Events.ts:355](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L355) ___ @@ -107,7 +107,7 @@ The time at which the event was created (in milliseconds). By specification, thi #### Defined in -[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L123) +[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L123) ## Accessors @@ -127,7 +127,7 @@ EventExt.bubbles #### Defined in -[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L113) +[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L113) ___ @@ -147,7 +147,7 @@ EventExt.defaultPrevented #### Defined in -[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L119) +[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L119) ___ @@ -167,7 +167,7 @@ EventExt.target #### Defined in -[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L121) +[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L121) ___ @@ -187,7 +187,7 @@ EventExt.type #### Defined in -[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L125) +[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L125) ## Methods @@ -207,7 +207,7 @@ Cancels the event. #### Defined in -[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L141) +[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L141) ___ @@ -227,7 +227,7 @@ For this particular event, prevent all other listeners from being called. This i #### Defined in -[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L146) +[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L146) ___ @@ -247,4 +247,4 @@ Stops the propagation of events further along in the Object3D hierarchy. #### Defined in -[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L151) +[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L151) diff --git a/docs/docs/api/classes/Events.KeyboardEventExt.md b/docs/docs/api/classes/Events.KeyboardEventExt.md index be5e2bd..d60449b 100644 --- a/docs/docs/api/classes/Events.KeyboardEventExt.md +++ b/docs/docs/api/classes/Events.KeyboardEventExt.md @@ -46,7 +46,7 @@ Represents a custom extended keyboard event. #### Defined in -[src/events/Events.ts:337](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L337) +[src/events/Events.ts:337](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L337) ## Properties @@ -62,7 +62,7 @@ A boolean value indicating whether the event is cancelable. #### Defined in -[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L115) +[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L115) ___ @@ -78,7 +78,7 @@ A reference to the currently registered target for the event. This is the object #### Defined in -[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L117) +[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L117) ___ @@ -90,7 +90,7 @@ Original dom event. #### Defined in -[src/events/Events.ts:315](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L315) +[src/events/Events.ts:315](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L315) ___ @@ -106,7 +106,7 @@ The time at which the event was created (in milliseconds). By specification, thi #### Defined in -[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L123) +[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L123) ## Accessors @@ -122,7 +122,7 @@ Returns a boolean value that is true if the Alt (Option or ⌥ on macOS) key was #### Defined in -[src/events/Events.ts:317](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L317) +[src/events/Events.ts:317](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L317) ___ @@ -142,7 +142,7 @@ EventExt.bubbles #### Defined in -[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L113) +[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L113) ___ @@ -158,7 +158,7 @@ Returns a string with the code value of the physical key represented by the even #### Defined in -[src/events/Events.ts:319](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L319) +[src/events/Events.ts:319](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L319) ___ @@ -174,7 +174,7 @@ Returns a boolean value that is true if the Ctrl key was active when the key eve #### Defined in -[src/events/Events.ts:321](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L321) +[src/events/Events.ts:321](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L321) ___ @@ -194,7 +194,7 @@ EventExt.defaultPrevented #### Defined in -[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L119) +[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L119) ___ @@ -210,7 +210,7 @@ Returns a string representing the key value of the key represented by the event. #### Defined in -[src/events/Events.ts:323](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L323) +[src/events/Events.ts:323](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L323) ___ @@ -226,7 +226,7 @@ Returns a number representing the location of the key on the keyboard or other i #### Defined in -[src/events/Events.ts:325](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L325) +[src/events/Events.ts:325](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L325) ___ @@ -242,7 +242,7 @@ Returns a boolean value that is true if the Meta key (on Mac keyboards, the ⌘ #### Defined in -[src/events/Events.ts:327](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L327) +[src/events/Events.ts:327](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L327) ___ @@ -258,7 +258,7 @@ Returns a boolean value that is true if the key is being held down such that it #### Defined in -[src/events/Events.ts:329](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L329) +[src/events/Events.ts:329](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L329) ___ @@ -274,7 +274,7 @@ Returns a boolean value that is true if the Shift key was active when the key ev #### Defined in -[src/events/Events.ts:331](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L331) +[src/events/Events.ts:331](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L331) ___ @@ -294,7 +294,7 @@ EventExt.target #### Defined in -[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L121) +[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L121) ___ @@ -314,7 +314,7 @@ EventExt.type #### Defined in -[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L125) +[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L125) ## Methods @@ -336,7 +336,7 @@ Returns a boolean value indicating if a modifier key such as Alt, Shift, Ctrl, o #### Defined in -[src/events/Events.ts:343](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L343) +[src/events/Events.ts:343](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L343) ___ @@ -356,7 +356,7 @@ Cancels the event. #### Defined in -[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L141) +[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L141) ___ @@ -376,7 +376,7 @@ For this particular event, prevent all other listeners from being called. This i #### Defined in -[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L146) +[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L146) ___ @@ -396,4 +396,4 @@ Stops the propagation of events further along in the Object3D hierarchy. #### Defined in -[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L151) +[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L151) diff --git a/docs/docs/api/classes/Events.MouseEventExt.md b/docs/docs/api/classes/Events.MouseEventExt.md index 9363662..3c1eca0 100644 --- a/docs/docs/api/classes/Events.MouseEventExt.md +++ b/docs/docs/api/classes/Events.MouseEventExt.md @@ -54,7 +54,7 @@ Represents a custom extended mouse event. #### Defined in -[src/events/Events.ts:207](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L207) +[src/events/Events.ts:207](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L207) ## Properties @@ -70,7 +70,7 @@ A boolean value indicating whether the event is cancelable. #### Defined in -[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L115) +[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L115) ___ @@ -86,7 +86,7 @@ A reference to the currently registered target for the event. This is the object #### Defined in -[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L117) +[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L117) ___ @@ -98,7 +98,7 @@ Original dom event. #### Defined in -[src/events/Events.ts:163](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L163) +[src/events/Events.ts:163](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L163) ___ @@ -110,7 +110,7 @@ Returns the intersection information between the mouse event and 3D objects in t #### Defined in -[src/events/Events.ts:199](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L199) +[src/events/Events.ts:199](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L199) ___ @@ -122,7 +122,7 @@ The secondary target for the event, if there is one. #### Defined in -[src/events/Events.ts:191](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L191) +[src/events/Events.ts:191](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L191) ___ @@ -138,7 +138,7 @@ The time at which the event was created (in milliseconds). By specification, thi #### Defined in -[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L123) +[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L123) ## Accessors @@ -154,7 +154,7 @@ Returns true if the alt key was down when the mouse event was fired. #### Defined in -[src/events/Events.ts:165](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L165) +[src/events/Events.ts:165](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L165) ___ @@ -174,7 +174,7 @@ EventExt.bubbles #### Defined in -[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L113) +[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L113) ___ @@ -190,7 +190,7 @@ The button number that was pressed (if applicable) when the mouse event was fire #### Defined in -[src/events/Events.ts:167](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L167) +[src/events/Events.ts:167](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L167) ___ @@ -206,7 +206,7 @@ The buttons being pressed (if any) when the mouse event was fired. #### Defined in -[src/events/Events.ts:169](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L169) +[src/events/Events.ts:169](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L169) ___ @@ -222,7 +222,7 @@ The X coordinate of the mouse pointer in local (DOM content) coordinates. #### Defined in -[src/events/Events.ts:171](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L171) +[src/events/Events.ts:171](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L171) ___ @@ -238,7 +238,7 @@ The Y coordinate of the mouse pointer in local (DOM content) coordinates. #### Defined in -[src/events/Events.ts:173](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L173) +[src/events/Events.ts:173](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L173) ___ @@ -254,7 +254,7 @@ Returns true if the control key was down when the mouse event was fired. #### Defined in -[src/events/Events.ts:175](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L175) +[src/events/Events.ts:175](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L175) ___ @@ -274,7 +274,7 @@ EventExt.defaultPrevented #### Defined in -[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L119) +[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L119) ___ @@ -290,7 +290,7 @@ Returns true if the meta key was down when the mouse event was fired. #### Defined in -[src/events/Events.ts:177](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L177) +[src/events/Events.ts:177](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L177) ___ @@ -306,7 +306,7 @@ The X coordinate of the pointer relative to the position of the last event. #### Defined in -[src/events/Events.ts:179](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L179) +[src/events/Events.ts:179](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L179) ___ @@ -322,7 +322,7 @@ The Y coordinate of the pointer relative to the position of the last event. #### Defined in -[src/events/Events.ts:181](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L181) +[src/events/Events.ts:181](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L181) ___ @@ -338,7 +338,7 @@ The X coordinate of the mouse pointer relative to the position of the padding ed #### Defined in -[src/events/Events.ts:183](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L183) +[src/events/Events.ts:183](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L183) ___ @@ -354,7 +354,7 @@ The Y coordinate of the mouse pointer relative to the position of the padding ed #### Defined in -[src/events/Events.ts:185](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L185) +[src/events/Events.ts:185](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L185) ___ @@ -370,7 +370,7 @@ The X coordinate of the mouse pointer relative to the whole document. #### Defined in -[src/events/Events.ts:187](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L187) +[src/events/Events.ts:187](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L187) ___ @@ -386,7 +386,7 @@ The Y coordinate of the mouse pointer relative to the whole document. #### Defined in -[src/events/Events.ts:189](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L189) +[src/events/Events.ts:189](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L189) ___ @@ -402,7 +402,7 @@ The X coordinate of the mouse pointer in global (screen) coordinates. #### Defined in -[src/events/Events.ts:193](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L193) +[src/events/Events.ts:193](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L193) ___ @@ -418,7 +418,7 @@ The Y coordinate of the mouse pointer in global (screen) coordinates. #### Defined in -[src/events/Events.ts:195](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L195) +[src/events/Events.ts:195](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L195) ___ @@ -434,7 +434,7 @@ Returns true if the shift key was down when the mouse event was fired. #### Defined in -[src/events/Events.ts:197](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L197) +[src/events/Events.ts:197](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L197) ___ @@ -454,7 +454,7 @@ EventExt.target #### Defined in -[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L121) +[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L121) ___ @@ -474,7 +474,7 @@ EventExt.type #### Defined in -[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L125) +[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L125) ## Methods @@ -496,7 +496,7 @@ Returns the current state of the specified modifier key. See KeyboardEvent.getMo #### Defined in -[src/events/Events.ts:215](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L215) +[src/events/Events.ts:215](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L215) ___ @@ -516,7 +516,7 @@ Cancels the event. #### Defined in -[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L141) +[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L141) ___ @@ -536,7 +536,7 @@ For this particular event, prevent all other listeners from being called. This i #### Defined in -[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L146) +[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L146) ___ @@ -556,4 +556,4 @@ Stops the propagation of events further along in the Object3D hierarchy. #### Defined in -[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L151) +[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L151) diff --git a/docs/docs/api/classes/Events.PointerEventExt.md b/docs/docs/api/classes/Events.PointerEventExt.md index b179bc2..b4f5e12 100644 --- a/docs/docs/api/classes/Events.PointerEventExt.md +++ b/docs/docs/api/classes/Events.PointerEventExt.md @@ -52,7 +52,7 @@ Represents a custom extended pointer event. #### Defined in -[src/events/Events.ts:207](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L207) +[src/events/Events.ts:207](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L207) ## Properties @@ -68,7 +68,7 @@ A boolean value indicating whether the event is cancelable. #### Defined in -[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L115) +[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L115) ___ @@ -84,7 +84,7 @@ A reference to the currently registered target for the event. This is the object #### Defined in -[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L117) +[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L117) ___ @@ -100,7 +100,7 @@ Returns the intersection information between the mouse event and 3D objects in t #### Defined in -[src/events/Events.ts:199](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L199) +[src/events/Events.ts:199](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L199) ___ @@ -116,7 +116,7 @@ The secondary target for the event, if there is one. #### Defined in -[src/events/Events.ts:191](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L191) +[src/events/Events.ts:191](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L191) ___ @@ -132,7 +132,7 @@ The time at which the event was created (in milliseconds). By specification, thi #### Defined in -[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L123) +[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L123) ## Accessors @@ -152,7 +152,7 @@ MouseEventExt.altKey #### Defined in -[src/events/Events.ts:165](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L165) +[src/events/Events.ts:165](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L165) ___ @@ -172,7 +172,7 @@ MouseEventExt.bubbles #### Defined in -[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L113) +[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L113) ___ @@ -192,7 +192,7 @@ MouseEventExt.button #### Defined in -[src/events/Events.ts:167](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L167) +[src/events/Events.ts:167](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L167) ___ @@ -212,7 +212,7 @@ MouseEventExt.buttons #### Defined in -[src/events/Events.ts:169](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L169) +[src/events/Events.ts:169](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L169) ___ @@ -232,7 +232,7 @@ MouseEventExt.clientX #### Defined in -[src/events/Events.ts:171](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L171) +[src/events/Events.ts:171](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L171) ___ @@ -252,7 +252,7 @@ MouseEventExt.clientY #### Defined in -[src/events/Events.ts:173](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L173) +[src/events/Events.ts:173](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L173) ___ @@ -272,7 +272,7 @@ MouseEventExt.ctrlKey #### Defined in -[src/events/Events.ts:175](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L175) +[src/events/Events.ts:175](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L175) ___ @@ -292,7 +292,7 @@ MouseEventExt.defaultPrevented #### Defined in -[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L119) +[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L119) ___ @@ -308,7 +308,7 @@ The height (magnitude on the Y axis), in CSS pixels, of the contact geometry of #### Defined in -[src/events/Events.ts:232](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L232) +[src/events/Events.ts:232](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L232) ___ @@ -324,7 +324,7 @@ Indicates if the pointer represents the primary pointer of this pointer type. #### Defined in -[src/events/Events.ts:246](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L246) +[src/events/Events.ts:246](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L246) ___ @@ -344,7 +344,7 @@ MouseEventExt.metaKey #### Defined in -[src/events/Events.ts:177](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L177) +[src/events/Events.ts:177](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L177) ___ @@ -364,7 +364,7 @@ MouseEventExt.movementX #### Defined in -[src/events/Events.ts:179](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L179) +[src/events/Events.ts:179](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L179) ___ @@ -384,7 +384,7 @@ MouseEventExt.movementY #### Defined in -[src/events/Events.ts:181](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L181) +[src/events/Events.ts:181](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L181) ___ @@ -404,7 +404,7 @@ MouseEventExt.offsetX #### Defined in -[src/events/Events.ts:183](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L183) +[src/events/Events.ts:183](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L183) ___ @@ -424,7 +424,7 @@ MouseEventExt.offsetY #### Defined in -[src/events/Events.ts:185](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L185) +[src/events/Events.ts:185](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L185) ___ @@ -444,7 +444,7 @@ MouseEventExt.pageX #### Defined in -[src/events/Events.ts:187](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L187) +[src/events/Events.ts:187](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L187) ___ @@ -464,7 +464,7 @@ MouseEventExt.pageY #### Defined in -[src/events/Events.ts:189](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L189) +[src/events/Events.ts:189](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L189) ___ @@ -480,7 +480,7 @@ A unique identifier for the pointer causing the event. #### Defined in -[src/events/Events.ts:228](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L228) +[src/events/Events.ts:228](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L228) ___ @@ -496,7 +496,7 @@ Indicates the device type that caused the event (mouse, pen, touch, etc.). #### Defined in -[src/events/Events.ts:244](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L244) +[src/events/Events.ts:244](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L244) ___ @@ -512,7 +512,7 @@ The normalized pressure of the pointer input in the range 0 to 1, where 0 and 1 #### Defined in -[src/events/Events.ts:234](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L234) +[src/events/Events.ts:234](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L234) ___ @@ -532,7 +532,7 @@ MouseEventExt.screenX #### Defined in -[src/events/Events.ts:193](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L193) +[src/events/Events.ts:193](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L193) ___ @@ -552,7 +552,7 @@ MouseEventExt.screenY #### Defined in -[src/events/Events.ts:195](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L195) +[src/events/Events.ts:195](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L195) ___ @@ -572,7 +572,7 @@ MouseEventExt.shiftKey #### Defined in -[src/events/Events.ts:197](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L197) +[src/events/Events.ts:197](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L197) ___ @@ -588,7 +588,7 @@ The normalized tangential pressure of the pointer input (also known as barrel pr #### Defined in -[src/events/Events.ts:236](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L236) +[src/events/Events.ts:236](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L236) ___ @@ -608,7 +608,7 @@ MouseEventExt.target #### Defined in -[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L121) +[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L121) ___ @@ -624,7 +624,7 @@ The plane angle (in degrees, in the range of -90 to 90) between the Y–Z plane #### Defined in -[src/events/Events.ts:238](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L238) +[src/events/Events.ts:238](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L238) ___ @@ -640,7 +640,7 @@ The plane angle (in degrees, in the range of -90 to 90) between the X–Z plane #### Defined in -[src/events/Events.ts:240](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L240) +[src/events/Events.ts:240](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L240) ___ @@ -656,7 +656,7 @@ The clockwise rotation of the pointer (e.g. pen stylus) around its major axis in #### Defined in -[src/events/Events.ts:242](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L242) +[src/events/Events.ts:242](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L242) ___ @@ -676,7 +676,7 @@ MouseEventExt.type #### Defined in -[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L125) +[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L125) ___ @@ -692,7 +692,7 @@ The width (magnitude on the X axis), in CSS pixels, of the contact geometry of t #### Defined in -[src/events/Events.ts:230](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L230) +[src/events/Events.ts:230](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L230) ## Methods @@ -718,7 +718,7 @@ Returns the current state of the specified modifier key. See KeyboardEvent.getMo #### Defined in -[src/events/Events.ts:215](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L215) +[src/events/Events.ts:215](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L215) ___ @@ -738,7 +738,7 @@ Cancels the event. #### Defined in -[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L141) +[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L141) ___ @@ -758,7 +758,7 @@ For this particular event, prevent all other listeners from being called. This i #### Defined in -[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L146) +[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L146) ___ @@ -778,4 +778,4 @@ Stops the propagation of events further along in the Object3D hierarchy. #### Defined in -[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L151) +[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L151) diff --git a/docs/docs/api/classes/Events.PointerIntersectionEvent.md b/docs/docs/api/classes/Events.PointerIntersectionEvent.md index 9db08c4..42e52bf 100644 --- a/docs/docs/api/classes/Events.PointerIntersectionEvent.md +++ b/docs/docs/api/classes/Events.PointerIntersectionEvent.md @@ -45,7 +45,7 @@ Represents a pointer intersection event. #### Defined in -[src/events/Events.ts:303](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L303) +[src/events/Events.ts:303](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L303) ## Properties @@ -61,7 +61,7 @@ A boolean value indicating whether the event is cancelable. #### Defined in -[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L115) +[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L115) ___ @@ -77,7 +77,7 @@ A reference to the currently registered target for the event. This is the object #### Defined in -[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L117) +[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L117) ___ @@ -89,7 +89,7 @@ Returns the intersection information between the mouse event and 3D objects in t #### Defined in -[src/events/Events.ts:298](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L298) +[src/events/Events.ts:298](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L298) ___ @@ -105,7 +105,7 @@ The time at which the event was created (in milliseconds). By specification, thi #### Defined in -[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L123) +[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L123) ## Accessors @@ -125,7 +125,7 @@ EventExt.bubbles #### Defined in -[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L113) +[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L113) ___ @@ -145,7 +145,7 @@ EventExt.defaultPrevented #### Defined in -[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L119) +[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L119) ___ @@ -165,7 +165,7 @@ EventExt.target #### Defined in -[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L121) +[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L121) ___ @@ -185,7 +185,7 @@ EventExt.type #### Defined in -[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L125) +[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L125) ## Methods @@ -205,7 +205,7 @@ Cancels the event. #### Defined in -[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L141) +[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L141) ___ @@ -225,7 +225,7 @@ For this particular event, prevent all other listeners from being called. This i #### Defined in -[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L146) +[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L146) ___ @@ -245,4 +245,4 @@ Stops the propagation of events further along in the Object3D hierarchy. #### Defined in -[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L151) +[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L151) diff --git a/docs/docs/api/classes/Events.WheelEventExt.md b/docs/docs/api/classes/Events.WheelEventExt.md index ecd44c7..c647db0 100644 --- a/docs/docs/api/classes/Events.WheelEventExt.md +++ b/docs/docs/api/classes/Events.WheelEventExt.md @@ -50,7 +50,7 @@ Represents a custom extended wheel event. #### Defined in -[src/events/Events.ts:207](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L207) +[src/events/Events.ts:207](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L207) ## Properties @@ -66,7 +66,7 @@ A boolean value indicating whether the event is cancelable. #### Defined in -[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L115) +[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L115) ___ @@ -82,7 +82,7 @@ A reference to the currently registered target for the event. This is the object #### Defined in -[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L117) +[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L117) ___ @@ -98,7 +98,7 @@ Returns the intersection information between the mouse event and 3D objects in t #### Defined in -[src/events/Events.ts:199](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L199) +[src/events/Events.ts:199](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L199) ___ @@ -114,7 +114,7 @@ The secondary target for the event, if there is one. #### Defined in -[src/events/Events.ts:191](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L191) +[src/events/Events.ts:191](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L191) ___ @@ -130,7 +130,7 @@ The time at which the event was created (in milliseconds). By specification, thi #### Defined in -[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L123) +[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L123) ## Accessors @@ -150,7 +150,7 @@ MouseEventExt.altKey #### Defined in -[src/events/Events.ts:165](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L165) +[src/events/Events.ts:165](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L165) ___ @@ -170,7 +170,7 @@ MouseEventExt.bubbles #### Defined in -[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L113) +[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L113) ___ @@ -190,7 +190,7 @@ MouseEventExt.button #### Defined in -[src/events/Events.ts:167](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L167) +[src/events/Events.ts:167](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L167) ___ @@ -210,7 +210,7 @@ MouseEventExt.buttons #### Defined in -[src/events/Events.ts:169](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L169) +[src/events/Events.ts:169](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L169) ___ @@ -230,7 +230,7 @@ MouseEventExt.clientX #### Defined in -[src/events/Events.ts:171](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L171) +[src/events/Events.ts:171](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L171) ___ @@ -250,7 +250,7 @@ MouseEventExt.clientY #### Defined in -[src/events/Events.ts:173](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L173) +[src/events/Events.ts:173](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L173) ___ @@ -270,7 +270,7 @@ MouseEventExt.ctrlKey #### Defined in -[src/events/Events.ts:175](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L175) +[src/events/Events.ts:175](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L175) ___ @@ -290,7 +290,7 @@ MouseEventExt.defaultPrevented #### Defined in -[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L119) +[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L119) ___ @@ -306,7 +306,7 @@ Returns a double representing the horizontal scroll amount. #### Defined in -[src/events/Events.ts:285](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L285) +[src/events/Events.ts:285](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L285) ___ @@ -322,7 +322,7 @@ Returns a double representing the vertical scroll amount. #### Defined in -[src/events/Events.ts:287](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L287) +[src/events/Events.ts:287](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L287) ___ @@ -338,7 +338,7 @@ Returns a double representing the scroll amount for the z-axis. #### Defined in -[src/events/Events.ts:289](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L289) +[src/events/Events.ts:289](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L289) ___ @@ -358,7 +358,7 @@ MouseEventExt.metaKey #### Defined in -[src/events/Events.ts:177](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L177) +[src/events/Events.ts:177](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L177) ___ @@ -378,7 +378,7 @@ MouseEventExt.movementX #### Defined in -[src/events/Events.ts:179](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L179) +[src/events/Events.ts:179](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L179) ___ @@ -398,7 +398,7 @@ MouseEventExt.movementY #### Defined in -[src/events/Events.ts:181](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L181) +[src/events/Events.ts:181](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L181) ___ @@ -418,7 +418,7 @@ MouseEventExt.offsetX #### Defined in -[src/events/Events.ts:183](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L183) +[src/events/Events.ts:183](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L183) ___ @@ -438,7 +438,7 @@ MouseEventExt.offsetY #### Defined in -[src/events/Events.ts:185](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L185) +[src/events/Events.ts:185](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L185) ___ @@ -458,7 +458,7 @@ MouseEventExt.pageX #### Defined in -[src/events/Events.ts:187](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L187) +[src/events/Events.ts:187](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L187) ___ @@ -478,7 +478,7 @@ MouseEventExt.pageY #### Defined in -[src/events/Events.ts:189](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L189) +[src/events/Events.ts:189](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L189) ___ @@ -498,7 +498,7 @@ MouseEventExt.screenX #### Defined in -[src/events/Events.ts:193](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L193) +[src/events/Events.ts:193](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L193) ___ @@ -518,7 +518,7 @@ MouseEventExt.screenY #### Defined in -[src/events/Events.ts:195](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L195) +[src/events/Events.ts:195](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L195) ___ @@ -538,7 +538,7 @@ MouseEventExt.shiftKey #### Defined in -[src/events/Events.ts:197](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L197) +[src/events/Events.ts:197](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L197) ___ @@ -558,7 +558,7 @@ MouseEventExt.target #### Defined in -[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L121) +[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L121) ___ @@ -578,7 +578,7 @@ MouseEventExt.type #### Defined in -[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L125) +[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L125) ## Methods @@ -604,7 +604,7 @@ Returns the current state of the specified modifier key. See KeyboardEvent.getMo #### Defined in -[src/events/Events.ts:215](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L215) +[src/events/Events.ts:215](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L215) ___ @@ -624,7 +624,7 @@ Cancels the event. #### Defined in -[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L141) +[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L141) ___ @@ -644,7 +644,7 @@ For this particular event, prevent all other listeners from being called. This i #### Defined in -[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L146) +[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L146) ___ @@ -664,4 +664,4 @@ Stops the propagation of events further along in the Object3D hierarchy. #### Defined in -[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L151) +[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L151) diff --git a/docs/docs/api/classes/InstancedMesh.InstancedMesh2.md b/docs/docs/api/classes/InstancedMesh.InstancedMesh2.md index f0b614c..6168752 100644 --- a/docs/docs/api/classes/InstancedMesh.InstancedMesh2.md +++ b/docs/docs/api/classes/InstancedMesh.InstancedMesh2.md @@ -38,7 +38,7 @@ InstancedMesh.constructor #### Defined in -[src/instancedMesh/InstancedMesh2.ts:65](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMesh2.ts#L65) +[src/instancedMesh/InstancedMesh2.ts:65](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMesh2.ts#L65) ## Properties @@ -51,7 +51,7 @@ Each element represents a separate instance that can be managed individually. #### Defined in -[src/instancedMesh/InstancedMesh2.ts:25](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMesh2.ts#L25) +[src/instancedMesh/InstancedMesh2.ts:25](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMesh2.ts#L25) ___ @@ -63,7 +63,7 @@ A flag indicating that this is an instance of InstancedMesh2. #### Defined in -[src/instancedMesh/InstancedMesh2.ts:20](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMesh2.ts#L20) +[src/instancedMesh/InstancedMesh2.ts:20](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMesh2.ts#L20) ## Accessors @@ -79,7 +79,7 @@ Gets the currently clicking instance. #### Defined in -[src/instancedMesh/InstancedMesh2.ts:50](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMesh2.ts#L50) +[src/instancedMesh/InstancedMesh2.ts:50](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMesh2.ts#L50) ___ @@ -95,7 +95,7 @@ Gets the currently dragging instance. #### Defined in -[src/instancedMesh/InstancedMesh2.ts:55](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMesh2.ts#L55) +[src/instancedMesh/InstancedMesh2.ts:55](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMesh2.ts#L55) ___ @@ -111,7 +111,7 @@ Gets the currently focused instance. #### Defined in -[src/instancedMesh/InstancedMesh2.ts:45](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMesh2.ts#L45) +[src/instancedMesh/InstancedMesh2.ts:45](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMesh2.ts#L45) ___ @@ -127,7 +127,7 @@ Gets the currently hovered instance. #### Defined in -[src/instancedMesh/InstancedMesh2.ts:40](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMesh2.ts#L40) +[src/instancedMesh/InstancedMesh2.ts:40](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMesh2.ts#L40) ## Methods @@ -149,4 +149,4 @@ Set the focus to the specified instance, if focus is enabled for the InstancedMe #### Defined in -[src/instancedMesh/InstancedMesh2.ts:100](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMesh2.ts#L100) +[src/instancedMesh/InstancedMesh2.ts:100](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMesh2.ts#L100) diff --git a/docs/docs/api/classes/InstancedMesh.InstancedMeshEntity.md b/docs/docs/api/classes/InstancedMesh.InstancedMeshEntity.md index d659a72..f767bfd 100644 --- a/docs/docs/api/classes/InstancedMesh.InstancedMeshEntity.md +++ b/docs/docs/api/classes/InstancedMesh.InstancedMeshEntity.md @@ -35,7 +35,7 @@ EventDispatcher.constructor #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:74](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L74) +[src/instancedMesh/InstancedMeshEntity.ts:74](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L74) ## Properties @@ -47,7 +47,7 @@ Cursor style when interacting with the object. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:37](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L37) +[src/instancedMesh/InstancedMeshEntity.ts:37](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L37) ___ @@ -59,7 +59,7 @@ Cursor style when dragging the object. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:39](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L39) +[src/instancedMesh/InstancedMeshEntity.ts:39](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L39) ___ @@ -71,7 +71,7 @@ Cursor style when dropping an object onto this one. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:41](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L41) +[src/instancedMesh/InstancedMeshEntity.ts:41](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L41) ___ @@ -83,7 +83,7 @@ Indicates whether the object is draggable (default: false). #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:33](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L33) +[src/instancedMesh/InstancedMeshEntity.ts:33](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L33) ___ @@ -96,7 +96,7 @@ If set to true, it allows triggering all InteractionEvents; otherwise, events ar #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:29](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L29) +[src/instancedMesh/InstancedMeshEntity.ts:29](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L29) ___ @@ -108,7 +108,7 @@ Determines when the object is dragged, whether it will have to search for any dr #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:35](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L35) +[src/instancedMesh/InstancedMeshEntity.ts:35](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L35) ___ @@ -120,7 +120,7 @@ Indicates whether the object can receive focus (default: true). #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:31](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L31) +[src/instancedMesh/InstancedMeshEntity.ts:31](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L31) ___ @@ -132,7 +132,7 @@ An identifier for this individual instance within an InstancedMesh2. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:18](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L18) +[src/instancedMesh/InstancedMeshEntity.ts:18](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L18) ___ @@ -144,7 +144,7 @@ A flag indicating that this is an instance of InstancedMeshEntity. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:14](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L14) +[src/instancedMesh/InstancedMeshEntity.ts:14](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L14) ___ @@ -156,7 +156,7 @@ Object's parent in the scene graph. An object can have at most one parent. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:16](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L16) +[src/instancedMesh/InstancedMeshEntity.ts:16](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L16) ___ @@ -168,7 +168,7 @@ A Vector3 representing the object's local position. Default is (0, 0, 0). #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:20](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L20) +[src/instancedMesh/InstancedMeshEntity.ts:20](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L20) ___ @@ -180,7 +180,7 @@ Object's local rotation as a Quaternion. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:24](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L24) +[src/instancedMesh/InstancedMeshEntity.ts:24](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L24) ___ @@ -192,7 +192,7 @@ The object's local scale. Default is Vector3(1, 1, 1). #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:22](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L22) +[src/instancedMesh/InstancedMeshEntity.ts:22](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L22) ## Accessors @@ -208,7 +208,7 @@ Indicates if the object is currently being clicked. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:53](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L53) +[src/instancedMesh/InstancedMeshEntity.ts:53](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L53) ___ @@ -224,7 +224,7 @@ Indicates if the object is currently being dragged. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:55](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L55) +[src/instancedMesh/InstancedMeshEntity.ts:55](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L55) ___ @@ -240,7 +240,7 @@ Retrieves the combined enabled state considering parent objects. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:57](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L57) +[src/instancedMesh/InstancedMeshEntity.ts:57](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L57) ___ @@ -256,7 +256,7 @@ Indicates if the object is currently focused. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:51](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L51) +[src/instancedMesh/InstancedMeshEntity.ts:51](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L51) ___ @@ -272,7 +272,7 @@ Indicates if the primary pointer is over this object. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:49](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L49) +[src/instancedMesh/InstancedMeshEntity.ts:49](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L49) ___ @@ -288,7 +288,7 @@ The global transform of the object. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:62](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L62) +[src/instancedMesh/InstancedMeshEntity.ts:62](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L62) ## Methods @@ -304,7 +304,7 @@ Applies blur (removes focus) from the object. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:175](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L175) +[src/instancedMesh/InstancedMeshEntity.ts:175](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L175) ___ @@ -320,7 +320,7 @@ Applies focus to the object. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:168](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L168) +[src/instancedMesh/InstancedMeshEntity.ts:168](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L168) ___ @@ -344,7 +344,7 @@ The instance of the object. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:120](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L120) +[src/instancedMesh/InstancedMeshEntity.ts:120](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L120) ___ @@ -368,7 +368,7 @@ The instance of the object. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:136](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L136) +[src/instancedMesh/InstancedMeshEntity.ts:136](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L136) ___ @@ -392,7 +392,7 @@ The color representation of this instance. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:99](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L99) +[src/instancedMesh/InstancedMeshEntity.ts:99](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L99) ___ @@ -423,7 +423,7 @@ Checks if the object has a specific event listener. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:203](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L203) +[src/instancedMesh/InstancedMeshEntity.ts:203](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L203) ___ @@ -452,7 +452,7 @@ Removes an event listener from the object. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:212](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L212) +[src/instancedMesh/InstancedMeshEntity.ts:212](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L212) ___ @@ -499,7 +499,7 @@ A function to remove the event listener. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:187](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L187) +[src/instancedMesh/InstancedMeshEntity.ts:187](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L187) ___ @@ -524,7 +524,7 @@ The instance of the object. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:147](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L147) +[src/instancedMesh/InstancedMeshEntity.ts:147](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L147) ___ @@ -549,7 +549,7 @@ The instance of the object. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:159](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L159) +[src/instancedMesh/InstancedMeshEntity.ts:159](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L159) ___ @@ -571,7 +571,7 @@ Sets the color of this instance. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:88](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L88) +[src/instancedMesh/InstancedMeshEntity.ts:88](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L88) ___ @@ -600,7 +600,7 @@ Triggers a specific event on the object. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:221](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L221) +[src/instancedMesh/InstancedMeshEntity.ts:221](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L221) ___ @@ -618,7 +618,7 @@ A Tween instance for further configuration. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:229](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L229) +[src/instancedMesh/InstancedMeshEntity.ts:229](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L229) ___ @@ -634,4 +634,4 @@ Updates the local transform. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:107](https://github.com/agargaro/three.ez/blob/46fae0a/src/instancedMesh/InstancedMeshEntity.ts#L107) +[src/instancedMesh/InstancedMeshEntity.ts:107](https://github.com/agargaro/three.ez/blob/ba52259/src/instancedMesh/InstancedMeshEntity.ts#L107) diff --git a/docs/docs/api/classes/Rendering.RenderView.md b/docs/docs/api/classes/Rendering.RenderView.md index dcc7ed5..5173a44 100644 --- a/docs/docs/api/classes/Rendering.RenderView.md +++ b/docs/docs/api/classes/Rendering.RenderView.md @@ -31,7 +31,7 @@ Don't instance this manually. #### Defined in -[src/rendering/RenderView.ts:76](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L76) +[src/rendering/RenderView.ts:76](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L76) ## Properties @@ -53,7 +53,7 @@ The viewport defining the dimensions and position of the view. #### Defined in -[src/rendering/RenderView.ts:55](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L55) +[src/rendering/RenderView.ts:55](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L55) ## Methods @@ -69,4 +69,4 @@ Updates the dimensions of the viewport based on the renderer size. #### Defined in -[src/rendering/RenderView.ts:97](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L97) +[src/rendering/RenderView.ts:97](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L97) diff --git a/docs/docs/api/classes/Tweening.RunningTween.md b/docs/docs/api/classes/Tweening.RunningTween.md index 7ae6e2b..bb0b687 100644 --- a/docs/docs/api/classes/Tweening.RunningTween.md +++ b/docs/docs/api/classes/Tweening.RunningTween.md @@ -40,7 +40,7 @@ Don't instance this manually. #### Defined in -[src/tweening/RunningTween.ts:68](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/RunningTween.ts#L68) +[src/tweening/RunningTween.ts:68](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/RunningTween.ts#L68) ## Properties @@ -53,7 +53,7 @@ If set to `true`, the tween will not progress until it is resumed. #### Defined in -[src/tweening/RunningTween.ts:52](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/RunningTween.ts#L52) +[src/tweening/RunningTween.ts:52](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/RunningTween.ts#L52) ___ @@ -67,7 +67,7 @@ A value of `1` represents normal speed, while `0.5` would be half-speed, and `2` #### Defined in -[src/tweening/RunningTween.ts:58](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/RunningTween.ts#L58) +[src/tweening/RunningTween.ts:58](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/RunningTween.ts#L58) ## Accessors @@ -83,7 +83,7 @@ Indicates whether the running tween has finished executing. #### Defined in -[src/tweening/RunningTween.ts:63](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/RunningTween.ts#L63) +[src/tweening/RunningTween.ts:63](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/RunningTween.ts#L63) ## Methods @@ -99,7 +99,7 @@ Complete the running tween, causing it to finish immediately. #### Defined in -[src/tweening/RunningTween.ts:107](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/RunningTween.ts#L107) +[src/tweening/RunningTween.ts:107](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/RunningTween.ts#L107) ___ @@ -115,7 +115,7 @@ Pause the execution of the running tween. #### Defined in -[src/tweening/RunningTween.ts:86](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/RunningTween.ts#L86) +[src/tweening/RunningTween.ts:86](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/RunningTween.ts#L86) ___ @@ -131,7 +131,7 @@ Resume the execution of the running tween if it was paused. #### Defined in -[src/tweening/RunningTween.ts:93](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/RunningTween.ts#L93) +[src/tweening/RunningTween.ts:93](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/RunningTween.ts#L93) ___ @@ -147,7 +147,7 @@ Revert the running tween to its initial state (Not implemented yet). #### Defined in -[src/tweening/RunningTween.ts:114](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/RunningTween.ts#L114) +[src/tweening/RunningTween.ts:114](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/RunningTween.ts#L114) ___ @@ -171,7 +171,7 @@ The updated RunningTween instance. #### Defined in -[src/tweening/RunningTween.ts:78](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/RunningTween.ts#L78) +[src/tweening/RunningTween.ts:78](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/RunningTween.ts#L78) ___ @@ -187,4 +187,4 @@ Stop the running tween, causing it to finish immediately. #### Defined in -[src/tweening/RunningTween.ts:100](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/RunningTween.ts#L100) +[src/tweening/RunningTween.ts:100](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/RunningTween.ts#L100) diff --git a/docs/docs/api/classes/Tweening.Tween.md b/docs/docs/api/classes/Tweening.Tween.md index a1254f5..b538290 100644 --- a/docs/docs/api/classes/Tweening.Tween.md +++ b/docs/docs/api/classes/Tweening.Tween.md @@ -35,7 +35,7 @@ A Tween represents a series of actions that can be applied to a target object to #### Defined in -[src/tweening/Tween.ts:21](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L21) +[src/tweening/Tween.ts:21](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L21) ## Properties @@ -47,7 +47,7 @@ Tags used for filtering and management. #### Defined in -[src/tweening/Tween.ts:16](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L16) +[src/tweening/Tween.ts:16](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L16) ___ @@ -59,7 +59,7 @@ The object to apply the tween to. #### Defined in -[src/tweening/Tween.ts:14](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L14) +[src/tweening/Tween.ts:14](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L14) ## Methods @@ -85,7 +85,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:64](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L64) +[src/tweening/Tween.ts:64](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L64) ___ @@ -109,7 +109,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:74](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L74) +[src/tweening/Tween.ts:84](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L84) ___ @@ -133,7 +133,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:180](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L180) +[src/tweening/Tween.ts:190](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L190) ___ @@ -151,7 +151,7 @@ A new Tween instance with the same configuration. #### Defined in -[src/tweening/Tween.ts:190](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L190) +[src/tweening/Tween.ts:200](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L200) ___ @@ -175,7 +175,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:84](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L84) +[src/tweening/Tween.ts:94](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L94) ___ @@ -199,7 +199,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:156](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L156) +[src/tweening/Tween.ts:166](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L166) ___ @@ -223,7 +223,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:94](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L94) +[src/tweening/Tween.ts:104](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L104) ___ @@ -241,7 +241,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:111](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L111) +[src/tweening/Tween.ts:121](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L121) ___ @@ -265,7 +265,31 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:167](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L167) +[src/tweening/Tween.ts:177](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L177) + +___ + +### set + +▸ **set**(`action`): [`Tween`](Tweening.Tween.md)<`T`\> + +Define a movement from the current state to a new state instantaneously. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `action` | `Motion`<`T`\> | The motion configuration. | + +#### Returns + +[`Tween`](Tweening.Tween.md)<`T`\> + +The updated Tween instance. + +#### Defined in + +[src/tweening/Tween.ts:74](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L74) ___ @@ -289,7 +313,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:30](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L30) +[src/tweening/Tween.ts:30](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L30) ___ @@ -313,7 +337,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:40](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L40) +[src/tweening/Tween.ts:40](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L40) ___ @@ -331,7 +355,7 @@ A RunningTween instance that controls the execution of the Tween. #### Defined in -[src/tweening/Tween.ts:202](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L202) +[src/tweening/Tween.ts:212](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L212) ___ @@ -355,7 +379,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:145](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L145) +[src/tweening/Tween.ts:155](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L155) ___ @@ -381,7 +405,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:52](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L52) +[src/tweening/Tween.ts:52](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L52) ___ @@ -405,7 +429,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:120](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L120) +[src/tweening/Tween.ts:130](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L130) ___ @@ -423,4 +447,4 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:136](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Tween.ts#L136) +[src/tweening/Tween.ts:146](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Tween.ts#L146) diff --git a/docs/docs/api/classes/Tweening.TweenManager.md b/docs/docs/api/classes/Tweening.TweenManager.md index d810dac..b0edc19 100644 --- a/docs/docs/api/classes/Tweening.TweenManager.md +++ b/docs/docs/api/classes/Tweening.TweenManager.md @@ -23,7 +23,7 @@ Complete all running tweens. #### Defined in -[src/tweening/TweenManager.ts:111](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/TweenManager.ts#L111) +[src/tweening/TweenManager.ts:110](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/TweenManager.ts#L110) ___ @@ -45,7 +45,7 @@ Complete all running tweens with a specific tag. #### Defined in -[src/tweening/TweenManager.ts:121](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/TweenManager.ts#L121) +[src/tweening/TweenManager.ts:120](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/TweenManager.ts#L120) ___ @@ -61,7 +61,7 @@ Stop all running tweens. #### Defined in -[src/tweening/TweenManager.ts:90](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/TweenManager.ts#L90) +[src/tweening/TweenManager.ts:89](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/TweenManager.ts#L89) ___ @@ -83,4 +83,4 @@ Stop all running tweens with a specific tag. #### Defined in -[src/tweening/TweenManager.ts:100](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/TweenManager.ts#L100) +[src/tweening/TweenManager.ts:99](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/TweenManager.ts#L99) diff --git a/docs/docs/api/classes/Utils.Stats.md b/docs/docs/api/classes/Utils.Stats.md new file mode 100644 index 0000000..b4b95e7 --- /dev/null +++ b/docs/docs/api/classes/Utils.Stats.md @@ -0,0 +1,30 @@ +--- +id: "Utils.Stats" +title: "Class: Stats" +sidebar_label: "Stats" +custom_edit_url: null +--- + +[Utils](../namespaces/Utils.md).Stats + +Porting of mrdoob statistics, with support if no rendered frame. + +## Methods + +### showPanel + +▸ **showPanel**(`id`): `void` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `number` | 0:fps, 1: ms, 2: mb, 3+: custom | + +#### Returns + +`void` + +#### Defined in + +[src/utils/Stats.ts:37](https://github.com/agargaro/three.ez/blob/ba52259/src/utils/Stats.ts#L37) diff --git a/docs/docs/api/classes/Utils.Utils.md b/docs/docs/api/classes/Utils.Utils.md index 5175170..c9a7c4e 100644 --- a/docs/docs/api/classes/Utils.Utils.md +++ b/docs/docs/api/classes/Utils.Utils.md @@ -33,4 +33,4 @@ The intersection point. #### Defined in -[src/utils/Utils.ts:17](https://github.com/agargaro/three.ez/blob/46fae0a/src/utils/Utils.ts#L17) +[src/utils/Utils.ts:17](https://github.com/agargaro/three.ez/blob/ba52259/src/utils/Utils.ts#L17) diff --git a/docs/docs/api/index.md b/docs/docs/api/index.md index 4cd98a5..6d5b687 100644 --- a/docs/docs/api/index.md +++ b/docs/docs/api/index.md @@ -146,7 +146,7 @@ const main = new Main(); ``` -## Override Typescript Type Definition +## Override TypeScript Type Definition To extend the definitions of `three`, go into `ts.config` and add this path: @@ -183,12 +183,12 @@ There is one example without vite. - [Continuous Raycasting](https://stackblitz.com/edit/three-ez-continuous-raycasting?file=src%2Fmain.ts) - [Hitbox](https://stackblitz.com/edit/three-ez-hitbox?file=src%2Fmain.ts) - [Tweening](https://stackblitz.com/edit/three-ez-tweening?file=src%2Fmain.ts) -- [Tweening Custom Progress](https://stackblitz.com/edit/three-ez-tweening-custom-progress?file=src%2Fmain.ts) +— [Tweening Custom Progress](https://stackblitz.com/edit/three-ez-tweening-custom-progress?file=src%2Fmain.ts) - [InstancedMeshEntity](https://stackblitz.com/edit/three-ez-instancedmeshentity?file=src%2Fmain.ts) — [InstancedMeshEntity Performance](https://stackblitz.com/edit/three-ez-instancedmeshentity-performance?file=src%2Fmain.ts) - [Draggable Box OrbitControls](https://stackblitz.com/edit/three-ez-draggable-box-orbitcontrols?file=src%2Fmain.ts) - [Textbox (troika-three-text)](https://stackblitz.com/edit/three-ez-textbox?file=src%2Fmain.ts) -- Rolling & Jumping Ball +- [Bubble Refraction](https://stackblitz.com/edit/three-ez-bubble-refraction?file=src%2Fmain.ts,src%2Ftext.ts,src%2Fparticles.ts,src%2Fbubble.ts,src%2FbubbleMaterial.ts,src%2Fscene.ts) ## Documentation diff --git a/docs/docs/api/interfaces/Core.MainParameters.md b/docs/docs/api/interfaces/Core.MainParameters.md index 2cb3b61..acf1f91 100644 --- a/docs/docs/api/interfaces/Core.MainParameters.md +++ b/docs/docs/api/interfaces/Core.MainParameters.md @@ -19,7 +19,7 @@ A callback function executed for each frame. #### Defined in -[src/core/Main.ts:27](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L27) +[src/core/Main.ts:27](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L27) ___ @@ -31,7 +31,7 @@ The default alpha (transparency) value for the background (default: 1). #### Defined in -[src/core/Main.ts:25](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L25) +[src/core/Main.ts:25](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L25) ___ @@ -43,7 +43,7 @@ The default background color (default: black). #### Defined in -[src/core/Main.ts:23](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L23) +[src/core/Main.ts:23](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L23) ___ @@ -55,7 +55,7 @@ A boolean flag indicating whether to disable the context menu on right-click (de #### Defined in -[src/core/Main.ts:21](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L21) +[src/core/Main.ts:21](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L21) ___ @@ -67,7 +67,7 @@ A boolean flag indicating whether to enable cursor handling in the application ( #### Defined in -[src/core/Main.ts:31](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L31) +[src/core/Main.ts:31](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L31) ___ @@ -79,7 +79,7 @@ A Boolean flag indicating whether to enable full-screen mode and perform automat #### Defined in -[src/core/Main.ts:17](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L17) +[src/core/Main.ts:17](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L17) ___ @@ -91,7 +91,7 @@ A boolean flag indicating whether to enable multitouch interactions (default: fa #### Defined in -[src/core/Main.ts:33](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L33) +[src/core/Main.ts:33](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L33) ___ @@ -103,7 +103,7 @@ Configuration parameters for the WebGLRenderer. #### Defined in -[src/core/Main.ts:29](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L29) +[src/core/Main.ts:29](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L29) ___ @@ -115,4 +115,4 @@ A boolean flag indicating whether to display performance statistics (default: tr #### Defined in -[src/core/Main.ts:19](https://github.com/agargaro/three.ez/blob/46fae0a/src/core/Main.ts#L19) +[src/core/Main.ts:19](https://github.com/agargaro/three.ez/blob/ba52259/src/core/Main.ts#L19) diff --git a/docs/docs/api/interfaces/Events.AnimateEvent.md b/docs/docs/api/interfaces/Events.AnimateEvent.md index 598cc19..77ef43a 100644 --- a/docs/docs/api/interfaces/Events.AnimateEvent.md +++ b/docs/docs/api/interfaces/Events.AnimateEvent.md @@ -19,7 +19,7 @@ The difference in time between the current animation frame and the previous one #### Defined in -[src/events/Events.ts:385](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L385) +[src/events/Events.ts:385](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L385) ___ @@ -31,4 +31,4 @@ The total amount of time that has passed since the animation started (in millise #### Defined in -[src/events/Events.ts:387](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L387) +[src/events/Events.ts:387](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L387) diff --git a/docs/docs/api/interfaces/Events.InteractionEvents.md b/docs/docs/api/interfaces/Events.InteractionEvents.md index 807ae83..d79108c 100644 --- a/docs/docs/api/interfaces/Events.InteractionEvents.md +++ b/docs/docs/api/interfaces/Events.InteractionEvents.md @@ -39,7 +39,7 @@ Event triggered when target loses focus. #### Defined in -[src/events/Events.ts:73](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L73) +[src/events/Events.ts:73](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L73) ___ @@ -51,7 +51,7 @@ Event triggered when a click event occurs. #### Defined in -[src/events/Events.ts:61](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L61) +[src/events/Events.ts:61](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L61) ___ @@ -63,7 +63,7 @@ Event triggered when a double click event occurs. #### Defined in -[src/events/Events.ts:63](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L63) +[src/events/Events.ts:63](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L63) ___ @@ -75,7 +75,7 @@ Event triggered when the target is dragged. #### Defined in -[src/events/Events.ts:79](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L79) +[src/events/Events.ts:79](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L79) ___ @@ -87,7 +87,7 @@ Event triggered when dragging is canceled (Can be canceled pressing 'ESC'). This #### Defined in -[src/events/Events.ts:85](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L85) +[src/events/Events.ts:85](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L85) ___ @@ -99,7 +99,7 @@ Event triggered when dragging ends. #### Defined in -[src/events/Events.ts:83](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L83) +[src/events/Events.ts:83](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L83) ___ @@ -111,7 +111,7 @@ Event triggered when a draggable object enters a drop target. #### Defined in -[src/events/Events.ts:87](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L87) +[src/events/Events.ts:87](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L87) ___ @@ -123,7 +123,7 @@ Event triggered when a draggable object leaves a drop target. #### Defined in -[src/events/Events.ts:94](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L94) +[src/events/Events.ts:94](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L94) ___ @@ -136,7 +136,7 @@ Triggers every frame if the scene has 'continousRaycastingDropTarget' equal to t #### Defined in -[src/events/Events.ts:92](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L92) +[src/events/Events.ts:92](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L92) ___ @@ -148,7 +148,7 @@ Event triggered when dragging starts. #### Defined in -[src/events/Events.ts:81](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L81) +[src/events/Events.ts:81](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L81) ___ @@ -160,7 +160,7 @@ Event triggered when a draggable object is dropped onto a drop target. #### Defined in -[src/events/Events.ts:96](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L96) +[src/events/Events.ts:96](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L96) ___ @@ -172,7 +172,7 @@ Event triggered when target gains focus. #### Defined in -[src/events/Events.ts:71](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L71) +[src/events/Events.ts:71](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L71) ___ @@ -184,7 +184,7 @@ Event triggered when target gains focus (no propagation). #### Defined in -[src/events/Events.ts:67](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L67) +[src/events/Events.ts:67](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L67) ___ @@ -196,7 +196,7 @@ Event triggered when target loses focus (no propagation). #### Defined in -[src/events/Events.ts:69](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L69) +[src/events/Events.ts:69](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L69) ___ @@ -208,7 +208,7 @@ Event triggered on the focused object when a key is pressed. #### Defined in -[src/events/Events.ts:75](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L75) +[src/events/Events.ts:75](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L75) ___ @@ -220,7 +220,7 @@ Event triggered on the focused object when a key is released. #### Defined in -[src/events/Events.ts:77](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L77) +[src/events/Events.ts:77](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L77) ___ @@ -232,7 +232,7 @@ Event triggered when a pointer button is pressed. #### Defined in -[src/events/Events.ts:55](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L55) +[src/events/Events.ts:55](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L55) ___ @@ -244,7 +244,7 @@ Event triggered when a pointer enters the target (no propagation). #### Defined in -[src/events/Events.ts:47](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L47) +[src/events/Events.ts:47](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L47) ___ @@ -256,7 +256,7 @@ Event triggered if pointer is on target. Triggers every frame and only works if #### Defined in -[src/events/Events.ts:59](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L59) +[src/events/Events.ts:59](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L59) ___ @@ -268,7 +268,7 @@ Event triggered when a pointer leaves the target (no propagation). #### Defined in -[src/events/Events.ts:51](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L51) +[src/events/Events.ts:51](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L51) ___ @@ -280,7 +280,7 @@ Event triggered when a pointer moves over the target. #### Defined in -[src/events/Events.ts:53](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L53) +[src/events/Events.ts:53](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L53) ___ @@ -292,7 +292,7 @@ Event triggered when a pointer leaves the target. #### Defined in -[src/events/Events.ts:49](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L49) +[src/events/Events.ts:49](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L49) ___ @@ -304,7 +304,7 @@ Event triggered when a pointer enters the target. #### Defined in -[src/events/Events.ts:45](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L45) +[src/events/Events.ts:45](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L45) ___ @@ -316,7 +316,7 @@ Event triggered when a pointer button is released. #### Defined in -[src/events/Events.ts:57](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L57) +[src/events/Events.ts:57](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L57) ___ @@ -328,4 +328,4 @@ Event triggered when scrolling the mouse wheel. #### Defined in -[src/events/Events.ts:65](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L65) +[src/events/Events.ts:65](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L65) diff --git a/docs/docs/api/interfaces/Events.IntersectionExt.md b/docs/docs/api/interfaces/Events.IntersectionExt.md index edc28be..d4b7625 100644 --- a/docs/docs/api/interfaces/Events.IntersectionExt.md +++ b/docs/docs/api/interfaces/Events.IntersectionExt.md @@ -25,4 +25,4 @@ The hitbox hit by the raycaster. #### Defined in -[src/events/Events.ts:105](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L105) +[src/events/Events.ts:105](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L105) diff --git a/docs/docs/api/interfaces/Events.MiscEvents.md b/docs/docs/api/interfaces/Events.MiscEvents.md index bb0cc6f..305f32f 100644 --- a/docs/docs/api/interfaces/Events.MiscEvents.md +++ b/docs/docs/api/interfaces/Events.MiscEvents.md @@ -19,7 +19,7 @@ Event triggered every frame, after 'animate'. Usually used if you want to operat #### Defined in -[src/events/Events.ts:34](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L34) +[src/events/Events.ts:34](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L34) ___ @@ -31,7 +31,7 @@ Event triggered every frame. Used to animate objects. #### Defined in -[src/events/Events.ts:32](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L32) +[src/events/Events.ts:32](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L32) ___ @@ -43,7 +43,7 @@ Event triggered every frame, before 'animate'. Usually used to prepare object an #### Defined in -[src/events/Events.ts:30](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L30) +[src/events/Events.ts:30](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L30) ___ @@ -55,4 +55,4 @@ Event triggered on first render and every time an object is rendered with a diff #### Defined in -[src/events/Events.ts:28](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L28) +[src/events/Events.ts:28](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L28) diff --git a/docs/docs/api/interfaces/Events.PropertyChangeEvent.md b/docs/docs/api/interfaces/Events.PropertyChangeEvent.md index 22f0793..90c6a73 100644 --- a/docs/docs/api/interfaces/Events.PropertyChangeEvent.md +++ b/docs/docs/api/interfaces/Events.PropertyChangeEvent.md @@ -25,7 +25,7 @@ A reference to the object to which the event was originally dispatched. #### Defined in -[src/events/Events.ts:396](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L396) +[src/events/Events.ts:396](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L396) ___ @@ -37,4 +37,4 @@ The new value associated with the property change. #### Defined in -[src/events/Events.ts:398](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L398) +[src/events/Events.ts:398](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L398) diff --git a/docs/docs/api/interfaces/Events.RendererResizeEvent.md b/docs/docs/api/interfaces/Events.RendererResizeEvent.md index db4d574..dcf1931 100644 --- a/docs/docs/api/interfaces/Events.RendererResizeEvent.md +++ b/docs/docs/api/interfaces/Events.RendererResizeEvent.md @@ -19,7 +19,7 @@ Returns rendering camera. #### Defined in -[src/events/Events.ts:377](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L377) +[src/events/Events.ts:377](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L377) ___ @@ -31,7 +31,7 @@ Returns the render height. #### Defined in -[src/events/Events.ts:373](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L373) +[src/events/Events.ts:373](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L373) ___ @@ -43,7 +43,7 @@ Returns renderer. #### Defined in -[src/events/Events.ts:375](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L375) +[src/events/Events.ts:375](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L375) ___ @@ -55,4 +55,4 @@ Returns new render width. #### Defined in -[src/events/Events.ts:371](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L371) +[src/events/Events.ts:371](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L371) diff --git a/docs/docs/api/interfaces/Events.UpdateEvents.md b/docs/docs/api/interfaces/Events.UpdateEvents.md index 4d1ec7f..b56da1b 100644 --- a/docs/docs/api/interfaces/Events.UpdateEvents.md +++ b/docs/docs/api/interfaces/Events.UpdateEvents.md @@ -19,7 +19,7 @@ Event triggered when the enabledState of the object changes. The propagation of #### Defined in -[src/events/Events.ts:18](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L18) +[src/events/Events.ts:18](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L18) ___ @@ -31,7 +31,7 @@ Event triggered when the position of the object changes. #### Defined in -[src/events/Events.ts:12](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L12) +[src/events/Events.ts:12](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L12) ___ @@ -43,7 +43,7 @@ Event triggered when the rotation of the object changes. #### Defined in -[src/events/Events.ts:16](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L16) +[src/events/Events.ts:16](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L16) ___ @@ -55,7 +55,7 @@ Event triggered when the scale of the object changes. #### Defined in -[src/events/Events.ts:14](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L14) +[src/events/Events.ts:14](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L14) ___ @@ -67,4 +67,4 @@ Event triggered when the visibility of the object changes. The propagation of th #### Defined in -[src/events/Events.ts:20](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/Events.ts#L20) +[src/events/Events.ts:20](https://github.com/agargaro/three.ez/blob/ba52259/src/events/Events.ts#L20) diff --git a/docs/docs/api/interfaces/Patch.Object3DExtPrototype.md b/docs/docs/api/interfaces/Patch.Object3DExtPrototype.md index a772fa0..60006da 100644 --- a/docs/docs/api/interfaces/Patch.Object3DExtPrototype.md +++ b/docs/docs/api/interfaces/Patch.Object3DExtPrototype.md @@ -19,7 +19,7 @@ Cursor style when interacting with the object. #### Defined in -[src/patch/Object3D.ts:53](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L53) +[src/patch/Object3D.ts:53](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L53) ___ @@ -31,7 +31,7 @@ Cursor style when dragging the object. #### Defined in -[src/patch/Object3D.ts:55](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L55) +[src/patch/Object3D.ts:55](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L55) ___ @@ -43,7 +43,7 @@ Cursor style when dropping an object onto this one. #### Defined in -[src/patch/Object3D.ts:57](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L57) +[src/patch/Object3D.ts:57](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L57) ___ @@ -55,7 +55,7 @@ Indicates whether the object is draggable (default: false). #### Defined in -[src/patch/Object3D.ts:47](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L47) +[src/patch/Object3D.ts:47](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L47) ___ @@ -68,7 +68,7 @@ If set to true, it allows triggering all InteractionEvents; otherwise, events ar #### Defined in -[src/patch/Object3D.ts:39](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L39) +[src/patch/Object3D.ts:39](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L39) ___ @@ -80,7 +80,7 @@ Determines when the object is dragged, whether it will have to search for any dr #### Defined in -[src/patch/Object3D.ts:49](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L49) +[src/patch/Object3D.ts:49](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L49) ___ @@ -92,7 +92,7 @@ Indicates whether the object can receive focus (default: true). #### Defined in -[src/patch/Object3D.ts:45](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L45) +[src/patch/Object3D.ts:45](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L45) ___ @@ -104,7 +104,7 @@ Array of hitboxes for collision detection. #### Defined in -[src/patch/Object3D.ts:43](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L43) +[src/patch/Object3D.ts:43](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L43) ___ @@ -116,7 +116,7 @@ Determines if the object can be intercepted by a raycaster (default: true). #### Defined in -[src/patch/Object3D.ts:41](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L41) +[src/patch/Object3D.ts:41](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L41) ___ @@ -128,7 +128,7 @@ Indicates whether the scene needs rendering. #### Defined in -[src/patch/Object3D.ts:59](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L59) +[src/patch/Object3D.ts:59](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L59) ___ @@ -140,7 +140,7 @@ Reference to the scene the object belongs to. #### Defined in -[src/patch/Object3D.ts:51](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L51) +[src/patch/Object3D.ts:51](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L51) ## Accessors @@ -156,7 +156,7 @@ Indicates if the object is currently being clicked. #### Defined in -[src/patch/Object3D.ts:65](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L65) +[src/patch/Object3D.ts:65](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L65) ___ @@ -172,7 +172,7 @@ Indicates if the object is currently being dragged. #### Defined in -[src/patch/Object3D.ts:67](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L67) +[src/patch/Object3D.ts:67](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L67) ___ @@ -188,7 +188,7 @@ Retrieves the combined enabled state considering parent objects. #### Defined in -[src/patch/Object3D.ts:69](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L69) +[src/patch/Object3D.ts:69](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L69) ___ @@ -204,7 +204,7 @@ Retrieves the first possibile focusable object. #### Defined in -[src/patch/Object3D.ts:71](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L71) +[src/patch/Object3D.ts:71](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L71) ___ @@ -220,7 +220,7 @@ Indicates if the object is currently focused. #### Defined in -[src/patch/Object3D.ts:63](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L63) +[src/patch/Object3D.ts:63](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L63) ___ @@ -236,7 +236,7 @@ Indicates if the primary pointer is over this object. #### Defined in -[src/patch/Object3D.ts:61](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L61) +[src/patch/Object3D.ts:61](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L61) ## Methods @@ -252,7 +252,7 @@ Applies blur (removes focus) from the object. #### Defined in -[src/patch/Object3D.ts:79](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L79) +[src/patch/Object3D.ts:79](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L79) ___ @@ -268,7 +268,7 @@ Applies focus to the object. #### Defined in -[src/patch/Object3D.ts:75](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L75) +[src/patch/Object3D.ts:75](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L75) ___ @@ -300,7 +300,7 @@ The instance of the object with the binding applied. #### Defined in -[src/patch/Object3D.ts:131](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L131) +[src/patch/Object3D.ts:131](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L131) ___ @@ -323,7 +323,7 @@ If 'recursive' is set to true, it will also calculate bindings for all children. #### Defined in -[src/patch/Object3D.ts:123](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L123) +[src/patch/Object3D.ts:123](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L123) ___ @@ -354,7 +354,7 @@ Checks if the object has a specific event listener. #### Defined in -[src/patch/Object3D.ts:93](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L93) +[src/patch/Object3D.ts:93](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L93) ___ @@ -383,7 +383,7 @@ Removes an event listener from the object. #### Defined in -[src/patch/Object3D.ts:99](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L99) +[src/patch/Object3D.ts:99](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L99) ___ @@ -430,7 +430,7 @@ A function to remove the event listener. #### Defined in -[src/patch/Object3D.ts:86](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L86) +[src/patch/Object3D.ts:86](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L86) ___ @@ -448,7 +448,7 @@ Instead, they must be manually computed using the 'detectChanges' function. #### Defined in -[src/patch/Object3D.ts:117](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L117) +[src/patch/Object3D.ts:117](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L117) ___ @@ -477,7 +477,7 @@ Triggers a specific event on the object. #### Defined in -[src/patch/Object3D.ts:105](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L105) +[src/patch/Object3D.ts:105](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L105) ___ @@ -506,25 +506,31 @@ Triggers a specific event on the object and all its ancestors. #### Defined in -[src/patch/Object3D.ts:111](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L111) +[src/patch/Object3D.ts:111](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L111) ___ ### tween -▸ **tween**(): [`Tween`](../classes/Tweening.Tween.md)<`Object3D`\> +▸ **tween**<`T`\>(): [`Tween`](../classes/Tweening.Tween.md)<`T`\> Initiates a Tween animation for the object. +#### Type parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `T` | extends `Object3D`<`T`\> | The type of the target. | + #### Returns -[`Tween`](../classes/Tweening.Tween.md)<`Object3D`\> +[`Tween`](../classes/Tweening.Tween.md)<`T`\> A Tween instance for further configuration. #### Defined in -[src/patch/Object3D.ts:142](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L142) +[src/patch/Object3D.ts:143](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L143) ___ @@ -554,4 +560,4 @@ The instance of the object with the binding removed. #### Defined in -[src/patch/Object3D.ts:137](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Object3D.ts#L137) +[src/patch/Object3D.ts:137](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Object3D.ts#L137) diff --git a/docs/docs/api/interfaces/Patch.SceneExtPrototype.md b/docs/docs/api/interfaces/Patch.SceneExtPrototype.md index c140953..5ebc5d0 100644 --- a/docs/docs/api/interfaces/Patch.SceneExtPrototype.md +++ b/docs/docs/api/interfaces/Patch.SceneExtPrototype.md @@ -19,7 +19,7 @@ Flag indicating whether to blur focused object3D when clicking outside of any ob #### Defined in -[src/patch/Scene.ts:39](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Scene.ts#L39) +[src/patch/Scene.ts:38](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Scene.ts#L38) ___ @@ -33,7 +33,7 @@ Also, if set to true, the 'pointerintersection' event will be triggered every fr #### Defined in -[src/patch/Scene.ts:25](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Scene.ts#L25) +[src/patch/Scene.ts:24](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Scene.ts#L24) ___ @@ -47,7 +47,7 @@ Also, if set to true, the 'dragover' event will be triggered every frame. #### Defined in -[src/patch/Scene.ts:31](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Scene.ts#L31) +[src/patch/Scene.ts:30](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Scene.ts#L30) ___ @@ -59,7 +59,7 @@ A reference to the currently focused Object3D within the scene. #### Defined in -[src/patch/Scene.ts:37](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Scene.ts#L37) +[src/patch/Scene.ts:36](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Scene.ts#L36) ___ @@ -71,7 +71,7 @@ An array of intersections computed from the pointer (primary pointer only). #### Defined in -[src/patch/Scene.ts:33](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Scene.ts#L33) +[src/patch/Scene.ts:32](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Scene.ts#L32) ___ @@ -83,7 +83,7 @@ An array of intersections computed from the pointer if an object is dragged and #### Defined in -[src/patch/Scene.ts:35](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Scene.ts#L35) +[src/patch/Scene.ts:34](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Scene.ts#L34) ___ @@ -95,7 +95,7 @@ The time scale for scene animations. #### Defined in -[src/patch/Scene.ts:41](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Scene.ts#L41) +[src/patch/Scene.ts:40](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Scene.ts#L40) ___ @@ -107,7 +107,7 @@ The total time elapsed in the scene. #### Defined in -[src/patch/Scene.ts:43](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Scene.ts#L43) +[src/patch/Scene.ts:42](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Scene.ts#L42) ## Methods @@ -125,7 +125,7 @@ The updated instance of the scene. #### Defined in -[src/patch/Scene.ts:48](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Scene.ts#L48) +[src/patch/Scene.ts:47](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Scene.ts#L47) ___ @@ -147,4 +147,4 @@ Set the focus to the specified Object3D within the scene, or clears the focus if #### Defined in -[src/patch/Scene.ts:53](https://github.com/agargaro/three.ez/blob/46fae0a/src/patch/Scene.ts#L53) +[src/patch/Scene.ts:52](https://github.com/agargaro/three.ez/blob/ba52259/src/patch/Scene.ts#L52) diff --git a/docs/docs/api/interfaces/Rendering.ViewParameters.md b/docs/docs/api/interfaces/Rendering.ViewParameters.md index a4d2dd1..c0c4e08 100644 --- a/docs/docs/api/interfaces/Rendering.ViewParameters.md +++ b/docs/docs/api/interfaces/Rendering.ViewParameters.md @@ -23,7 +23,7 @@ The background alpha value of the view (optional, default: 1). #### Defined in -[src/rendering/RenderView.ts:37](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L37) +[src/rendering/RenderView.ts:37](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L37) ___ @@ -35,7 +35,7 @@ The background color of the view (optional). It can be a Color object or a numer #### Defined in -[src/rendering/RenderView.ts:35](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L35) +[src/rendering/RenderView.ts:35](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L35) ___ @@ -47,7 +47,7 @@ The camera used to view the scene (Don't use the same camera for differents scen #### Defined in -[src/rendering/RenderView.ts:25](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L25) +[src/rendering/RenderView.ts:25](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L25) ___ @@ -59,7 +59,7 @@ The effect composer used for post-processing (optional). #### Defined in -[src/rendering/RenderView.ts:39](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L39) +[src/rendering/RenderView.ts:39](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L39) ___ @@ -71,7 +71,7 @@ Determines whether InteractionEvents will be triggered for the view. (optional, #### Defined in -[src/rendering/RenderView.ts:33](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L33) +[src/rendering/RenderView.ts:33](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L33) ___ @@ -91,7 +91,7 @@ Function to be called after rendering the view (optional). #### Defined in -[src/rendering/RenderView.ts:43](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L43) +[src/rendering/RenderView.ts:43](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L43) ___ @@ -111,7 +111,7 @@ Function to be called before rendering the view (optional). #### Defined in -[src/rendering/RenderView.ts:41](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L41) +[src/rendering/RenderView.ts:41](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L41) ___ @@ -123,7 +123,7 @@ The scene to be rendered in the view. #### Defined in -[src/rendering/RenderView.ts:23](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L23) +[src/rendering/RenderView.ts:23](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L23) ___ @@ -135,7 +135,7 @@ The tags of the view. #### Defined in -[src/rendering/RenderView.ts:29](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L29) +[src/rendering/RenderView.ts:29](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L29) ___ @@ -147,7 +147,7 @@ The normalized viewport defining the dimensions and position of the view (option #### Defined in -[src/rendering/RenderView.ts:27](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L27) +[src/rendering/RenderView.ts:27](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L27) ___ @@ -159,4 +159,4 @@ Determines if the view is visible (optional, default: true). #### Defined in -[src/rendering/RenderView.ts:31](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L31) +[src/rendering/RenderView.ts:31](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L31) diff --git a/docs/docs/api/interfaces/Rendering.Viewport.md b/docs/docs/api/interfaces/Rendering.Viewport.md index 77d2ef2..fa37ba9 100644 --- a/docs/docs/api/interfaces/Rendering.Viewport.md +++ b/docs/docs/api/interfaces/Rendering.Viewport.md @@ -19,7 +19,7 @@ The bottom coordinate of the viewport. #### Defined in -[src/rendering/RenderView.ts:11](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L11) +[src/rendering/RenderView.ts:11](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L11) ___ @@ -31,7 +31,7 @@ The height of the viewport. #### Defined in -[src/rendering/RenderView.ts:15](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L15) +[src/rendering/RenderView.ts:15](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L15) ___ @@ -43,7 +43,7 @@ The left coordinate of the viewport. #### Defined in -[src/rendering/RenderView.ts:9](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L9) +[src/rendering/RenderView.ts:9](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L9) ___ @@ -55,4 +55,4 @@ The width of the viewport #### Defined in -[src/rendering/RenderView.ts:13](https://github.com/agargaro/three.ez/blob/46fae0a/src/rendering/RenderView.ts#L13) +[src/rendering/RenderView.ts:13](https://github.com/agargaro/three.ez/blob/ba52259/src/rendering/RenderView.ts#L13) diff --git a/docs/docs/api/interfaces/Tweening.MotionConfig.md b/docs/docs/api/interfaces/Tweening.MotionConfig.md index 717b0a4..8d6dd2a 100644 --- a/docs/docs/api/interfaces/Tweening.MotionConfig.md +++ b/docs/docs/api/interfaces/Tweening.MotionConfig.md @@ -26,7 +26,7 @@ The easing function to control the animation's progression. #### Defined in -[src/tweening/Actions.ts:21](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Actions.ts#L21) +[src/tweening/Actions.ts:22](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Actions.ts#L22) ___ @@ -52,7 +52,7 @@ A callback function to execute when the animation completes. #### Defined in -[src/tweening/Actions.ts:26](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Actions.ts#L26) +[src/tweening/Actions.ts:27](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Actions.ts#L27) ___ @@ -84,7 +84,7 @@ If `false` will not assign new value to property. #### Defined in -[src/tweening/Actions.ts:46](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Actions.ts#L46) +[src/tweening/Actions.ts:47](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Actions.ts#L47) ___ @@ -110,7 +110,7 @@ A callback function to execute when the animation starts. #### Defined in -[src/tweening/Actions.ts:31](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Actions.ts#L31) +[src/tweening/Actions.ts:32](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Actions.ts#L32) ___ @@ -136,4 +136,4 @@ A callback function to be executed after each property has been updated. #### Defined in -[src/tweening/Actions.ts:36](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Actions.ts#L36) +[src/tweening/Actions.ts:37](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Actions.ts#L37) diff --git a/docs/docs/api/namespaces/Events.md b/docs/docs/api/namespaces/Events.md index 663f73f..849a6b5 100644 --- a/docs/docs/api/namespaces/Events.md +++ b/docs/docs/api/namespaces/Events.md @@ -37,7 +37,7 @@ Indicates a cursor by a list or by url. #### Defined in -[src/events/CursorManager.ts:18](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/CursorManager.ts#L18) +[src/events/CursorManager.ts:18](https://github.com/agargaro/three.ez/blob/ba52259/src/events/CursorManager.ts#L18) ___ @@ -49,7 +49,7 @@ https://developer.mozilla.org/en-US/docs/Web/CSS/cursor #### Defined in -[src/events/CursorManager.ts:5](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/CursorManager.ts#L5) +[src/events/CursorManager.ts:5](https://github.com/agargaro/three.ez/blob/ba52259/src/events/CursorManager.ts#L5) ___ @@ -78,4 +78,4 @@ A negative number if `a` should come before `b`, a positive number if `b` should #### Defined in -[src/events/RaycasterManager.ts:11](https://github.com/agargaro/three.ez/blob/46fae0a/src/events/RaycasterManager.ts#L11) +[src/events/RaycasterManager.ts:11](https://github.com/agargaro/three.ez/blob/ba52259/src/events/RaycasterManager.ts#L11) diff --git a/docs/docs/api/namespaces/Tweening.md b/docs/docs/api/namespaces/Tweening.md index 6e9849e..df2cdc9 100644 --- a/docs/docs/api/namespaces/Tweening.md +++ b/docs/docs/api/namespaces/Tweening.md @@ -27,7 +27,7 @@ Type representing an easing type, which can be either a predefined easing functi #### Defined in -[src/tweening/Easings.ts:4](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Easings.ts#L4) +[src/tweening/Easings.ts:4](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Easings.ts#L4) ___ @@ -53,7 +53,7 @@ Type representing an easing function that takes a single numeric parameter and r #### Defined in -[src/tweening/Easings.ts:2](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Easings.ts#L2) +[src/tweening/Easings.ts:2](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Easings.ts#L2) ## Variables @@ -65,4 +65,4 @@ The default easing function used when no easing is specified. #### Defined in -[src/tweening/Easings.ts:6](https://github.com/agargaro/three.ez/blob/46fae0a/src/tweening/Easings.ts#L6) +[src/tweening/Easings.ts:6](https://github.com/agargaro/three.ez/blob/ba52259/src/tweening/Easings.ts#L6) diff --git a/docs/docs/api/namespaces/Utils.md b/docs/docs/api/namespaces/Utils.md index a13878e..93a38ca 100644 --- a/docs/docs/api/namespaces/Utils.md +++ b/docs/docs/api/namespaces/Utils.md @@ -8,4 +8,5 @@ custom_edit_url: null ## Classes +- [Stats](../classes/Utils.Stats.md) - [Utils](../classes/Utils.Utils.md) diff --git a/docs/docs/tutorial/advanced/_category_.yml b/docs/docs/tutorial/advanced/_category_.yml new file mode 100644 index 0000000..b1fde0b --- /dev/null +++ b/docs/docs/tutorial/advanced/_category_.yml @@ -0,0 +1,2 @@ +label: "Advanced" +position: 10 \ No newline at end of file diff --git a/docs/docs/tutorial/advanced/todo.md b/docs/docs/tutorial/advanced/todo.md new file mode 100644 index 0000000..17d303d --- /dev/null +++ b/docs/docs/tutorial/advanced/todo.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# TODO + +Work in progress... diff --git a/docs/docs/tutorial/animation.md b/docs/docs/tutorial/animation.md new file mode 100644 index 0000000..ce0bc92 --- /dev/null +++ b/docs/docs/tutorial/animation.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 3 +--- + +# Animation + +Work in progress... diff --git a/docs/docs/tutorial/binding.md b/docs/docs/tutorial/binding.md new file mode 100644 index 0000000..08cf068 --- /dev/null +++ b/docs/docs/tutorial/binding.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 4 +--- + +# Binding + +Work in progress... diff --git a/docs/docs/tutorial/drag-drop/_category_.yml b/docs/docs/tutorial/drag-drop/_category_.yml new file mode 100644 index 0000000..9142ac2 --- /dev/null +++ b/docs/docs/tutorial/drag-drop/_category_.yml @@ -0,0 +1,2 @@ +label: "Drag and Drop" +position: 7 \ No newline at end of file diff --git a/docs/docs/tutorial/drag-drop/todo.md b/docs/docs/tutorial/drag-drop/todo.md new file mode 100644 index 0000000..17d303d --- /dev/null +++ b/docs/docs/tutorial/drag-drop/todo.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# TODO + +Work in progress... diff --git a/docs/docs/tutorial/events/_category_.yml b/docs/docs/tutorial/events/_category_.yml new file mode 100644 index 0000000..0b6b080 --- /dev/null +++ b/docs/docs/tutorial/events/_category_.yml @@ -0,0 +1,2 @@ +label: "Events" +position: 5 \ No newline at end of file diff --git a/docs/docs/tutorial/events/todo.md b/docs/docs/tutorial/events/todo.md new file mode 100644 index 0000000..17d303d --- /dev/null +++ b/docs/docs/tutorial/events/todo.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# TODO + +Work in progress... diff --git a/docs/docs/tutorial/focus-management/_category_.yml b/docs/docs/tutorial/focus-management/_category_.yml new file mode 100644 index 0000000..3eabcff --- /dev/null +++ b/docs/docs/tutorial/focus-management/_category_.yml @@ -0,0 +1,2 @@ +label: "Focus Management" +position: 6 \ No newline at end of file diff --git a/docs/docs/tutorial/focus-management/todo.md b/docs/docs/tutorial/focus-management/todo.md new file mode 100644 index 0000000..17d303d --- /dev/null +++ b/docs/docs/tutorial/focus-management/todo.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# TODO + +Work in progress... diff --git a/docs/docs/tutorial/getting-started/_category_.yml b/docs/docs/tutorial/getting-started/_category_.yml new file mode 100644 index 0000000..f11778b --- /dev/null +++ b/docs/docs/tutorial/getting-started/_category_.yml @@ -0,0 +1,2 @@ +label: "Gettings Started" +position: 1 \ No newline at end of file diff --git a/docs/docs/tutorial/getting-started/configuration.md b/docs/docs/tutorial/getting-started/configuration.md new file mode 100644 index 0000000..2e2c6a3 --- /dev/null +++ b/docs/docs/tutorial/getting-started/configuration.md @@ -0,0 +1,51 @@ +--- +sidebar_position: 1 +--- + +# Configuration + +When transitioning from a traditional `three.js` application to `three.ez`, you'll immediately notice the central role played by the `Main` class. + +The `Main` class serves as the core of your application, enabling all of `three.ez`'s features and simplifying scene and viewport rendering through convenient methods. + +Within the `Main` class constructor, you can provide an optional configuration object with the following optional properties: + +| Name | Type | Description | +| ---------------- | -------------------- | --------------------------------------------------------------------------------------- | +| **animate** | XRFrameRequestCallback | A callback function executed for each frame. | +| **backgroundAlpha** | number | The default alpha (transparency) value for the background (default: 1). | +| **backgroundColor** | ColorRepresentation | The default background color (default: 'black'). | +| **disableContextMenu** | boolean | A boolean flag indicating whether to disable the context menu on right-click (default: true). | +| **enableCursor** | boolean | A boolean flag indicating whether to enable cursor handling in the application (default: true). | +| **fullscreen** | boolean | A boolean flag indicating whether to enable full-screen mode and automatic canvas resizing (default: true). | +| **multitouch** | boolean | A boolean flag indicating whether to enable multitouch interactions (default: false). | +| **rendererParameters** | WebGLRendererParameters | Configuration parameters for the [WebGLRenderer](https://threejs.org/docs/#api/en/renderers/WebGLRenderer). | +| **showStats** | boolean | A boolean flag indicating whether to display performance statistics (default: true). | + +> ℹ️ **Note**
+> You can access the documentation for the `Main` class [here](../../api/classes/Core.Main). + +## Example + +```typescript + +const main = new Main({ + animate: () => { + /** If you use external libraries that require cyclic updates, perform them here. */ + }, + backgroundAlpha: 1, + backgroundColor: 'black', + disableContextMenu: true, + enableCursor: true, + fullscreen: true, + multitouch: false, + rendererParameters: { antialias: true }, + showStats: true +}); +``` + +## Live Examples + +[⚡ Stackblitz - Template](https://stackblitz.com/edit/three-ez-template?file=src%2Fmain.ts)
+[⚡ Stackblitz - Template Small](https://stackblitz.com/edit/three-ez-template-small?file=src%2Fmain.ts)
+[⚡ Stackblitz - Template No Vite](https://stackblitz.com/edit/three-ez-template-no-vite?file=index.ts) diff --git a/docs/docs/tutorial/getting-started/installation.md b/docs/docs/tutorial/getting-started/installation.md new file mode 100644 index 0000000..f337886 --- /dev/null +++ b/docs/docs/tutorial/getting-started/installation.md @@ -0,0 +1,62 @@ +--- +sidebar_position: 0 +--- + +# Installation + +1. Begin by creating a `three.js` project, which can be done by following the [official guide (option 1)](https://threejs.org/docs/#manual/en/introduction/Installation). +> ⚠️ **Warning**
+> Please note that `three.ez` is compatible with `three.js r151+`. + +1. Install `three.ez` + ```bash + npm install @three.ez/main + ``` + +1. For TypeScript users, it's essential to follow the steps outlined in [TypeScript Support](https://agargaro.github.io/three.ez/docs/tutorial/getting-started/typescript-support).
+If you're not using TypeScript, you can skip this step. + +1. Open your `main.ts` file and insert the provided code: + ```typescript + import { Scene, Mesh, BoxGeometry, MeshNormalMaterial } from 'three'; + import { Main, PerspectiveCameraAuto } from '@three.ez/main'; + + const box = new Mesh(new BoxGeometry(0.2, 0.2, 0.2), new MeshNormalMaterial()); + box.on('animate', (e) => box.rotateX(e.delta).rotateY(e.delta * 2)); + const scene = new Scene().add(box); + const main = new Main(); + main.createView({ scene, camera: new PerspectiveCameraAuto(70).translateZ(1) }); + ``` + + Alternatively, if you prefer a more structured and modular approach using classes ***(which is recommended)***, you can use the following code snippet: + + ```typescript + import { Scene as SceneBase, Mesh, BoxGeometry, MeshNormalMaterial } from 'three'; + import { Main as MainBase, PerspectiveCameraAuto } from '@three.ez/main'; + + class DraggableBox extends Mesh { + constructor() { + super(new BoxGeometry(0.2, 0.2, 0.2), new MeshNormalMaterial()); + this.on('animate', (e) => this.rotateX(e.delta).rotateY(e.delta * 2)); + } + } + + class Scene extends SceneBase { + constructor() { + super(); + this.add(new DraggableBox()); + } + } + + class Main extends MainBase { + constructor() { + super(); + this.createView({ scene: new Scene(), camera: new PerspectiveCameraAuto(70).translateZ(1) }); + } + } + + const main = new Main(); + ``` + + > ℹ️ **Note**
+ > Throughout this documentation, we use the `.ts` file extension. If you're not using TypeScript, feel free to use `.js` instead. diff --git a/docs/docs/tutorial/getting-started/playground.md b/docs/docs/tutorial/getting-started/playground.md new file mode 100644 index 0000000..b0c4cc7 --- /dev/null +++ b/docs/docs/tutorial/getting-started/playground.md @@ -0,0 +1,15 @@ +--- +sidebar_position: 2 +--- + +# Playground + +Playgrounds let you experience `three.ez` right in your browser, with no need for installation! + +They're particularly handy for: + +- Testing +- Reporting bugs + +### [⚡ Try it with JavaScript on Stackblitz](https://stackblitz.com/edit/three-ez-template-js?file=src%2Fmain.js) +### [⚡ Try it with TypeScript on Stackblitz](https://stackblitz.com/edit/three-ez-template?file=src%2Fmain.ts) diff --git a/docs/docs/tutorial/getting-started/typescript-support.md b/docs/docs/tutorial/getting-started/typescript-support.md new file mode 100644 index 0000000..11c62b4 --- /dev/null +++ b/docs/docs/tutorial/getting-started/typescript-support.md @@ -0,0 +1,58 @@ +--- +sidebar_position: 3 +--- + +# TypeScript Support + +Before using `three.ez`, make sure you have the `three.js` type definitions installed: +```bash +npm install --save @types/three +``` + +> ℹ️ **Note**
+> `three.ez` extends the properties of the `Scene` and `Object3D` classes, requiring the override of `three` type definitions. + +The type definitions for `three.ez` are bundled within the main package.
+To override the `three` type definitions, simply navigate to your `tsconfig.json` file and add the following path configuration: + +```javascript +"compilerOptions": { + "paths": { + "three": ["./node_modules/@three.ez/main/types"] + } +} +``` + +> ⚠️ **Warning**
+> Currently, `three.ez` has overridden all the primary `three.js` type definitions. However, not all type definitions from the official examples have been overridden. + +## Manually Overriding Type Definitions + +This section is a work in progress... + +## Using External Libraries without Type Definitions + +You can use external libraries that lack type definitions in two ways: + +1. Add `@ts-ignore` to the import statement to suppress the error ***(not recommended)*** + ```javascript + // @ts-ignore + import * as Package from 'package'; + ``` +2. Create Type Definition Files (`*.d.ts`): + - Create a `types` folder at the project's root directory + - Inside the `types` folder, create a file and name it `[package-name].d.ts` + - Write the type definitions within this file + - In your `tsconfig`, include the path to the new type definitions + + ```javascript + "compilerOptions": { + "paths": { + "three": ["./node_modules/@three.ez/main/types"], + "[package-name]": ["./types/[package-name]"] + } + } + ``` + + > ℹ️ **Note**
+ > You can find an example [here](https://stackblitz.com/edit/three-ez-textbox?file=types%2Ftroika-three-text.d.ts). diff --git a/docs/docs/tutorial/index.md b/docs/docs/tutorial/index.md new file mode 100644 index 0000000..9863e4a --- /dev/null +++ b/docs/docs/tutorial/index.md @@ -0,0 +1,49 @@ +--- +sidebar_position: 0 +--- + +# Introduction + +`three.ez` is a `TypeScript` library designed to streamline and enhance the development of `three.js` applications.
+It offers a comprehensive suite of user-friendly tools and high-performance features, making it accessible even to beginners.
+With `three.ez`, you'll discover an efficient and robust toolkit for your 3D projects. + +> ℹ️ **Note**
+> This library has only one dependency: `three.js r151+`. + +## Key Features + +### Automatic Resize Handling +Automatically resizes `Renderer`, `Camera`, `EffectComposer`.
+Using the `rendererResize` event, you can easily set the resolution for custom shaders. + +### Smart Rendering +Optimize performance by rendering frames only when necessary, reducing computational overhead. + +### Simplified Multiple Rendering +Effortlessly manage rendering for multiple scenes or viewports within a single canvas. + +### Object3D Property Binding +Streamline the management of `Object3D` properties. + +### Event Programming +Add interactions to `Object3D` through programmable events, akin to `DOM events`.
+You can bind events for changes in position, scale, rotation, visibility, and enabled state. + +### Focus and Blur +Enhance interactivity with focus and blur events. + +### Drag and Drop +Seamlessly integrate drag-and-drop functionality. + +### Hitbox Functionality +Leverage hitboxes for customized intersections or simplified calculations. + +### Raycasting Options +Choose between continuous or mouse movement-based raycasting, optimizing intersection operations. + +### Tweening +Create smooth animations effortlessly with built-in tweening. + +### Simplified InstancedMesh +Manage `InstancedMesh` instances with the ease of working with `Object3D`, simplifying creation and manipulation. diff --git a/docs/docs/tutorial/instancedMesh2/_category_.yml b/docs/docs/tutorial/instancedMesh2/_category_.yml new file mode 100644 index 0000000..dc4fec4 --- /dev/null +++ b/docs/docs/tutorial/instancedMesh2/_category_.yml @@ -0,0 +1,2 @@ +label: "InstancedMesh2" +position: 9 \ No newline at end of file diff --git a/docs/docs/tutorial/instancedMesh2/todo.md b/docs/docs/tutorial/instancedMesh2/todo.md new file mode 100644 index 0000000..17d303d --- /dev/null +++ b/docs/docs/tutorial/instancedMesh2/todo.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# TODO + +Work in progress... diff --git a/docs/docs/tutorial/raycasting/_category_.yml b/docs/docs/tutorial/raycasting/_category_.yml new file mode 100644 index 0000000..978b79e --- /dev/null +++ b/docs/docs/tutorial/raycasting/_category_.yml @@ -0,0 +1,2 @@ +label: "Raycasting" +position: 8 \ No newline at end of file diff --git a/docs/docs/tutorial/raycasting/todo.md b/docs/docs/tutorial/raycasting/todo.md new file mode 100644 index 0000000..17d303d --- /dev/null +++ b/docs/docs/tutorial/raycasting/todo.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 1 +--- + +# TODO + +Work in progress... diff --git a/docs/docs/tutorial/rendering/_category_.yml b/docs/docs/tutorial/rendering/_category_.yml new file mode 100644 index 0000000..61f10b6 --- /dev/null +++ b/docs/docs/tutorial/rendering/_category_.yml @@ -0,0 +1,2 @@ +label: "Rendering" +position: 2 \ No newline at end of file diff --git a/docs/docs/tutorial/rendering/how-it-works.md b/docs/docs/tutorial/rendering/how-it-works.md new file mode 100644 index 0000000..9357959 --- /dev/null +++ b/docs/docs/tutorial/rendering/how-it-works.md @@ -0,0 +1,79 @@ +--- +sidebar_position: 0 +--- + +# How It Works + +Rendering is managed through a collection of `RenderView` instances, which are internally handled within the `Main` class. + +> ℹ️ **Note**
+> You can access the `WebGLRenderer` instance using the `renderer` property of the `Main` class. + +## RenderView + +To create and add instances of `RenderView` to this collection, you can utilize the `createView` method of the `Main` object. This method accepts the following parameters: + +| Parameter | Type | Description | +| -----------------------| ----------------------| ----------------------------------------------------- | +| **backgroundAlpha** | number | Background alpha value of the view (optional, default: 1). | +| **backgroundColor** | ColorRepresentation | Background color of the view (optional, default: 'black'). | +| **camera** | Camera | Camera used to view the scene (avoid using the same camera for different scenes). | +| **composer** | EffectComposer | Effect composer used for post-processing (optional). | +| **enabled** | boolean | Determines whether InteractionEvents will be triggered for the view (optional, default: true). | +| **onAfterRender** | () => void | Function called after rendering the view (optional). | +| **onBeforeRender** | () => void | Function called before rendering the view (optional). | +| **scene** | Scene | Scene rendered in the view. | +| **tags** | string[] | Tags of the view (optional). | +| **viewport** | Viewport | Normalized viewport defining dimensions and position of the view (optional). Values range from 0 to 1. | +| **visible** | boolean | Determines if the view is visible (optional, default: true). | + +> ℹ️ **Note**
+> You can access the documentation for the `RenderView` class [here](../../api/classes/Rendering.RenderView). + +> ⚠️ **Warning**
+> Manually creating instances of `RenderView` is not recommended. + +## Viewport + +The `Viewport` object has the following properties: + +| Parameter | Type | Description | +| -----------------------| ----------------------| ----------------------------------------------------- | +| **bottom** | number | Bottom coordinate of the viewport. | +| **height** | number | Height of the viewport. | +| **left** | number | Left coordinate of the viewport. | +| **width** | number | Width of the viewport. | + +## Example + +```typescript +const main = new Main(); +main.createView({ + scene: sceneObj, // Mandatory + camera: cameraObj, // Mandatory + backgroundAlpha: 1, + backgroundColor: 'black', + composer: composerObj, + enabled: true, + onAfterRender: () => { + /** Code */ + }, + onBeforeRender: () => { + /** Code */ + }, + tags: ['A', 'B'], + visible: true, + viewport: { + bottom: 0, + height: 1, + left: 0, + width: 1 + } +}); +``` + +## Live Examples + +[⚡ Stackblitz - Template](https://stackblitz.com/edit/three-ez-template?file=src%2Fmain.ts)
+[⚡ Stackblitz - Multiple Views](https://stackblitz.com/edit/three-ez-multiple-views?file=src%2Fmain.ts)
+[⚡ Stackblitz - Focus Outline (EffectComposer)](https://stackblitz.com/edit/three-ez-focus-outline?file=src%2Fmain.ts) diff --git a/docs/docs/intro.md b/docs/docs/tutorial/rendering/multiple-rendering.md similarity index 50% rename from docs/docs/intro.md rename to docs/docs/tutorial/rendering/multiple-rendering.md index abe1091..ae3ff94 100644 --- a/docs/docs/intro.md +++ b/docs/docs/tutorial/rendering/multiple-rendering.md @@ -2,4 +2,7 @@ sidebar_position: 1 --- -# Soon... +# Multiple Rendering + +TODO + diff --git a/docs/docs/tutorial/rendering/smart-rendering.md b/docs/docs/tutorial/rendering/smart-rendering.md new file mode 100644 index 0000000..4c32c65 --- /dev/null +++ b/docs/docs/tutorial/rendering/smart-rendering.md @@ -0,0 +1,54 @@ +--- +sidebar_position: 2 +--- + +# Smart Rendering + +Smart rendering allows frames to be rendered only when necessary, making it especially valuable for mostly static scenes.
+This optimization enhances performance and minimizes unnecessary computational overhead. + +## How It Works + +A `needRender` property is introduced for each `Scene` object.
+When smart rendering is enabled, the `needRender` flag is reset after each rendering.
+This property is automatically set to **true** when specific events occur within the scene: + +- Changes in object `position`, `scale`, and `rotation` +- Changes in object visibility +- Adding or removing objects +- Focus changes + +> ⚠️ **Warning**
+> Automatic change detection may introduce a minor overhead, so it is recommended to activate this mode only when necessary. + +## Manual Update + +If automatic change detection isn't possible (e.g., modifications in geometry, material properties, etc.), you can manually set the flag to **true**. +You can manually update the `needsRender` flag by modifying it on any `Object3D` that has been added to the `Scene` object. + +## Activation + +Smart rendering mode is **disabled** by default.
+To enable it, use the `activeSmartRendering` method on the `Scene` object. + +> ℹ️ **Note**
+> Smart rendering is specific to a scene, so it doesn't need to be enabled for all scenes. + +## Example + +```typescript +const draggableBox = new Mesh(new BoxGeometry(), new MeshLambertMaterial({ color: 'green' })); +draggableBox.draggable = true; +draggableBox.on(['pointerenter', 'pointerleave'], function(e) { + this.material.color.set(e.type === 'pointerenter' ? 'yellow' : 'green'); + this.needsRender = true; // necessary because color change cannot be automatically detected +}); + +const scene = new Scene(); +scene.activeSmartRendering(); // in this case, it automatically detects drag movements +scene.add(draggableBox); +``` + +## Live Examples + +[⚡ Stackblitz - Smart Rendering](https://stackblitz.com/edit/three-ez-smart-rendering?file=src%2Fmain.ts) diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index be3f3a9..c2c5bf8 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -19,9 +19,6 @@ const config = { onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', - // Even if you don't use internalization, you can use this field to set useful - // metadata like html lang. For example, if your site is Chinese, you may want - // to replace "en" with "zh-Hans". i18n: { defaultLocale: 'en', locales: ['en'], @@ -29,7 +26,6 @@ const config = { plugins: [ [ 'docusaurus-plugin-typedoc', - // Plugin / TypeDoc options { entryPoints: ['../src/index-doc.ts'], tsconfig: '../tsconfig.json', @@ -53,14 +49,7 @@ const config = { // Please change this to your repo. // Remove this to remove the "edit this page" links. editUrl: - 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', - }, - blog: { - showReadingTime: true, - // Please change this to your repo. - // Remove this to remove the "edit this page" links. - editUrl: - 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', + 'https://github.com/agargaro/three.ez/tree/master/docs', }, theme: { customCss: require.resolve('./src/css/custom.css'), @@ -72,20 +61,21 @@ const config = { themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({ - // image: 'img/docusaurus-social-card.jpg', // Replace with your project's social card navbar: { title: 'three.ez', - // logo: { - // alt: 'three.ez Logo', - // src: 'img/logo.svg', - // }, items: [ { type: 'docSidebar', - sidebarId: 'tutorialSidebar', + sidebarId: 'apiSidebar', position: 'left', label: 'API', }, + { + type: 'docSidebar', + sidebarId: 'tutorialSidebar', + position: 'left', + label: 'Tutorial', + }, { href: 'https://github.com/agargaro/three.ez', label: 'GitHub', @@ -116,10 +106,6 @@ const config = { label: 'Discord', href: 'https://discord.gg/MVTwrdX3JM', }, - // { - // label: 'Twitter', - // href: 'https://twitter.com/docusaurus', - // }, ], }, { diff --git a/docs/sidebars.js b/docs/sidebars.js index 0b1c44f..256b502 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -1,6 +1,7 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { - tutorialSidebar: [{ type: 'autogenerated', dirName: 'api' }] + apiSidebar: [{ type: 'autogenerated', dirName: 'api' }], + tutorialSidebar: [{ type: 'autogenerated', dirName: 'tutorial' }] }; module.exports = sidebars; diff --git a/docs/src/components/HomepageFeatures/index.tsx b/docs/src/components/HomepageFeatures/index.tsx index 587e3cb..150957c 100644 --- a/docs/src/components/HomepageFeatures/index.tsx +++ b/docs/src/components/HomepageFeatures/index.tsx @@ -13,7 +13,8 @@ const FeatureList: FeatureItem[] = [ title: 'Automatic Resize Handling', description: ( <> - Automatically resizes `Renderer`, `Camera`, `EffectComposer`. Using `rendererResize` event is also possibile to set resolution for custom shaders. + Automatically resizes Renderer, Camera, EffectComposer. + Using the rendererResize event, you can easily set the resolution for custom shaders. ) }, @@ -21,19 +22,15 @@ const FeatureList: FeatureItem[] = [ title: 'Smart Rendering', description: ( <> - Smart rendering allows a frame to render only when it is needed, which is particularly useful when using mostly static scenes, optimizing performance and reducing unnecessary computational overhead.
- It is based on a `Scene` property called `needsRender`, which is changed automatically when there is a change in position, scale, rotation, visiblity, focus, removal or addition of `Object3D`. - It is also possible to change it manually, in cases where changes are not automatically identified. + Optimize performance by rendering frames only when necessary, reducing computational load. ) }, { - title: 'Simplified Rendering', + title: 'Simplified Multiple Rendering', description: ( <> - The rendering of viewports is handled by the `Main` class, using the `createView` method, which returns an instance of `RenderView`.
- By modifying the various properties of this instance, various parameters can be changed, including: the size, position, background, interaction state, and visibility. - It is also possible to specify an `EffectComposer` for each RenderView to handle post-processing effects. + Easily handle rendering for multiple scenes or viewports on a single canvas. ) }, @@ -41,9 +38,7 @@ const FeatureList: FeatureItem[] = [ title: 'Object3D Property Binding', description: ( <> - It is possible to bind to a property of an `Object3D` the result of a callback, using the `bindProperty` method.
- The bindings are computed automatically during each animate cycle. - To manually compute the various bindings using the `setManualDetectionMode` and `detectChanges` methods. + Simplify Object3D property management. ) }, @@ -51,8 +46,8 @@ const FeatureList: FeatureItem[] = [ title: 'Event Programming', description: ( <> - It facilitates interaction with `Object3D` by adding a series of programmable events.
- Interaction events work similarly to DOM events, with the same propagation and methods such as `preventDefault` or `stopPropagation`.
+ Add interactions to Object3D through programmable events, similar to DOM events. + It is possible to bind events on changing position, scale, rotation, visibility and enabled state. ) }, @@ -60,8 +55,7 @@ const FeatureList: FeatureItem[] = [ title: 'Focus and Blur', description: ( <> - Implements focus handling and related events to handle certain interactions more easily.
- By setting the value of the `focusable` property of an `Object3D` you can determine whether it can receive focus. + Enhance interactivity with focus and blur events. ) }, @@ -69,10 +63,7 @@ const FeatureList: FeatureItem[] = [ title: 'Drag and Drop', description: ( <> - Implements drag and drop handling and related events by adding two properties to each `Object3D`:
- `draggable`: makes an object draggable.
- `findDropTarget`: determines whether intersections with drop targets will be checked during dragging.
- The drag can be cancelled by pressing 'Esc'. + Seamlessly integrate drag and drop functionality. ) }, @@ -80,7 +71,7 @@ const FeatureList: FeatureItem[] = [ title: 'Hitbox Functionality', description: ( <> - Hitboxes can be used to handle a different intersection area or to simplify intersection calculations. + Utilize hitboxes for customized intersections or simplified calculations. ) }, @@ -88,8 +79,7 @@ const FeatureList: FeatureItem[] = [ title: 'Raycasting Options', description: ( <> - It is possible to choose between continuous raycasting (every frame) or raycasting only during mouse movement, providing the flexibility to optimise raycasting operations according to application requirements.
- In addition, it is possible to choose which objects can be intersected, setting `interceptByRaycaster` property. + Choose between continuous or mouse movement-based raycasting, optimizing intersection operations. ) }, @@ -97,7 +87,7 @@ const FeatureList: FeatureItem[] = [ title: 'Tweening', description: ( <> - Implements smooth animations effortlessly with built-in tweening functionality. `Vector3`, `Euler`, `Quaternion`, `Color` are supported. + Create smooth animations effortlessly with built-in tweening. ) }, @@ -105,7 +95,7 @@ const FeatureList: FeatureItem[] = [ title: 'Simplified InstancedMesh', description: ( <> - With the class `InstancedMesh2` it is possible to handle each sub-entity of an `InstancedMesh` as if it were an `Object3D`. This makes development much simpler and more intuitive. + Manage InstancedMesh instances as if they were Object3D, simplifying creation and manipulation. ) } diff --git a/src/core/Main.ts b/src/core/Main.ts index 7525692..66e09fa 100644 --- a/src/core/Main.ts +++ b/src/core/Main.ts @@ -13,13 +13,13 @@ import { RaycasterSortComparer } from "../events/RaycasterManager"; * Represents the configuration parameters for initializing the Main class. */ export interface MainParameters { - /** A Boolean flag indicating whether to enable full-screen mode and perform automatic resizing of the canvas (default: true). */ + /** A boolean flag indicating whether to enable full-screen mode and perform automatic resizing of the canvas (default: true). */ fullscreen?: boolean; /** A boolean flag indicating whether to display performance statistics (default: true). */ showStats?: boolean; /** A boolean flag indicating whether to disable the context menu on right-click (default: true). */ disableContextMenu?: boolean; - /** The default background color (default: black). */ + /** The default background color (default: 'black'). */ backgroundColor?: ColorRepresentation; /** The default alpha (transparency) value for the background (default: 1). */ backgroundAlpha?: number; diff --git a/src/rendering/RenderView.ts b/src/rendering/RenderView.ts index 5f98ed2..d045996 100644 --- a/src/rendering/RenderView.ts +++ b/src/rendering/RenderView.ts @@ -5,13 +5,13 @@ import { EffectComposer } from "three/examples/jsm/postprocessing/EffectComposer * Represents an object that defines the dimensions and position of a viewport. */ export interface Viewport { - /** The left coordinate of the viewport. */ + /** Left coordinate of the viewport. */ left: number; - /** The bottom coordinate of the viewport. */ + /** Bottom coordinate of the viewport. */ bottom: number; - /** The width of the viewport */ + /** Width of the viewport. */ width: number; - /** The height of the viewport. */ + /** Height of the viewport. */ height: number; } @@ -19,25 +19,25 @@ export interface Viewport { * Represents a set of parameters for configuring a view. */ export interface ViewParameters { - /** The scene to be rendered in the view. */ + /** Scene rendered in the view. */ scene: Scene; - /** The camera used to view the scene (Don't use the same camera for differents scenes). */ + /** Camera used to view the scene (avoid using the same camera for different scenes). */ camera: Camera; - /** The normalized viewport defining the dimensions and position of the view (optional). Values range from 0 to 1. */ + /** Normalized viewport defining dimensions and position of the view (optional). Values range from 0 to 1. */ viewport?: Viewport; - /** The tags of the view. */ + /** Tags of the view (optional). */ tags?: string[]; /** Determines if the view is visible (optional, default: true). */ visible?: boolean; - /** Determines whether InteractionEvents will be triggered for the view. (optional, default: true). */ + /** Determines whether InteractionEvents will be triggered for the view (optional, default: true). */ enabled?: boolean; - /** The background color of the view (optional). It can be a Color object or a numeric value representing the color. */ + /** Background color of the view (optional, default: 'black'). */ backgroundColor?: ColorRepresentation; - /** The background alpha value of the view (optional, default: 1). */ + /** Background alpha value of the view (optional, default: 1). */ backgroundAlpha?: number; - /** The effect composer used for post-processing (optional). */ + /** Effect composer used for post-processing (optional). */ composer?: EffectComposer; - /** Function to be called before rendering the view (optional). */ + /** Function called before rendering the view (optional). */ onBeforeRender?: () => void; /** Function to be called after rendering the view (optional). */ onAfterRender?: () => void;