diff --git a/docs/docs/api/classes/Cameras.OrthographicCameraAuto.md b/docs/docs/api/classes/Cameras.OrthographicCameraAuto.md index 706ac6c..aae8f38 100644 --- a/docs/docs/api/classes/Cameras.OrthographicCameraAuto.md +++ b/docs/docs/api/classes/Cameras.OrthographicCameraAuto.md @@ -7,7 +7,7 @@ custom_edit_url: null [Cameras](../namespaces/Cameras.md).OrthographicCameraAuto -Orthographic camera that resizes automatically. +Extends the OrthographicCamera to automatically resize based on a fixed width or height dimension. ## Hierarchy @@ -36,15 +36,288 @@ OrthographicCamera.constructor #### Defined in -[src/cameras/OrthographicCameraAuto.ts:36](https://github.com/agargaro/three.ez/blob/16c77a5/src/cameras/OrthographicCameraAuto.ts#L36) +[src/cameras/OrthographicCameraAuto.ts:36](https://github.com/agargaro/three.ez/blob/a81f57c/src/cameras/OrthographicCameraAuto.ts#L36) + +## Properties + +### cursor + +• **cursor**: [`Cursor`](../namespaces/Events.md#cursor) + +Cursor style when interacting with the object. + +#### Inherited from + +OrthographicCamera.cursor + +#### Defined in + +[src/patch/Object3D.ts:53](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L53) + +___ + +### cursorDrag + +• **cursorDrag**: [`Cursor`](../namespaces/Events.md#cursor) + +Cursor style when dragging the object. + +#### Inherited from + +OrthographicCamera.cursorDrag + +#### Defined in + +[src/patch/Object3D.ts:55](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L55) + +___ + +### cursorDrop + +• **cursorDrop**: [`Cursor`](../namespaces/Events.md#cursor) + +Cursor style when dropping an object onto this one. + +#### Inherited from + +OrthographicCamera.cursorDrop + +#### Defined in + +[src/patch/Object3D.ts:57](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L57) + +___ + +### dragTarget + +• **dragTarget**: `Object3D`<`Object3DEventMap`\> + +Indicates which object will be dragged instead of this one. + +#### Inherited from + +OrthographicCamera.dragTarget + +#### Defined in + +[src/patch/Object3D.ts:43](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L43) + +___ + +### draggable + +• **draggable**: `boolean` + +Indicates whether the object is draggable (default: false). + +#### Inherited from + +OrthographicCamera.draggable + +#### Defined in + +[src/patch/Object3D.ts:47](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L47) + +___ + +### enabled + +• **enabled**: `boolean` + +Determines if the object is enabled. (default: true). +If set to true, it allows triggering all InteractionEvents; otherwise, events are disabled. + +#### Inherited from + +OrthographicCamera.enabled + +#### Defined in + +[src/patch/Object3D.ts:37](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L37) + +___ + +### findDropTarget + +• **findDropTarget**: `boolean` + +Determines when the object is dragged, whether it will have to search for any drop targets (default: false). + +#### Inherited from + +OrthographicCamera.findDropTarget + +#### Defined in + +[src/patch/Object3D.ts:49](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L49) + +___ + +### focusable + +• **focusable**: `boolean` + +Indicates whether the object can receive focus (default: true). + +#### Inherited from + +OrthographicCamera.focusable + +#### Defined in + +[src/patch/Object3D.ts:45](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L45) + +___ + +### hitboxes + +• **hitboxes**: `Mesh`<`BufferGeometry`<`NormalBufferAttributes`\>, `Material` \| `Material`[], `Object3DEventMap`\>[] + +Array of hitboxes for collision detection. + +#### Inherited from + +OrthographicCamera.hitboxes + +#### Defined in + +[src/patch/Object3D.ts:41](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L41) + +___ + +### interceptByRaycaster + +• **interceptByRaycaster**: `boolean` + +Determines if the object can be intercepted by a raycaster (default: true). + +#### Inherited from + +OrthographicCamera.interceptByRaycaster + +#### Defined in + +[src/patch/Object3D.ts:39](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L39) + +___ + +### needsRender + +• **needsRender**: `boolean` + +Indicates whether the scene needs rendering. + +#### Inherited from + +OrthographicCamera.needsRender + +#### Defined in + +[src/patch/Object3D.ts:59](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L59) + +___ + +### scene + +• **scene**: `Scene` + +Reference to the scene the object belongs to. + +#### Inherited from + +OrthographicCamera.scene + +#### Defined in + +[src/patch/Object3D.ts:51](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L51) ## Accessors +### clicking + +• `get` **clicking**(): `boolean` + +Indicates if the object is currently being clicked. + +#### Returns + +`boolean` + +#### Inherited from + +OrthographicCamera.clicking + +#### Defined in + +[src/patch/Object3D.ts:65](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L65) + +___ + +### dragging + +• `get` **dragging**(): `boolean` + +Indicates if the object is currently being dragged. + +#### Returns + +`boolean` + +#### Inherited from + +OrthographicCamera.dragging + +#### Defined in + +[src/patch/Object3D.ts:67](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L67) + +___ + +### enabledState + +• `get` **enabledState**(): `boolean` + +Retrieves the combined enabled state considering parent objects. + +#### Returns + +`boolean` + +#### Inherited from + +OrthographicCamera.enabledState + +#### Defined in + +[src/patch/Object3D.ts:69](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L69) + +___ + +### firstFocusable + +• `get` **firstFocusable**(): `Object3D`<`Object3DEventMap`\> + +Retrieves the first possible focusable object. + +#### Returns + +`Object3D`<`Object3DEventMap`\> + +#### Inherited from + +OrthographicCamera.firstFocusable + +#### Defined in + +[src/patch/Object3D.ts:73](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L73) + +___ + ### fixedWidth • `get` **fixedWidth**(): `boolean` -If true, the 'size' property will refer to the width. If not, to the height. +Determines whether the 'size' property refers to the width (true) or height (false). #### Returns @@ -52,7 +325,47 @@ 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/16c77a5/src/cameras/OrthographicCameraAuto.ts#L24) +[src/cameras/OrthographicCameraAuto.ts:24](https://github.com/agargaro/three.ez/blob/a81f57c/src/cameras/OrthographicCameraAuto.ts#L24) + +___ + +### focused + +• `get` **focused**(): `boolean` + +Indicates if the object is currently focused. + +#### Returns + +`boolean` + +#### Inherited from + +OrthographicCamera.focused + +#### Defined in + +[src/patch/Object3D.ts:63](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L63) + +___ + +### hovered + +• `get` **hovered**(): `boolean` + +Indicates if the primary pointer is over this object. + +#### Returns + +`boolean` + +#### Inherited from + +OrthographicCamera.hovered + +#### Defined in + +[src/patch/Object3D.ts:61](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L61) ___ @@ -60,7 +373,7 @@ ___ • `get` **size**(): `number` -Fixed width or height dimension based on the 'fixedWidth' property. +Gets or sets the fixed width or height dimension based on the 'fixedWidth' property. #### Returns @@ -68,4 +381,402 @@ Fixed width or height dimension based on the 'fixedWidth' property. #### Defined in -[src/cameras/OrthographicCameraAuto.ts:15](https://github.com/agargaro/three.ez/blob/16c77a5/src/cameras/OrthographicCameraAuto.ts#L15) +[src/cameras/OrthographicCameraAuto.ts:15](https://github.com/agargaro/three.ez/blob/a81f57c/src/cameras/OrthographicCameraAuto.ts#L15) + +___ + +### visibilityState + +• `get` **visibilityState**(): `boolean` + +Retrieves the combined visibility state considering parent objects. + +#### Returns + +`boolean` + +#### Inherited from + +OrthographicCamera.visibilityState + +#### Defined in + +[src/patch/Object3D.ts:71](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L71) + +## Methods + +### applyBlur + +▸ **applyBlur**(): `void` + +Applies blur (removes focus) from the object. + +#### Returns + +`void` + +#### Inherited from + +OrthographicCamera.applyBlur + +#### Defined in + +[src/patch/Object3D.ts:81](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L81) + +___ + +### applyFocus + +▸ **applyFocus**(): `void` + +Applies focus to the object. + +#### Returns + +`void` + +#### Inherited from + +OrthographicCamera.applyFocus + +#### Defined in + +[src/patch/Object3D.ts:77](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L77) + +___ + +### bindProperty + +▸ **bindProperty**<`T`\>(`property`, `getCallback`, `renderOnChange?`): [`OrthographicCameraAuto`](Cameras.OrthographicCameraAuto.md) + +Binds a property to a callback function for updates. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof [`OrthographicCameraAuto`](Cameras.OrthographicCameraAuto.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `property` | `T` | The name of the property to bind. | +| `getCallback` | () => [`OrthographicCameraAuto`](Cameras.OrthographicCameraAuto.md)[`T`] | A function that retrieves the property's value. | +| `renderOnChange?` | `boolean` | Indicates whether to render when the property changes (optional, default: false). | + +#### Returns + +[`OrthographicCameraAuto`](Cameras.OrthographicCameraAuto.md) + +The instance of the object with the binding applied. + +#### Inherited from + +OrthographicCamera.bindProperty + +#### Defined in + +[src/patch/Object3D.ts:133](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L133) + +___ + +### detectChanges + +▸ **detectChanges**(`recursive?`): `void` + +Calculates all bindings on the current object. +If 'recursive' is set to true, it will also calculate bindings for all children. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `recursive?` | `boolean` | Optional. If true, calculate bindings for children as well. | + +#### Returns + +`void` + +#### Inherited from + +OrthographicCamera.detectChanges + +#### Defined in + +[src/patch/Object3D.ts:125](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L125) + +___ + +### hasEvent + +▸ **hasEvent**<`K`\>(`type`, `listener`): `boolean` + +Checks if the object has a specific event listener. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof [`MiscEvents`](../interfaces/Events.MiscEvents.md) \| keyof [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\> \| keyof [`UpdateEvents`](../interfaces/Events.UpdateEvents.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `K` | The type of event to check for. | +| `listener` | (`event?`: `Events`[`K`]) => `void` | The callback function to check. | + +#### Returns + +`boolean` + +`true` if the event listener is attached; otherwise, `false`. + +#### Inherited from + +OrthographicCamera.hasEvent + +#### Defined in + +[src/patch/Object3D.ts:95](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L95) + +___ + +### off + +▸ **off**<`K`\>(`type`, `listener`): `void` + +Removes an event listener from the object. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof [`MiscEvents`](../interfaces/Events.MiscEvents.md) \| keyof [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\> \| keyof [`UpdateEvents`](../interfaces/Events.UpdateEvents.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `K` | The type of event to remove the listener from. | +| `listener` | (`event?`: `Events`[`K`]) => `void` | The callback function to remove. | + +#### Returns + +`void` + +#### Inherited from + +OrthographicCamera.off + +#### Defined in + +[src/patch/Object3D.ts:101](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L101) + +___ + +### on + +▸ **on**<`K`\>(`type`, `listener`): (`event?`: `Events`[`K`]) => `void` + +Attaches an event listener to the object. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof [`MiscEvents`](../interfaces/Events.MiscEvents.md) \| keyof [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\> \| keyof [`UpdateEvents`](../interfaces/Events.UpdateEvents.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `K` \| `K`[] | The type of event to listen for. | +| `listener` | (`this`: [`OrthographicCameraAuto`](Cameras.OrthographicCameraAuto.md), `event?`: `Events`[`K`]) => `void` | The callback function to execute when the event occurs. | + +#### Returns + +`fn` + +A function to remove the event listener. + +▸ (`event?`): `void` + +Attaches an event listener to the object. + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `Events`[`K`] | + +##### Returns + +`void` + +A function to remove the event listener. + +#### Inherited from + +OrthographicCamera.on + +#### Defined in + +[src/patch/Object3D.ts:88](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L88) + +___ + +### setManualDetectionMode + +▸ **setManualDetectionMode**(): `void` + +Activates manual detection mode for bindings. +When this method is used, all bindings will no longer be calculated automatically. +Instead, they must be manually computed using the 'detectChanges' function. + +#### Returns + +`void` + +#### Inherited from + +OrthographicCamera.setManualDetectionMode + +#### Defined in + +[src/patch/Object3D.ts:119](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L119) + +___ + +### trigger + +▸ **trigger**<`K`\>(`type`, `event?`): `void` + +Triggers a specific event on the object. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof [`MiscEvents`](../interfaces/Events.MiscEvents.md) \| keyof [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\> \| keyof [`UpdateEvents`](../interfaces/Events.UpdateEvents.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `K` | The type of event to trigger. | +| `event?` | `Events`[`K`] | Optional event data to pass to the listeners. | + +#### Returns + +`void` + +#### Inherited from + +OrthographicCamera.trigger + +#### Defined in + +[src/patch/Object3D.ts:107](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L107) + +___ + +### triggerAncestor + +▸ **triggerAncestor**<`K`\>(`type`, `event?`): `void` + +Triggers a specific event on the object and all its ancestors. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\> | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `K` | The type of event to trigger. | +| `event?` | [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\>[`K`] | Optional event data to pass to the listeners. | + +#### Returns + +`void` + +#### Inherited from + +OrthographicCamera.triggerAncestor + +#### Defined in + +[src/patch/Object3D.ts:113](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L113) + +___ + +### tween + +▸ **tween**<`T`\>(`id?`): [`Tween`](Tweening.Tween.md)<`T`\> + +Initiates a Tween animation for the object. + +#### Type parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `T` | extends `Object3D`<`Object3DEventMap`, `T`\> = `Object3D`<`Object3DEventMap`\> | The type of the target. | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id?` | `string` | Unique identifier. If you start a new tween, the old one with the same id (if specified) will be stopped. | + +#### Returns + +[`Tween`](Tweening.Tween.md)<`T`\> + +A Tween instance for further configuration. + +#### Inherited from + +OrthographicCamera.tween + +#### Defined in + +[src/patch/Object3D.ts:146](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L146) + +___ + +### unbindProperty + +▸ **unbindProperty**<`T`\>(`property`): [`OrthographicCameraAuto`](Cameras.OrthographicCameraAuto.md) + +Unbinds a previously bound property from the object. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof [`OrthographicCameraAuto`](Cameras.OrthographicCameraAuto.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `property` | `T` | The name of the property to unbind. | + +#### Returns + +[`OrthographicCameraAuto`](Cameras.OrthographicCameraAuto.md) + +The instance of the object with the binding removed. + +#### Inherited from + +OrthographicCamera.unbindProperty + +#### Defined in + +[src/patch/Object3D.ts:139](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L139) diff --git a/docs/docs/api/classes/Cameras.PerspectiveCameraAuto.md b/docs/docs/api/classes/Cameras.PerspectiveCameraAuto.md index 4ad1c27..a37cc32 100644 --- a/docs/docs/api/classes/Cameras.PerspectiveCameraAuto.md +++ b/docs/docs/api/classes/Cameras.PerspectiveCameraAuto.md @@ -7,7 +7,7 @@ custom_edit_url: null [Cameras](../namespaces/Cameras.md).PerspectiveCameraAuto -Perspective camera that resizes automatically. +Extends the PerspectiveCamera to automatically adjust its aspect ratio on renderer resize. ## Hierarchy @@ -25,9 +25,9 @@ Perspective camera that resizes automatically. | Name | Type | Description | | :------ | :------ | :------ | -| `fov?` | `number` | Camera frustum vertical field of view. Default `50`. | -| `near?` | `number` | Camera frustum near plane. Default `0.1`. | -| `far?` | `number` | Camera frustum far plane. Default `2000`. | +| `fov?` | `number` | Camera frustum vertical field of view in degrees. Default `50`. | +| `near?` | `number` | Camera frustum near plane distance. Default `0.1`. | +| `far?` | `number` | Camera frustum far plane distance. Default `2000`. | #### Overrides @@ -35,4 +35,715 @@ PerspectiveCamera.constructor #### Defined in -[src/cameras/PerspectiveCameraAuto.ts:13](https://github.com/agargaro/three.ez/blob/16c77a5/src/cameras/PerspectiveCameraAuto.ts#L13) +[src/cameras/PerspectiveCameraAuto.ts:13](https://github.com/agargaro/three.ez/blob/a81f57c/src/cameras/PerspectiveCameraAuto.ts#L13) + +## Properties + +### cursor + +• **cursor**: [`Cursor`](../namespaces/Events.md#cursor) + +Cursor style when interacting with the object. + +#### Inherited from + +PerspectiveCamera.cursor + +#### Defined in + +[src/patch/Object3D.ts:53](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L53) + +___ + +### cursorDrag + +• **cursorDrag**: [`Cursor`](../namespaces/Events.md#cursor) + +Cursor style when dragging the object. + +#### Inherited from + +PerspectiveCamera.cursorDrag + +#### Defined in + +[src/patch/Object3D.ts:55](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L55) + +___ + +### cursorDrop + +• **cursorDrop**: [`Cursor`](../namespaces/Events.md#cursor) + +Cursor style when dropping an object onto this one. + +#### Inherited from + +PerspectiveCamera.cursorDrop + +#### Defined in + +[src/patch/Object3D.ts:57](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L57) + +___ + +### dragTarget + +• **dragTarget**: `Object3D`<`Object3DEventMap`\> + +Indicates which object will be dragged instead of this one. + +#### Inherited from + +PerspectiveCamera.dragTarget + +#### Defined in + +[src/patch/Object3D.ts:43](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L43) + +___ + +### draggable + +• **draggable**: `boolean` + +Indicates whether the object is draggable (default: false). + +#### Inherited from + +PerspectiveCamera.draggable + +#### Defined in + +[src/patch/Object3D.ts:47](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L47) + +___ + +### enabled + +• **enabled**: `boolean` + +Determines if the object is enabled. (default: true). +If set to true, it allows triggering all InteractionEvents; otherwise, events are disabled. + +#### Inherited from + +PerspectiveCamera.enabled + +#### Defined in + +[src/patch/Object3D.ts:37](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L37) + +___ + +### findDropTarget + +• **findDropTarget**: `boolean` + +Determines when the object is dragged, whether it will have to search for any drop targets (default: false). + +#### Inherited from + +PerspectiveCamera.findDropTarget + +#### Defined in + +[src/patch/Object3D.ts:49](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L49) + +___ + +### focusable + +• **focusable**: `boolean` + +Indicates whether the object can receive focus (default: true). + +#### Inherited from + +PerspectiveCamera.focusable + +#### Defined in + +[src/patch/Object3D.ts:45](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L45) + +___ + +### hitboxes + +• **hitboxes**: `Mesh`<`BufferGeometry`<`NormalBufferAttributes`\>, `Material` \| `Material`[], `Object3DEventMap`\>[] + +Array of hitboxes for collision detection. + +#### Inherited from + +PerspectiveCamera.hitboxes + +#### Defined in + +[src/patch/Object3D.ts:41](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L41) + +___ + +### interceptByRaycaster + +• **interceptByRaycaster**: `boolean` + +Determines if the object can be intercepted by a raycaster (default: true). + +#### Inherited from + +PerspectiveCamera.interceptByRaycaster + +#### Defined in + +[src/patch/Object3D.ts:39](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L39) + +___ + +### needsRender + +• **needsRender**: `boolean` + +Indicates whether the scene needs rendering. + +#### Inherited from + +PerspectiveCamera.needsRender + +#### Defined in + +[src/patch/Object3D.ts:59](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L59) + +___ + +### scene + +• **scene**: `Scene` + +Reference to the scene the object belongs to. + +#### Inherited from + +PerspectiveCamera.scene + +#### Defined in + +[src/patch/Object3D.ts:51](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L51) + +## Accessors + +### clicking + +• `get` **clicking**(): `boolean` + +Indicates if the object is currently being clicked. + +#### Returns + +`boolean` + +#### Inherited from + +PerspectiveCamera.clicking + +#### Defined in + +[src/patch/Object3D.ts:65](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L65) + +___ + +### dragging + +• `get` **dragging**(): `boolean` + +Indicates if the object is currently being dragged. + +#### Returns + +`boolean` + +#### Inherited from + +PerspectiveCamera.dragging + +#### Defined in + +[src/patch/Object3D.ts:67](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L67) + +___ + +### enabledState + +• `get` **enabledState**(): `boolean` + +Retrieves the combined enabled state considering parent objects. + +#### Returns + +`boolean` + +#### Inherited from + +PerspectiveCamera.enabledState + +#### Defined in + +[src/patch/Object3D.ts:69](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L69) + +___ + +### firstFocusable + +• `get` **firstFocusable**(): `Object3D`<`Object3DEventMap`\> + +Retrieves the first possible focusable object. + +#### Returns + +`Object3D`<`Object3DEventMap`\> + +#### Inherited from + +PerspectiveCamera.firstFocusable + +#### Defined in + +[src/patch/Object3D.ts:73](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L73) + +___ + +### focused + +• `get` **focused**(): `boolean` + +Indicates if the object is currently focused. + +#### Returns + +`boolean` + +#### Inherited from + +PerspectiveCamera.focused + +#### Defined in + +[src/patch/Object3D.ts:63](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L63) + +___ + +### hovered + +• `get` **hovered**(): `boolean` + +Indicates if the primary pointer is over this object. + +#### Returns + +`boolean` + +#### Inherited from + +PerspectiveCamera.hovered + +#### Defined in + +[src/patch/Object3D.ts:61](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L61) + +___ + +### visibilityState + +• `get` **visibilityState**(): `boolean` + +Retrieves the combined visibility state considering parent objects. + +#### Returns + +`boolean` + +#### Inherited from + +PerspectiveCamera.visibilityState + +#### Defined in + +[src/patch/Object3D.ts:71](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L71) + +## Methods + +### applyBlur + +▸ **applyBlur**(): `void` + +Applies blur (removes focus) from the object. + +#### Returns + +`void` + +#### Inherited from + +PerspectiveCamera.applyBlur + +#### Defined in + +[src/patch/Object3D.ts:81](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L81) + +___ + +### applyFocus + +▸ **applyFocus**(): `void` + +Applies focus to the object. + +#### Returns + +`void` + +#### Inherited from + +PerspectiveCamera.applyFocus + +#### Defined in + +[src/patch/Object3D.ts:77](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L77) + +___ + +### bindProperty + +▸ **bindProperty**<`T`\>(`property`, `getCallback`, `renderOnChange?`): [`PerspectiveCameraAuto`](Cameras.PerspectiveCameraAuto.md) + +Binds a property to a callback function for updates. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof [`PerspectiveCameraAuto`](Cameras.PerspectiveCameraAuto.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `property` | `T` | The name of the property to bind. | +| `getCallback` | () => [`PerspectiveCameraAuto`](Cameras.PerspectiveCameraAuto.md)[`T`] | A function that retrieves the property's value. | +| `renderOnChange?` | `boolean` | Indicates whether to render when the property changes (optional, default: false). | + +#### Returns + +[`PerspectiveCameraAuto`](Cameras.PerspectiveCameraAuto.md) + +The instance of the object with the binding applied. + +#### Inherited from + +PerspectiveCamera.bindProperty + +#### Defined in + +[src/patch/Object3D.ts:133](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L133) + +___ + +### detectChanges + +▸ **detectChanges**(`recursive?`): `void` + +Calculates all bindings on the current object. +If 'recursive' is set to true, it will also calculate bindings for all children. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `recursive?` | `boolean` | Optional. If true, calculate bindings for children as well. | + +#### Returns + +`void` + +#### Inherited from + +PerspectiveCamera.detectChanges + +#### Defined in + +[src/patch/Object3D.ts:125](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L125) + +___ + +### hasEvent + +▸ **hasEvent**<`K`\>(`type`, `listener`): `boolean` + +Checks if the object has a specific event listener. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof [`MiscEvents`](../interfaces/Events.MiscEvents.md) \| keyof [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\> \| keyof [`UpdateEvents`](../interfaces/Events.UpdateEvents.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `K` | The type of event to check for. | +| `listener` | (`event?`: `Events`[`K`]) => `void` | The callback function to check. | + +#### Returns + +`boolean` + +`true` if the event listener is attached; otherwise, `false`. + +#### Inherited from + +PerspectiveCamera.hasEvent + +#### Defined in + +[src/patch/Object3D.ts:95](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L95) + +___ + +### off + +▸ **off**<`K`\>(`type`, `listener`): `void` + +Removes an event listener from the object. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof [`MiscEvents`](../interfaces/Events.MiscEvents.md) \| keyof [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\> \| keyof [`UpdateEvents`](../interfaces/Events.UpdateEvents.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `K` | The type of event to remove the listener from. | +| `listener` | (`event?`: `Events`[`K`]) => `void` | The callback function to remove. | + +#### Returns + +`void` + +#### Inherited from + +PerspectiveCamera.off + +#### Defined in + +[src/patch/Object3D.ts:101](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L101) + +___ + +### on + +▸ **on**<`K`\>(`type`, `listener`): (`event?`: `Events`[`K`]) => `void` + +Attaches an event listener to the object. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof [`MiscEvents`](../interfaces/Events.MiscEvents.md) \| keyof [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\> \| keyof [`UpdateEvents`](../interfaces/Events.UpdateEvents.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `K` \| `K`[] | The type of event to listen for. | +| `listener` | (`this`: [`PerspectiveCameraAuto`](Cameras.PerspectiveCameraAuto.md), `event?`: `Events`[`K`]) => `void` | The callback function to execute when the event occurs. | + +#### Returns + +`fn` + +A function to remove the event listener. + +▸ (`event?`): `void` + +Attaches an event listener to the object. + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `Events`[`K`] | + +##### Returns + +`void` + +A function to remove the event listener. + +#### Inherited from + +PerspectiveCamera.on + +#### Defined in + +[src/patch/Object3D.ts:88](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L88) + +___ + +### setManualDetectionMode + +▸ **setManualDetectionMode**(): `void` + +Activates manual detection mode for bindings. +When this method is used, all bindings will no longer be calculated automatically. +Instead, they must be manually computed using the 'detectChanges' function. + +#### Returns + +`void` + +#### Inherited from + +PerspectiveCamera.setManualDetectionMode + +#### Defined in + +[src/patch/Object3D.ts:119](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L119) + +___ + +### trigger + +▸ **trigger**<`K`\>(`type`, `event?`): `void` + +Triggers a specific event on the object. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof [`MiscEvents`](../interfaces/Events.MiscEvents.md) \| keyof [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\> \| keyof [`UpdateEvents`](../interfaces/Events.UpdateEvents.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `K` | The type of event to trigger. | +| `event?` | `Events`[`K`] | Optional event data to pass to the listeners. | + +#### Returns + +`void` + +#### Inherited from + +PerspectiveCamera.trigger + +#### Defined in + +[src/patch/Object3D.ts:107](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L107) + +___ + +### triggerAncestor + +▸ **triggerAncestor**<`K`\>(`type`, `event?`): `void` + +Triggers a specific event on the object and all its ancestors. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\> | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `K` | The type of event to trigger. | +| `event?` | [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\>[`K`] | Optional event data to pass to the listeners. | + +#### Returns + +`void` + +#### Inherited from + +PerspectiveCamera.triggerAncestor + +#### Defined in + +[src/patch/Object3D.ts:113](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L113) + +___ + +### tween + +▸ **tween**<`T`\>(`id?`): [`Tween`](Tweening.Tween.md)<`T`\> + +Initiates a Tween animation for the object. + +#### Type parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `T` | extends `Object3D`<`Object3DEventMap`, `T`\> = `Object3D`<`Object3DEventMap`\> | The type of the target. | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id?` | `string` | Unique identifier. If you start a new tween, the old one with the same id (if specified) will be stopped. | + +#### Returns + +[`Tween`](Tweening.Tween.md)<`T`\> + +A Tween instance for further configuration. + +#### Inherited from + +PerspectiveCamera.tween + +#### Defined in + +[src/patch/Object3D.ts:146](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L146) + +___ + +### unbindProperty + +▸ **unbindProperty**<`T`\>(`property`): [`PerspectiveCameraAuto`](Cameras.PerspectiveCameraAuto.md) + +Unbinds a previously bound property from the object. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof [`PerspectiveCameraAuto`](Cameras.PerspectiveCameraAuto.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `property` | `T` | The name of the property to unbind. | + +#### Returns + +[`PerspectiveCameraAuto`](Cameras.PerspectiveCameraAuto.md) + +The instance of the object with the binding removed. + +#### Inherited from + +PerspectiveCamera.unbindProperty + +#### Defined in + +[src/patch/Object3D.ts:139](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L139) diff --git a/docs/docs/api/classes/Core.Main.md b/docs/docs/api/classes/Core.Main.md index 7139f92..73d6db5 100644 --- a/docs/docs/api/classes/Core.Main.md +++ b/docs/docs/api/classes/Core.Main.md @@ -20,11 +20,11 @@ It provides configuration options and methods for setting up and controlling the | Name | Type | Description | | :------ | :------ | :------ | -| `parameters` | [`MainParameters`](../interfaces/Core.MainParameters.md) | Represents the configuration parameters for initializing the Main class. | +| `parameters` | [`MainParameters`](../interfaces/Core.MainParameters.md) | Configuration parameters for initializing the Main class. | #### Defined in -[src/core/Main.ts:140](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L140) +[src/core/Main.ts:140](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L140) ## Properties @@ -36,7 +36,7 @@ A static counter representing the number of animation frames elapsed. #### Defined in -[src/core/Main.ts:42](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L42) +[src/core/Main.ts:42](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L42) ## Accessors @@ -52,7 +52,7 @@ The Camera associated with the currently active RenderView. #### Defined in -[src/core/Main.ts:74](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L74) +[src/core/Main.ts:74](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L74) ___ @@ -68,7 +68,7 @@ The EffectComposer (used for post-processing) associated with the currently acti #### Defined in -[src/core/Main.ts:79](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L79) +[src/core/Main.ts:79](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L79) ___ @@ -84,7 +84,7 @@ The Scene associated with the currently active RenderView. #### Defined in -[src/core/Main.ts:69](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L69) +[src/core/Main.ts:69](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L69) ___ @@ -100,7 +100,7 @@ The currently active RenderView (activated by mouse position). #### Defined in -[src/core/Main.ts:64](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L64) +[src/core/Main.ts:64](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L64) ___ @@ -116,7 +116,7 @@ The default alpha (transparency) value for the background. #### Defined in -[src/core/Main.ts:128](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L128) +[src/core/Main.ts:128](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L128) ___ @@ -132,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/16c77a5/src/core/Main.ts#L122) +[src/core/Main.ts:122](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L122) ___ @@ -140,7 +140,7 @@ ___ • `get` **enableCursor**(): `boolean` -A boolean flag indicating whether to enable cursor handling in the application. +Indicates whether to enable cursor handling in the application. #### Returns @@ -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/16c77a5/src/core/Main.ts#L105) +[src/core/Main.ts:105](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L105) ___ @@ -165,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/16c77a5/src/core/Main.ts#L135) +[src/core/Main.ts:135](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L135) ___ @@ -173,7 +173,7 @@ ___ • `get` **multitouch**(): `boolean` -A boolean flag indicating whether to enable multitouch interactions. +Indicates whether to enable multitouch interactions. #### Returns @@ -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/16c77a5/src/core/Main.ts#L99) +[src/core/Main.ts:99](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L99) ___ @@ -197,7 +197,7 @@ A Raycaster instance responsible for handling raycasting operations in the appli #### Defined in -[src/core/Main.ts:117](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L117) +[src/core/Main.ts:117](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L117) ___ @@ -213,7 +213,7 @@ A custom sorting comparer function used to order intersections when performing r #### Defined in -[src/core/Main.ts:111](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L111) +[src/core/Main.ts:111](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L111) ___ @@ -229,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/16c77a5/src/core/Main.ts#L53) +[src/core/Main.ts:53](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L53) ___ @@ -237,7 +237,7 @@ ___ • `get` **showStats**(): `boolean` -A boolean flag indicating whether to display performance statistics. +Indicates whether to display performance statistics. If set to true, statistics will be shown; otherwise, they will be hidden. #### Returns @@ -246,7 +246,7 @@ If set to true, statistics will be shown; otherwise, they will be hidden. #### Defined in -[src/core/Main.ts:85](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L85) +[src/core/Main.ts:85](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L85) ___ @@ -263,7 +263,7 @@ Lists all views created and managed by the application, each representing a sepa #### Defined in -[src/core/Main.ts:59](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L59) +[src/core/Main.ts:59](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L59) ## Methods @@ -285,7 +285,7 @@ Adds a RenderView to the RenderManager. #### Defined in -[src/core/Main.ts:212](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L212) +[src/core/Main.ts:212](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L212) ___ @@ -301,7 +301,7 @@ Clears all RenderViews from the RenderManager. #### Defined in -[src/core/Main.ts:244](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L244) +[src/core/Main.ts:244](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L244) ___ @@ -325,7 +325,7 @@ The created RenderView instance. #### Defined in -[src/core/Main.ts:204](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L204) +[src/core/Main.ts:204](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L204) ___ @@ -347,7 +347,7 @@ Retrieves a RenderView by mouse position. #### Defined in -[src/core/Main.ts:252](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L252) +[src/core/Main.ts:252](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L252) ___ @@ -371,7 +371,7 @@ The RenderView with the specified tag, if found, otherwise, undefined. #### Defined in -[src/core/Main.ts:221](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L221) +[src/core/Main.ts:221](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L221) ___ @@ -393,7 +393,7 @@ Removes a RenderView from the RenderManager. #### Defined in -[src/core/Main.ts:229](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L229) +[src/core/Main.ts:229](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L229) ___ @@ -415,7 +415,7 @@ Removes a RenderView from the RenderManager by its tag. #### Defined in -[src/core/Main.ts:237](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L237) +[src/core/Main.ts:237](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L237) ___ @@ -437,4 +437,4 @@ Sets active RenderViews by tag. #### Defined in -[src/core/Main.ts:260](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L260) +[src/core/Main.ts:260](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L260) diff --git a/docs/docs/api/classes/Events.DragEventExt.md b/docs/docs/api/classes/Events.DragEventExt.md index 173df2e..e995bc5 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/16c77a5/src/events/Events.ts#L268) +[src/events/Events.ts:268](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L115) +[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L117) +[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L256) +[src/events/Events.ts:256](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L199) +[src/events/Events.ts:199](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L258) +[src/events/Events.ts:258](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L191) +[src/events/Events.ts:191](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L123) +[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L165) +[src/events/Events.ts:165](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L113) +[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L167) +[src/events/Events.ts:167](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L169) +[src/events/Events.ts:169](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L171) +[src/events/Events.ts:171](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L173) +[src/events/Events.ts:173](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L175) +[src/events/Events.ts:175](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L119) +[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L232) +[src/events/Events.ts:232](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L246) +[src/events/Events.ts:246](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L177) +[src/events/Events.ts:177](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L179) +[src/events/Events.ts:179](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L181) +[src/events/Events.ts:181](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L183) +[src/events/Events.ts:183](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L185) +[src/events/Events.ts:185](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L187) +[src/events/Events.ts:187](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L189) +[src/events/Events.ts:189](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L228) +[src/events/Events.ts:228](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L244) +[src/events/Events.ts:244](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L234) +[src/events/Events.ts:234](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L193) +[src/events/Events.ts:193](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L195) +[src/events/Events.ts:195](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L197) +[src/events/Events.ts:197](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L236) +[src/events/Events.ts:236](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L121) +[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L238) +[src/events/Events.ts:238](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L240) +[src/events/Events.ts:240](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L242) +[src/events/Events.ts:242](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L125) +[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L230) +[src/events/Events.ts:230](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L215) +[src/events/Events.ts:215](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L141) +[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L146) +[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L151) +[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L151) diff --git a/docs/docs/api/classes/Events.EventExt.md b/docs/docs/api/classes/Events.EventExt.md index be5882d..5e7e0a1 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/16c77a5/src/events/Events.ts#L136) +[src/events/Events.ts:136](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L115) +[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L117) +[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L123) +[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L113) +[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L119) +[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L121) +[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L125) +[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L141) +[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L146) +[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L151) +[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L151) diff --git a/docs/docs/api/classes/Events.FocusEventExt.md b/docs/docs/api/classes/Events.FocusEventExt.md index 0758354..b170397 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/16c77a5/src/events/Events.ts#L360) +[src/events/Events.ts:360](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L115) +[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L117) +[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L355) +[src/events/Events.ts:355](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L123) +[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L113) +[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L119) +[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L121) +[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L125) +[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L141) +[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L146) +[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L151) +[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L151) diff --git a/docs/docs/api/classes/Events.KeyboardEventExt.md b/docs/docs/api/classes/Events.KeyboardEventExt.md index 6b3cfe8..8870c31 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/16c77a5/src/events/Events.ts#L337) +[src/events/Events.ts:337](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L115) +[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L117) +[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L315) +[src/events/Events.ts:315](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L123) +[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L317) +[src/events/Events.ts:317](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L113) +[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L319) +[src/events/Events.ts:319](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L321) +[src/events/Events.ts:321](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L119) +[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L323) +[src/events/Events.ts:323](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L325) +[src/events/Events.ts:325](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L327) +[src/events/Events.ts:327](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L329) +[src/events/Events.ts:329](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L331) +[src/events/Events.ts:331](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L121) +[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L125) +[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L343) +[src/events/Events.ts:343](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L141) +[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L146) +[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L151) +[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L151) diff --git a/docs/docs/api/classes/Events.MouseEventExt.md b/docs/docs/api/classes/Events.MouseEventExt.md index 3663769..2c79ddb 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/16c77a5/src/events/Events.ts#L207) +[src/events/Events.ts:207](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L115) +[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L117) +[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L163) +[src/events/Events.ts:163](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L199) +[src/events/Events.ts:199](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L191) +[src/events/Events.ts:191](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L123) +[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L165) +[src/events/Events.ts:165](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L113) +[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L167) +[src/events/Events.ts:167](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L169) +[src/events/Events.ts:169](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L171) +[src/events/Events.ts:171](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L173) +[src/events/Events.ts:173](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L175) +[src/events/Events.ts:175](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L119) +[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L177) +[src/events/Events.ts:177](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L179) +[src/events/Events.ts:179](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L181) +[src/events/Events.ts:181](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L183) +[src/events/Events.ts:183](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L185) +[src/events/Events.ts:185](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L187) +[src/events/Events.ts:187](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L189) +[src/events/Events.ts:189](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L193) +[src/events/Events.ts:193](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L195) +[src/events/Events.ts:195](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L197) +[src/events/Events.ts:197](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L121) +[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L125) +[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L215) +[src/events/Events.ts:215](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L141) +[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L146) +[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L151) +[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L151) diff --git a/docs/docs/api/classes/Events.PointerEventExt.md b/docs/docs/api/classes/Events.PointerEventExt.md index 9e9b3da..c7e9289 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/16c77a5/src/events/Events.ts#L207) +[src/events/Events.ts:207](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L115) +[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L117) +[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L199) +[src/events/Events.ts:199](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L191) +[src/events/Events.ts:191](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L123) +[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L165) +[src/events/Events.ts:165](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L113) +[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L167) +[src/events/Events.ts:167](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L169) +[src/events/Events.ts:169](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L171) +[src/events/Events.ts:171](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L173) +[src/events/Events.ts:173](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L175) +[src/events/Events.ts:175](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L119) +[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L232) +[src/events/Events.ts:232](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L246) +[src/events/Events.ts:246](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L177) +[src/events/Events.ts:177](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L179) +[src/events/Events.ts:179](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L181) +[src/events/Events.ts:181](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L183) +[src/events/Events.ts:183](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L185) +[src/events/Events.ts:185](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L187) +[src/events/Events.ts:187](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L189) +[src/events/Events.ts:189](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L228) +[src/events/Events.ts:228](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L244) +[src/events/Events.ts:244](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L234) +[src/events/Events.ts:234](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L193) +[src/events/Events.ts:193](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L195) +[src/events/Events.ts:195](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L197) +[src/events/Events.ts:197](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L236) +[src/events/Events.ts:236](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L121) +[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L238) +[src/events/Events.ts:238](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L240) +[src/events/Events.ts:240](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L242) +[src/events/Events.ts:242](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L125) +[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L230) +[src/events/Events.ts:230](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L215) +[src/events/Events.ts:215](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L141) +[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L146) +[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L151) +[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L151) diff --git a/docs/docs/api/classes/Events.PointerIntersectionEvent.md b/docs/docs/api/classes/Events.PointerIntersectionEvent.md index 8531240..70d7526 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/16c77a5/src/events/Events.ts#L303) +[src/events/Events.ts:303](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L115) +[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L117) +[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L298) +[src/events/Events.ts:298](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L123) +[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L113) +[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L119) +[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L121) +[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L125) +[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L141) +[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L146) +[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L151) +[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L151) diff --git a/docs/docs/api/classes/Events.WheelEventExt.md b/docs/docs/api/classes/Events.WheelEventExt.md index f70e72b..2783df8 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/16c77a5/src/events/Events.ts#L207) +[src/events/Events.ts:207](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L115) +[src/events/Events.ts:115](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L117) +[src/events/Events.ts:117](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L199) +[src/events/Events.ts:199](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L191) +[src/events/Events.ts:191](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L123) +[src/events/Events.ts:123](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L165) +[src/events/Events.ts:165](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L113) +[src/events/Events.ts:113](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L167) +[src/events/Events.ts:167](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L169) +[src/events/Events.ts:169](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L171) +[src/events/Events.ts:171](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L173) +[src/events/Events.ts:173](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L175) +[src/events/Events.ts:175](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L119) +[src/events/Events.ts:119](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L285) +[src/events/Events.ts:285](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L287) +[src/events/Events.ts:287](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L289) +[src/events/Events.ts:289](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L177) +[src/events/Events.ts:177](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L179) +[src/events/Events.ts:179](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L181) +[src/events/Events.ts:181](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L183) +[src/events/Events.ts:183](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L185) +[src/events/Events.ts:185](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L187) +[src/events/Events.ts:187](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L189) +[src/events/Events.ts:189](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L193) +[src/events/Events.ts:193](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L195) +[src/events/Events.ts:195](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L197) +[src/events/Events.ts:197](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L121) +[src/events/Events.ts:121](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L125) +[src/events/Events.ts:125](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L215) +[src/events/Events.ts:215](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L141) +[src/events/Events.ts:141](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L146) +[src/events/Events.ts:146](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L151) +[src/events/Events.ts:151](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L151) diff --git a/docs/docs/api/classes/InstancedMesh.InstancedMesh2.md b/docs/docs/api/classes/InstancedMesh.InstancedMesh2.md index 215fdb3..ba9040e 100644 --- a/docs/docs/api/classes/InstancedMesh.InstancedMesh2.md +++ b/docs/docs/api/classes/InstancedMesh.InstancedMesh2.md @@ -7,7 +7,7 @@ custom_edit_url: null [InstancedMesh](../namespaces/InstancedMesh.md).InstancedMesh2 -An extension of the InstancedMesh class that allows individual management of each instance in a similar manner to an Object3D. +Extends the InstancedMesh class to provide individual management of each instance, similar to an Object3D. ## Hierarchy @@ -38,20 +38,181 @@ InstancedMesh.constructor #### Defined in -[src/instancedMesh/InstancedMesh2.ts:65](https://github.com/agargaro/three.ez/blob/16c77a5/src/instancedMesh/InstancedMesh2.ts#L65) +[src/instancedMesh/InstancedMesh2.ts:65](https://github.com/agargaro/three.ez/blob/a81f57c/src/instancedMesh/InstancedMesh2.ts#L65) ## Properties +### cursor + +• **cursor**: [`Cursor`](../namespaces/Events.md#cursor) + +Cursor style when interacting with the object. + +#### Inherited from + +InstancedMesh.cursor + +#### Defined in + +[src/patch/Object3D.ts:53](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L53) + +___ + +### cursorDrag + +• **cursorDrag**: [`Cursor`](../namespaces/Events.md#cursor) + +Cursor style when dragging the object. + +#### Inherited from + +InstancedMesh.cursorDrag + +#### Defined in + +[src/patch/Object3D.ts:55](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L55) + +___ + +### cursorDrop + +• **cursorDrop**: [`Cursor`](../namespaces/Events.md#cursor) + +Cursor style when dropping an object onto this one. + +#### Inherited from + +InstancedMesh.cursorDrop + +#### Defined in + +[src/patch/Object3D.ts:57](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L57) + +___ + +### dragTarget + +• **dragTarget**: `Object3D`<`Object3DEventMap`\> + +Indicates which object will be dragged instead of this one. + +#### Inherited from + +InstancedMesh.dragTarget + +#### Defined in + +[src/patch/Object3D.ts:43](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L43) + +___ + +### draggable + +• **draggable**: `boolean` + +Indicates whether the object is draggable (default: false). + +#### Inherited from + +InstancedMesh.draggable + +#### Defined in + +[src/patch/Object3D.ts:47](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L47) + +___ + +### enabled + +• **enabled**: `boolean` + +Determines if the object is enabled. (default: true). +If set to true, it allows triggering all InteractionEvents; otherwise, events are disabled. + +#### Inherited from + +InstancedMesh.enabled + +#### Defined in + +[src/patch/Object3D.ts:37](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L37) + +___ + +### findDropTarget + +• **findDropTarget**: `boolean` + +Determines when the object is dragged, whether it will have to search for any drop targets (default: false). + +#### Inherited from + +InstancedMesh.findDropTarget + +#### Defined in + +[src/patch/Object3D.ts:49](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L49) + +___ + +### focusable + +• **focusable**: `boolean` + +Indicates whether the object can receive focus (default: true). + +#### Inherited from + +InstancedMesh.focusable + +#### Defined in + +[src/patch/Object3D.ts:45](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L45) + +___ + +### hitboxes + +• **hitboxes**: `Mesh`<`BufferGeometry`<`NormalBufferAttributes`\>, `Material` \| `Material`[], `Object3DEventMap`\>[] + +Array of hitboxes for collision detection. + +#### Inherited from + +InstancedMesh.hitboxes + +#### Defined in + +[src/patch/Object3D.ts:41](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L41) + +___ + ### instances • **instances**: [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)[] = `[]` -An array that stores individual InstancedMeshEntity instances associated with this InstancedMesh2. +An array storing individual InstancedMeshEntity instances associated with this InstancedMesh2. 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/16c77a5/src/instancedMesh/InstancedMesh2.ts#L25) +[src/instancedMesh/InstancedMesh2.ts:25](https://github.com/agargaro/three.ez/blob/a81f57c/src/instancedMesh/InstancedMesh2.ts#L25) + +___ + +### interceptByRaycaster + +• **interceptByRaycaster**: `boolean` + +Determines if the object can be intercepted by a raycaster (default: true). + +#### Inherited from + +InstancedMesh.interceptByRaycaster + +#### Defined in + +[src/patch/Object3D.ts:39](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L39) ___ @@ -63,10 +224,62 @@ A flag indicating that this is an instance of InstancedMesh2. #### Defined in -[src/instancedMesh/InstancedMesh2.ts:20](https://github.com/agargaro/three.ez/blob/16c77a5/src/instancedMesh/InstancedMesh2.ts#L20) +[src/instancedMesh/InstancedMesh2.ts:20](https://github.com/agargaro/three.ez/blob/a81f57c/src/instancedMesh/InstancedMesh2.ts#L20) + +___ + +### needsRender + +• **needsRender**: `boolean` + +Indicates whether the scene needs rendering. + +#### Inherited from + +InstancedMesh.needsRender + +#### Defined in + +[src/patch/Object3D.ts:59](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L59) + +___ + +### scene + +• **scene**: `Scene` + +Reference to the scene the object belongs to. + +#### Inherited from + +InstancedMesh.scene + +#### Defined in + +[src/patch/Object3D.ts:51](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L51) ## Accessors +### clicking + +• `get` **clicking**(): `boolean` + +Indicates if the object is currently being clicked. + +#### Returns + +`boolean` + +#### Inherited from + +InstancedMesh.clicking + +#### Defined in + +[src/patch/Object3D.ts:65](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L65) + +___ + ### clickingInstance • `get` **clickingInstance**(): [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md) @@ -79,7 +292,27 @@ Gets the currently clicking instance. #### Defined in -[src/instancedMesh/InstancedMesh2.ts:50](https://github.com/agargaro/three.ez/blob/16c77a5/src/instancedMesh/InstancedMesh2.ts#L50) +[src/instancedMesh/InstancedMesh2.ts:50](https://github.com/agargaro/three.ez/blob/a81f57c/src/instancedMesh/InstancedMesh2.ts#L50) + +___ + +### dragging + +• `get` **dragging**(): `boolean` + +Indicates if the object is currently being dragged. + +#### Returns + +`boolean` + +#### Inherited from + +InstancedMesh.dragging + +#### Defined in + +[src/patch/Object3D.ts:67](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L67) ___ @@ -95,7 +328,67 @@ Gets the currently dragging instance. #### Defined in -[src/instancedMesh/InstancedMesh2.ts:55](https://github.com/agargaro/three.ez/blob/16c77a5/src/instancedMesh/InstancedMesh2.ts#L55) +[src/instancedMesh/InstancedMesh2.ts:55](https://github.com/agargaro/three.ez/blob/a81f57c/src/instancedMesh/InstancedMesh2.ts#L55) + +___ + +### enabledState + +• `get` **enabledState**(): `boolean` + +Retrieves the combined enabled state considering parent objects. + +#### Returns + +`boolean` + +#### Inherited from + +InstancedMesh.enabledState + +#### Defined in + +[src/patch/Object3D.ts:69](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L69) + +___ + +### firstFocusable + +• `get` **firstFocusable**(): `Object3D`<`Object3DEventMap`\> + +Retrieves the first possible focusable object. + +#### Returns + +`Object3D`<`Object3DEventMap`\> + +#### Inherited from + +InstancedMesh.firstFocusable + +#### Defined in + +[src/patch/Object3D.ts:73](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L73) + +___ + +### focused + +• `get` **focused**(): `boolean` + +Indicates if the object is currently focused. + +#### Returns + +`boolean` + +#### Inherited from + +InstancedMesh.focused + +#### Defined in + +[src/patch/Object3D.ts:63](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L63) ___ @@ -111,7 +404,27 @@ Gets the currently focused instance. #### Defined in -[src/instancedMesh/InstancedMesh2.ts:45](https://github.com/agargaro/three.ez/blob/16c77a5/src/instancedMesh/InstancedMesh2.ts#L45) +[src/instancedMesh/InstancedMesh2.ts:45](https://github.com/agargaro/three.ez/blob/a81f57c/src/instancedMesh/InstancedMesh2.ts#L45) + +___ + +### hovered + +• `get` **hovered**(): `boolean` + +Indicates if the primary pointer is over this object. + +#### Returns + +`boolean` + +#### Inherited from + +InstancedMesh.hovered + +#### Defined in + +[src/patch/Object3D.ts:61](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L61) ___ @@ -127,10 +440,133 @@ Gets the currently hovered instance. #### Defined in -[src/instancedMesh/InstancedMesh2.ts:40](https://github.com/agargaro/three.ez/blob/16c77a5/src/instancedMesh/InstancedMesh2.ts#L40) +[src/instancedMesh/InstancedMesh2.ts:40](https://github.com/agargaro/three.ez/blob/a81f57c/src/instancedMesh/InstancedMesh2.ts#L40) + +___ + +### visibilityState + +• `get` **visibilityState**(): `boolean` + +Retrieves the combined visibility state considering parent objects. + +#### Returns + +`boolean` + +#### Inherited from + +InstancedMesh.visibilityState + +#### Defined in + +[src/patch/Object3D.ts:71](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L71) ## Methods +### applyBlur + +▸ **applyBlur**(): `void` + +Applies blur (removes focus) from the object. + +#### Returns + +`void` + +#### Inherited from + +InstancedMesh.applyBlur + +#### Defined in + +[src/patch/Object3D.ts:81](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L81) + +___ + +### applyFocus + +▸ **applyFocus**(): `void` + +Applies focus to the object. + +#### Returns + +`void` + +#### Inherited from + +InstancedMesh.applyFocus + +#### Defined in + +[src/patch/Object3D.ts:77](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L77) + +___ + +### bindProperty + +▸ **bindProperty**<`T`\>(`property`, `getCallback`, `renderOnChange?`): [`InstancedMesh2`](InstancedMesh.InstancedMesh2.md) + +Binds a property to a callback function for updates. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof [`InstancedMesh2`](InstancedMesh.InstancedMesh2.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `property` | `T` | The name of the property to bind. | +| `getCallback` | () => [`InstancedMesh2`](InstancedMesh.InstancedMesh2.md)[`T`] | A function that retrieves the property's value. | +| `renderOnChange?` | `boolean` | Indicates whether to render when the property changes (optional, default: false). | + +#### Returns + +[`InstancedMesh2`](InstancedMesh.InstancedMesh2.md) + +The instance of the object with the binding applied. + +#### Inherited from + +InstancedMesh.bindProperty + +#### Defined in + +[src/patch/Object3D.ts:133](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L133) + +___ + +### detectChanges + +▸ **detectChanges**(`recursive?`): `void` + +Calculates all bindings on the current object. +If 'recursive' is set to true, it will also calculate bindings for all children. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `recursive?` | `boolean` | Optional. If true, calculate bindings for children as well. | + +#### Returns + +`void` + +#### Inherited from + +InstancedMesh.detectChanges + +#### Defined in + +[src/patch/Object3D.ts:125](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L125) + +___ + ### focus ▸ **focus**(`target?`): `void` @@ -149,4 +585,279 @@ 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/16c77a5/src/instancedMesh/InstancedMesh2.ts#L100) +[src/instancedMesh/InstancedMesh2.ts:100](https://github.com/agargaro/three.ez/blob/a81f57c/src/instancedMesh/InstancedMesh2.ts#L100) + +___ + +### hasEvent + +▸ **hasEvent**<`K`\>(`type`, `listener`): `boolean` + +Checks if the object has a specific event listener. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof [`MiscEvents`](../interfaces/Events.MiscEvents.md) \| keyof [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\> \| keyof [`UpdateEvents`](../interfaces/Events.UpdateEvents.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `K` | The type of event to check for. | +| `listener` | (`event?`: `Events`[`K`]) => `void` | The callback function to check. | + +#### Returns + +`boolean` + +`true` if the event listener is attached; otherwise, `false`. + +#### Inherited from + +InstancedMesh.hasEvent + +#### Defined in + +[src/patch/Object3D.ts:95](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L95) + +___ + +### off + +▸ **off**<`K`\>(`type`, `listener`): `void` + +Removes an event listener from the object. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof [`MiscEvents`](../interfaces/Events.MiscEvents.md) \| keyof [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\> \| keyof [`UpdateEvents`](../interfaces/Events.UpdateEvents.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `K` | The type of event to remove the listener from. | +| `listener` | (`event?`: `Events`[`K`]) => `void` | The callback function to remove. | + +#### Returns + +`void` + +#### Inherited from + +InstancedMesh.off + +#### Defined in + +[src/patch/Object3D.ts:101](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L101) + +___ + +### on + +▸ **on**<`K`\>(`type`, `listener`): (`event?`: `Events`[`K`]) => `void` + +Attaches an event listener to the object. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof [`MiscEvents`](../interfaces/Events.MiscEvents.md) \| keyof [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\> \| keyof [`UpdateEvents`](../interfaces/Events.UpdateEvents.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `K` \| `K`[] | The type of event to listen for. | +| `listener` | (`this`: [`InstancedMesh2`](InstancedMesh.InstancedMesh2.md), `event?`: `Events`[`K`]) => `void` | The callback function to execute when the event occurs. | + +#### Returns + +`fn` + +A function to remove the event listener. + +▸ (`event?`): `void` + +Attaches an event listener to the object. + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `Events`[`K`] | + +##### Returns + +`void` + +A function to remove the event listener. + +#### Inherited from + +InstancedMesh.on + +#### Defined in + +[src/patch/Object3D.ts:88](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L88) + +___ + +### setManualDetectionMode + +▸ **setManualDetectionMode**(): `void` + +Activates manual detection mode for bindings. +When this method is used, all bindings will no longer be calculated automatically. +Instead, they must be manually computed using the 'detectChanges' function. + +#### Returns + +`void` + +#### Inherited from + +InstancedMesh.setManualDetectionMode + +#### Defined in + +[src/patch/Object3D.ts:119](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L119) + +___ + +### trigger + +▸ **trigger**<`K`\>(`type`, `event?`): `void` + +Triggers a specific event on the object. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof [`MiscEvents`](../interfaces/Events.MiscEvents.md) \| keyof [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\> \| keyof [`UpdateEvents`](../interfaces/Events.UpdateEvents.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `K` | The type of event to trigger. | +| `event?` | `Events`[`K`] | Optional event data to pass to the listeners. | + +#### Returns + +`void` + +#### Inherited from + +InstancedMesh.trigger + +#### Defined in + +[src/patch/Object3D.ts:107](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L107) + +___ + +### triggerAncestor + +▸ **triggerAncestor**<`K`\>(`type`, `event?`): `void` + +Triggers a specific event on the object and all its ancestors. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `K` | extends keyof [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\> | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | `K` | The type of event to trigger. | +| `event?` | [`InteractionEvents`](../interfaces/Events.InteractionEvents.md)<`Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\>, `Object3D`<`Object3DEventMap`\> \| [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md)\>[`K`] | Optional event data to pass to the listeners. | + +#### Returns + +`void` + +#### Inherited from + +InstancedMesh.triggerAncestor + +#### Defined in + +[src/patch/Object3D.ts:113](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L113) + +___ + +### tween + +▸ **tween**<`T`\>(`id?`): [`Tween`](Tweening.Tween.md)<`T`\> + +Initiates a Tween animation for the object. + +#### Type parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `T` | extends `Object3D`<`Object3DEventMap`, `T`\> = `Object3D`<`Object3DEventMap`\> | The type of the target. | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id?` | `string` | Unique identifier. If you start a new tween, the old one with the same id (if specified) will be stopped. | + +#### Returns + +[`Tween`](Tweening.Tween.md)<`T`\> + +A Tween instance for further configuration. + +#### Inherited from + +InstancedMesh.tween + +#### Defined in + +[src/patch/Object3D.ts:146](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L146) + +___ + +### unbindProperty + +▸ **unbindProperty**<`T`\>(`property`): [`InstancedMesh2`](InstancedMesh.InstancedMesh2.md) + +Unbinds a previously bound property from the object. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends keyof [`InstancedMesh2`](InstancedMesh.InstancedMesh2.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `property` | `T` | The name of the property to unbind. | + +#### Returns + +[`InstancedMesh2`](InstancedMesh.InstancedMesh2.md) + +The instance of the object with the binding removed. + +#### Inherited from + +InstancedMesh.unbindProperty + +#### Defined in + +[src/patch/Object3D.ts:139](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L139) diff --git a/docs/docs/api/classes/InstancedMesh.InstancedMeshEntity.md b/docs/docs/api/classes/InstancedMesh.InstancedMeshEntity.md index 105bb75..c318fc0 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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L74) +[src/instancedMesh/InstancedMeshEntity.ts:74](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L37) +[src/instancedMesh/InstancedMeshEntity.ts:37](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L39) +[src/instancedMesh/InstancedMeshEntity.ts:39](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L41) +[src/instancedMesh/InstancedMeshEntity.ts:41](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L33) +[src/instancedMesh/InstancedMeshEntity.ts:33](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L29) +[src/instancedMesh/InstancedMeshEntity.ts:29](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L35) +[src/instancedMesh/InstancedMeshEntity.ts:35](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L31) +[src/instancedMesh/InstancedMeshEntity.ts:31](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L18) +[src/instancedMesh/InstancedMeshEntity.ts:18](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L14) +[src/instancedMesh/InstancedMeshEntity.ts:14](https://github.com/agargaro/three.ez/blob/a81f57c/src/instancedMesh/InstancedMeshEntity.ts#L14) ___ @@ -152,11 +152,11 @@ ___ • **parent**: [`InstancedMesh2`](InstancedMesh.InstancedMesh2.md) -Object's parent in the scene graph. An object can have at most one parent. +The parent InstancedMesh2 that contains this instance. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:16](https://github.com/agargaro/three.ez/blob/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L16) +[src/instancedMesh/InstancedMeshEntity.ts:16](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L20) +[src/instancedMesh/InstancedMeshEntity.ts:20](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L24) +[src/instancedMesh/InstancedMeshEntity.ts:24](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L22) +[src/instancedMesh/InstancedMeshEntity.ts:22](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L53) +[src/instancedMesh/InstancedMeshEntity.ts:53](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L55) +[src/instancedMesh/InstancedMeshEntity.ts:55](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L57) +[src/instancedMesh/InstancedMeshEntity.ts:57](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L51) +[src/instancedMesh/InstancedMeshEntity.ts:51](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L49) +[src/instancedMesh/InstancedMeshEntity.ts:49](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L62) +[src/instancedMesh/InstancedMeshEntity.ts:62](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L175) +[src/instancedMesh/InstancedMeshEntity.ts:175](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L168) +[src/instancedMesh/InstancedMeshEntity.ts:168](https://github.com/agargaro/three.ez/blob/a81f57c/src/instancedMesh/InstancedMeshEntity.ts#L168) ___ @@ -328,7 +328,7 @@ ___ ▸ **applyMatrix4**(`m`): [`InstancedMeshEntity`](InstancedMesh.InstancedMeshEntity.md) -Applies the matrix transform to the object and updates the object's position, rotation and scale. +Applies the matrix transform to the object and updates the object's position, rotation, and scale. #### Parameters @@ -344,7 +344,7 @@ The instance of the object. #### Defined in -[src/instancedMesh/InstancedMeshEntity.ts:120](https://github.com/agargaro/three.ez/blob/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L120) +[src/instancedMesh/InstancedMeshEntity.ts:120](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L136) +[src/instancedMesh/InstancedMeshEntity.ts:136](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L99) +[src/instancedMesh/InstancedMeshEntity.ts:99](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L203) +[src/instancedMesh/InstancedMeshEntity.ts:203](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L212) +[src/instancedMesh/InstancedMeshEntity.ts:212](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L187) +[src/instancedMesh/InstancedMeshEntity.ts:187](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L147) +[src/instancedMesh/InstancedMeshEntity.ts:147](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L159) +[src/instancedMesh/InstancedMeshEntity.ts:159](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L88) +[src/instancedMesh/InstancedMeshEntity.ts:88](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L221) +[src/instancedMesh/InstancedMeshEntity.ts:221](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L229) +[src/instancedMesh/InstancedMeshEntity.ts:229](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/instancedMesh/InstancedMeshEntity.ts#L107) +[src/instancedMesh/InstancedMeshEntity.ts:107](https://github.com/agargaro/three.ez/blob/a81f57c/src/instancedMesh/InstancedMeshEntity.ts#L107) diff --git a/docs/docs/api/classes/Rendering.RenderView.md b/docs/docs/api/classes/Rendering.RenderView.md index 5d28945..d9b1388 100644 --- a/docs/docs/api/classes/Rendering.RenderView.md +++ b/docs/docs/api/classes/Rendering.RenderView.md @@ -8,7 +8,7 @@ custom_edit_url: null [Rendering](../namespaces/Rendering.md).RenderView Represents a render view with specific parameters. -Don't instance this manually. +Don't instantiate this manually. ## Implements @@ -20,7 +20,7 @@ Don't instance this manually. • **new RenderView**(`parameters`, `rendererSize`) -Don't instance this manually. +Don't instantiate this manually. #### Parameters @@ -31,7 +31,7 @@ Don't instance this manually. #### Defined in -[src/rendering/RenderView.ts:76](https://github.com/agargaro/three.ez/blob/16c77a5/src/rendering/RenderView.ts#L76) +[src/rendering/RenderView.ts:76](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/rendering/RenderView.ts#L55) +[src/rendering/RenderView.ts:55](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/rendering/RenderView.ts#L97) +[src/rendering/RenderView.ts:97](https://github.com/agargaro/three.ez/blob/a81f57c/src/rendering/RenderView.ts#L97) diff --git a/docs/docs/api/classes/Tweening.RunningTween.md b/docs/docs/api/classes/Tweening.RunningTween.md index 8d4c9b2..b7816a7 100644 --- a/docs/docs/api/classes/Tweening.RunningTween.md +++ b/docs/docs/api/classes/Tweening.RunningTween.md @@ -9,7 +9,7 @@ custom_edit_url: null This class represents a running tween for a specific target object. It manages the execution of actions and tweens associated with the tween. -Don't instance this manually. +Don't instantiate this manually. ## Type parameters @@ -23,7 +23,7 @@ Don't instance this manually. • **new RunningTween**<`T`\>(`target`, `tween`) -Don't instance this manually. +Don't instantiate this manually. #### Type parameters @@ -40,7 +40,7 @@ Don't instance this manually. #### Defined in -[src/tweening/RunningTween.ts:68](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/RunningTween.ts#L68) +[src/tweening/RunningTween.ts:68](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/tweening/RunningTween.ts#L52) +[src/tweening/RunningTween.ts:52](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/tweening/RunningTween.ts#L58) +[src/tweening/RunningTween.ts:58](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/tweening/RunningTween.ts#L63) +[src/tweening/RunningTween.ts:63](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/tweening/RunningTween.ts#L107) +[src/tweening/RunningTween.ts:107](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/tweening/RunningTween.ts#L86) +[src/tweening/RunningTween.ts:86](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/tweening/RunningTween.ts#L93) +[src/tweening/RunningTween.ts:93](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/tweening/RunningTween.ts#L114) +[src/tweening/RunningTween.ts:114](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/tweening/RunningTween.ts#L78) +[src/tweening/RunningTween.ts:78](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/tweening/RunningTween.ts#L100) +[src/tweening/RunningTween.ts:100](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/RunningTween.ts#L100) diff --git a/docs/docs/api/classes/Tweening.Tween.md b/docs/docs/api/classes/Tweening.Tween.md index 5d2858e..e86bb79 100644 --- a/docs/docs/api/classes/Tweening.Tween.md +++ b/docs/docs/api/classes/Tweening.Tween.md @@ -35,10 +35,22 @@ 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/16c77a5/src/tweening/Tween.ts#L21) +[src/tweening/Tween.ts:23](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L23) ## Properties +### id + +• **id**: `string` + +Unique identifier. If specified, the old tween with the same id will be stopped. + +#### Defined in + +[src/tweening/Tween.ts:18](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L18) + +___ + ### tags • **tags**: `string`[] = `[]` @@ -47,7 +59,7 @@ Tags used for filtering and management. #### Defined in -[src/tweening/Tween.ts:16](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L16) +[src/tweening/Tween.ts:16](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L16) ___ @@ -59,7 +71,7 @@ The object to apply the tween to. #### Defined in -[src/tweening/Tween.ts:14](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L14) +[src/tweening/Tween.ts:14](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L14) ## Methods @@ -85,7 +97,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:64](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L64) +[src/tweening/Tween.ts:76](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L76) ___ @@ -109,7 +121,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:84](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L84) +[src/tweening/Tween.ts:96](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L96) ___ @@ -133,7 +145,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:190](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L190) +[src/tweening/Tween.ts:202](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L202) ___ @@ -151,7 +163,7 @@ A new Tween instance with the same configuration. #### Defined in -[src/tweening/Tween.ts:200](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L200) +[src/tweening/Tween.ts:212](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L212) ___ @@ -175,7 +187,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:94](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L94) +[src/tweening/Tween.ts:106](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L106) ___ @@ -199,7 +211,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:166](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L166) +[src/tweening/Tween.ts:178](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L178) ___ @@ -223,7 +235,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:104](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L104) +[src/tweening/Tween.ts:116](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L116) ___ @@ -241,7 +253,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:121](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L121) +[src/tweening/Tween.ts:133](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L133) ___ @@ -265,7 +277,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:177](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L177) +[src/tweening/Tween.ts:189](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L189) ___ @@ -289,7 +301,31 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:74](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L74) +[src/tweening/Tween.ts:86](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L86) + +___ + +### setId + +▸ **setId**(`id`): [`Tween`](Tweening.Tween.md)<`T`\> + +Set a unique identifier for the Tween. If specified, stops the old tween with the same id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | The identifier to assign to the Tween. | + +#### Returns + +[`Tween`](Tweening.Tween.md)<`T`\> + +The updated Tween instance. + +#### Defined in + +[src/tweening/Tween.ts:32](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L32) ___ @@ -313,7 +349,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:30](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L30) +[src/tweening/Tween.ts:42](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L42) ___ @@ -337,7 +373,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:40](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L40) +[src/tweening/Tween.ts:52](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L52) ___ @@ -355,7 +391,7 @@ A RunningTween instance that controls the execution of the Tween. #### Defined in -[src/tweening/Tween.ts:212](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L212) +[src/tweening/Tween.ts:224](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L224) ___ @@ -379,7 +415,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:155](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L155) +[src/tweening/Tween.ts:167](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L167) ___ @@ -405,7 +441,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:52](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L52) +[src/tweening/Tween.ts:64](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L64) ___ @@ -429,7 +465,7 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:130](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L130) +[src/tweening/Tween.ts:142](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L142) ___ @@ -447,4 +483,4 @@ The updated Tween instance. #### Defined in -[src/tweening/Tween.ts:146](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Tween.ts#L146) +[src/tweening/Tween.ts:158](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Tween.ts#L158) diff --git a/docs/docs/api/classes/Tweening.TweenManager.md b/docs/docs/api/classes/Tweening.TweenManager.md index 92b2468..f1bfb8d 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:110](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/TweenManager.ts#L110) +[src/tweening/TweenManager.ts:123](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/TweenManager.ts#L123) ___ @@ -45,7 +45,7 @@ Complete all running tweens with a specific tag. #### Defined in -[src/tweening/TweenManager.ts:120](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/TweenManager.ts#L120) +[src/tweening/TweenManager.ts:133](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/TweenManager.ts#L133) ___ @@ -61,7 +61,7 @@ Stop all running tweens. #### Defined in -[src/tweening/TweenManager.ts:89](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/TweenManager.ts#L89) +[src/tweening/TweenManager.ts:102](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/TweenManager.ts#L102) ___ @@ -83,4 +83,26 @@ Stop all running tweens with a specific tag. #### Defined in -[src/tweening/TweenManager.ts:99](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/TweenManager.ts#L99) +[src/tweening/TweenManager.ts:112](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/TweenManager.ts#L112) + +___ + +### stopById + +▸ `Static` **stopById**(`id`): `void` + +Stop the running tween with a specific id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | Tween identifier. | + +#### Returns + +`void` + +#### Defined in + +[src/tweening/TweenManager.ts:90](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/TweenManager.ts#L90) diff --git a/docs/docs/api/classes/Utils.Stats.md b/docs/docs/api/classes/Utils.Stats.md index 4a93b03..956753e 100644 --- a/docs/docs/api/classes/Utils.Stats.md +++ b/docs/docs/api/classes/Utils.Stats.md @@ -27,4 +27,4 @@ Porting of mrdoob statistics, with support if no rendered frame. #### Defined in -[src/utils/Stats.ts:37](https://github.com/agargaro/three.ez/blob/16c77a5/src/utils/Stats.ts#L37) +[src/utils/Stats.ts:37](https://github.com/agargaro/three.ez/blob/a81f57c/src/utils/Stats.ts#L37) diff --git a/docs/docs/api/classes/Utils.Utils.md b/docs/docs/api/classes/Utils.Utils.md index 166157a..42898cc 100644 --- a/docs/docs/api/classes/Utils.Utils.md +++ b/docs/docs/api/classes/Utils.Utils.md @@ -7,7 +7,7 @@ custom_edit_url: null [Utils](../namespaces/Utils.md).Utils -A utility class providing helper methods. +A utility class providing helper methods for various operations. ## Methods @@ -29,8 +29,8 @@ Calculates the intersection point of a ray with a plane in world coordinates. `Vector3` -The intersection point. +The intersection point as Vector3. #### Defined in -[src/utils/Utils.ts:17](https://github.com/agargaro/three.ez/blob/16c77a5/src/utils/Utils.ts#L17) +[src/utils/Utils.ts:17](https://github.com/agargaro/three.ez/blob/a81f57c/src/utils/Utils.ts#L17) diff --git a/docs/docs/api/index.md b/docs/docs/api/index.md index ac80f89..9e7b851 100644 --- a/docs/docs/api/index.md +++ b/docs/docs/api/index.md @@ -1,6 +1,6 @@ --- id: "index" -title: "@three.ez/main" +title: "three.ez-doc" sidebar_label: "Readme" sidebar_position: 0 custom_edit_url: null @@ -8,10 +8,9 @@ custom_edit_url: null # three.ez -[![npm version](https://badge.fury.io/js/@three.ez%2Fmain.svg)](https://badge.fury.io/js/@three.ez%2Fmain) +[![npm](https://img.shields.io/npm/v/@three.ez/main)](https://www.npmjs.com/package/@three.ez/main) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=agargaro_three.ez&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=agargaro_three.ez) [![DeepScan grade](https://deepscan.io/api/teams/21196/projects/25445/branches/796375/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=21196&pid=25445&bid=796375) -[![CodeFactor](https://www.codefactor.io/repository/github/agargaro/three.ez/badge)](https://www.codefactor.io/repository/github/agargaro/three.ez) **three.ez** is a TypeScript library designed to streamline and enhance the development of `three.js` applications.
It provides a comprehensive suite of user-friendly tools and high-performance features, making it accessible even to beginners.
@@ -21,40 +20,21 @@ This library has only one dependency: `three.js r151+`. ## Key Features -- **Automatic Resize Handling** - - Automatically resizes the `Renderer`, `Camera`, and `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, similar 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. +| **Feature** | **Description** | +| -------------------------------- | ------------------------------------------------------------------------------------------------- | +| **Automatic Resize Handling** | Automatically resizes the `Renderer`, `Camera`, and `EffectComposer`. | +| | Using the `rendererResize` event, you can easily set the resolution for custom shaders. | +| [**Smart Rendering**](https://agargaro.github.io/three.ez/docs/tutorial/rendering/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**](https://stackblitz.com/edit/three-ez-events?file=src%2Fmain.ts) | Add interactions to `Object3D` through programmable events, similar 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. | ## Installation @@ -68,16 +48,17 @@ npm install @three.ez/main ```typescript import { Scene, Mesh, BoxGeometry, MeshNormalMaterial } from 'three'; -import { Main, PerspectiveCameraAuto, TweenManager } from '@three.ez/main'; +import { Main, PerspectiveCameraAuto } from '@three.ez/main'; const box = new Mesh(new BoxGeometry(0.1, 0.1, 0.1), new MeshNormalMaterial()); box.draggable = true; box.on('animate', (e) => box.rotateX(e.delta).rotateY(e.delta * 2)); -box.on(['pointerover', 'pointerout'], (e) => { - TweenManager.stopAll(); - box.tween().to(500, { scale: e.type === 'pointerover' ? 1.5 : 1 }, { easing: 'easeOutElastic' }).start(); +box.on(['pointerover', 'pointerout'], function (e) { + this.tween('id').to(500, { scale: e.type === 'pointerover' ? 1.5 : 1 }, { easing: 'easeOutElastic' }).start(); }); + const scene = new Scene().add(box); + const main = new Main(); main.createView({ scene, camera: new PerspectiveCameraAuto(70).translateZ(1) }); ``` @@ -85,18 +66,6 @@ main.createView({ scene, camera: new PerspectiveCameraAuto(70).translateZ(1) }); -## Override TypeScript Type Definition - -To extend the definitions of `three`, go into `tsconfig.json` and add this path: - -```javascript -"compilerOptions": { - "paths": { - "three": ["./node_modules/@three.ez/main/types"] - } -} -``` - ## Live Examples These examples use `vite`, and some mobile devices may run out of memory. However, there is one example without it. @@ -104,7 +73,7 @@ These examples use `vite`, and some mobile devices may run out of memory. Howeve [Examples Collection](https://stackblitz.com/@agargaro/collections/three-ez) - [Template](https://stackblitz.com/edit/three-ez-template?file=src%2Fmain.ts) -— [Template Small](https://stackblitz.com/edit/three-ez-template-small?file=src%2Fmain.ts) +— [Template Extended](https://stackblitz.com/edit/three-ez-template-extended?file=src%2Fmain.ts) — [Template No Vite](https://stackblitz.com/edit/three-ez-template-no-vite?file=index.ts) - [Smart Rendering](https://stackblitz.com/edit/three-ez-smart-rendering?file=src%2Fmain.ts) - [Multiple Views](https://stackblitz.com/edit/three-ez-multiple-views?file=src%2Fmain.ts) @@ -130,7 +99,7 @@ These examples use `vite`, and some mobile devices may run out of memory. Howeve ## Documentation -The tutorial is available [here](https://agargaro.github.io/three.ez/docs/tutorial) (work in progress).
+The tutorial is available [here](https://agargaro.github.io/three.ez/docs/tutorial) *(work in progress)*.
The API documentation is available [here](https://agargaro.github.io/three.ez/docs/api). ## Contributing diff --git a/docs/docs/api/interfaces/Core.MainParameters.md b/docs/docs/api/interfaces/Core.MainParameters.md index d97b3d1..86107e2 100644 --- a/docs/docs/api/interfaces/Core.MainParameters.md +++ b/docs/docs/api/interfaces/Core.MainParameters.md @@ -7,7 +7,7 @@ custom_edit_url: null [Core](../namespaces/Core.md).MainParameters -Represents the configuration parameters for initializing the Main class. +Configuration parameters for initializing the Main class. ## Properties @@ -15,11 +15,11 @@ Represents the configuration parameters for initializing the Main class. • `Optional` **animate**: `XRFrameRequestCallback` -A callback function executed for each frame. +Callback function executed for each frame. #### Defined in -[src/core/Main.ts:27](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L27) +[src/core/Main.ts:27](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L27) ___ @@ -27,11 +27,11 @@ ___ • `Optional` **backgroundAlpha**: `number` -The default alpha (transparency) value for the background (default: 1). +Default background alpha (transparency) value (default: 1). #### Defined in -[src/core/Main.ts:25](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L25) +[src/core/Main.ts:25](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L25) ___ @@ -39,11 +39,11 @@ ___ • `Optional` **backgroundColor**: `ColorRepresentation` -The default background color (default: 'black'). +Default background color (default: 'black'). #### Defined in -[src/core/Main.ts:23](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L23) +[src/core/Main.ts:23](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L23) ___ @@ -51,11 +51,11 @@ ___ • `Optional` **disableContextMenu**: `boolean` -A boolean flag indicating whether to disable the context menu on right-click (default: true). +Disable the context menu on right-click (default: true). #### Defined in -[src/core/Main.ts:21](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L21) +[src/core/Main.ts:21](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L21) ___ @@ -63,11 +63,11 @@ ___ • `Optional` **enableCursor**: `boolean` -A boolean flag indicating whether to enable cursor handling in the application (default: true). +Enable cursor handling in the application (default: true). #### Defined in -[src/core/Main.ts:31](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L31) +[src/core/Main.ts:31](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L31) ___ @@ -75,11 +75,11 @@ ___ • `Optional` **fullscreen**: `boolean` -A boolean flag indicating whether to enable full-screen mode and perform automatic resizing of the canvas (default: true). +Enable full-screen mode and automatic canvas resizing (default: true). #### Defined in -[src/core/Main.ts:17](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L17) +[src/core/Main.ts:17](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L17) ___ @@ -87,11 +87,11 @@ ___ • `Optional` **multitouch**: `boolean` -A boolean flag indicating whether to enable multitouch interactions (default: false). +Enable multitouch interactions (default: false). #### Defined in -[src/core/Main.ts:33](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L33) +[src/core/Main.ts:33](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/core/Main.ts#L29) +[src/core/Main.ts:29](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L29) ___ @@ -111,8 +111,8 @@ ___ • `Optional` **showStats**: `boolean` -A boolean flag indicating whether to display performance statistics (default: true). +Display performance statistics (default: true). #### Defined in -[src/core/Main.ts:19](https://github.com/agargaro/three.ez/blob/16c77a5/src/core/Main.ts#L19) +[src/core/Main.ts:19](https://github.com/agargaro/three.ez/blob/a81f57c/src/core/Main.ts#L19) diff --git a/docs/docs/api/interfaces/Events.AnimateEvent.md b/docs/docs/api/interfaces/Events.AnimateEvent.md index 7dbc144..f228c38 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/16c77a5/src/events/Events.ts#L385) +[src/events/Events.ts:385](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L387) +[src/events/Events.ts:387](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L387) diff --git a/docs/docs/api/interfaces/Events.InteractionEvents.md b/docs/docs/api/interfaces/Events.InteractionEvents.md index f8fa597..cb64504 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/16c77a5/src/events/Events.ts#L73) +[src/events/Events.ts:73](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L61) +[src/events/Events.ts:61](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L63) +[src/events/Events.ts:63](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L79) +[src/events/Events.ts:79](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L79) ___ @@ -83,11 +83,11 @@ ___ • **dragcancel**: [`DragEventExt`](../classes/Events.DragEventExt.md)<`T`, `RD`\> -Event triggered when dragging is canceled (Can be canceled pressing 'ESC'). This is triggered on target an dropTarget. +Event triggered when dragging is canceled (Can be canceled pressing 'ESC'). This is triggered on target and dropTarget. #### Defined in -[src/events/Events.ts:85](https://github.com/agargaro/three.ez/blob/16c77a5/src/events/Events.ts#L85) +[src/events/Events.ts:85](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L83) +[src/events/Events.ts:83](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L87) +[src/events/Events.ts:87](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L94) +[src/events/Events.ts:94](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L94) ___ @@ -131,12 +131,12 @@ ___ • **dragover**: [`DragEventExt`](../classes/Events.DragEventExt.md)<`T`, `RD`\> -Event triggered when a draggable object moves over the drop target. -Triggers every frame if the scene has 'continousRaycastingDropTarget' equal to true. +Event triggered when a draggable object moves over the drop target. +Triggers every frame if the scene has 'continuousRaycastingDropTarget' equal to true. #### Defined in -[src/events/Events.ts:92](https://github.com/agargaro/three.ez/blob/16c77a5/src/events/Events.ts#L92) +[src/events/Events.ts:92](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L81) +[src/events/Events.ts:81](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L96) +[src/events/Events.ts:96](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L71) +[src/events/Events.ts:71](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L67) +[src/events/Events.ts:67](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L69) +[src/events/Events.ts:69](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L75) +[src/events/Events.ts:75](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L77) +[src/events/Events.ts:77](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L55) +[src/events/Events.ts:55](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L47) +[src/events/Events.ts:47](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L47) ___ @@ -252,11 +252,11 @@ ___ • **pointerintersection**: [`PointerIntersectionEvent`](../classes/Events.PointerIntersectionEvent.md)<`T`\> -Event triggered if pointer is on target. Triggers every frame and only works if the scene has 'continousRaycasting' equal to true. +Event triggered if pointer is on target. Triggers every frame and only works if the scene has 'continuousRaycasting' equal to true. #### Defined in -[src/events/Events.ts:59](https://github.com/agargaro/three.ez/blob/16c77a5/src/events/Events.ts#L59) +[src/events/Events.ts:59](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L51) +[src/events/Events.ts:51](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L53) +[src/events/Events.ts:53](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L49) +[src/events/Events.ts:49](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L45) +[src/events/Events.ts:45](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L57) +[src/events/Events.ts:57](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L65) +[src/events/Events.ts:65](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L65) diff --git a/docs/docs/api/interfaces/Events.IntersectionExt.md b/docs/docs/api/interfaces/Events.IntersectionExt.md index 7b281a6..0487811 100644 --- a/docs/docs/api/interfaces/Events.IntersectionExt.md +++ b/docs/docs/api/interfaces/Events.IntersectionExt.md @@ -19,10 +19,10 @@ Represents an extended intersection between a ray and 3D objects in a scene. ### hitbox -• **hitbox**: `Mesh`<`BufferGeometry`<`NormalBufferAttributes`\>, `Material` \| `Material`[]\> +• **hitbox**: `Mesh`<`BufferGeometry`<`NormalBufferAttributes`\>, `Material` \| `Material`[], `Object3DEventMap`\> The hitbox hit by the raycaster. #### Defined in -[src/events/Events.ts:105](https://github.com/agargaro/three.ez/blob/16c77a5/src/events/Events.ts#L105) +[src/events/Events.ts:105](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L105) diff --git a/docs/docs/api/interfaces/Events.MiscEvents.md b/docs/docs/api/interfaces/Events.MiscEvents.md index 63f7890..f3a441b 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/16c77a5/src/events/Events.ts#L34) +[src/events/Events.ts:34](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L32) +[src/events/Events.ts:32](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L30) +[src/events/Events.ts:30](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L28) +[src/events/Events.ts:28](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L28) diff --git a/docs/docs/api/interfaces/Events.PropertyChangeEvent.md b/docs/docs/api/interfaces/Events.PropertyChangeEvent.md index 6facd1c..bc9f9a8 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/16c77a5/src/events/Events.ts#L396) +[src/events/Events.ts:396](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L398) +[src/events/Events.ts:398](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L398) diff --git a/docs/docs/api/interfaces/Events.RendererResizeEvent.md b/docs/docs/api/interfaces/Events.RendererResizeEvent.md index c752cac..4c5b68d 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/16c77a5/src/events/Events.ts#L377) +[src/events/Events.ts:377](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L373) +[src/events/Events.ts:373](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L375) +[src/events/Events.ts:375](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L371) +[src/events/Events.ts:371](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L371) diff --git a/docs/docs/api/interfaces/Events.UpdateEvents.md b/docs/docs/api/interfaces/Events.UpdateEvents.md index 7e95fb3..013055d 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/16c77a5/src/events/Events.ts#L18) +[src/events/Events.ts:18](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L12) +[src/events/Events.ts:12](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L16) +[src/events/Events.ts:16](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L14) +[src/events/Events.ts:14](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/events/Events.ts#L20) +[src/events/Events.ts:20](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/Events.ts#L20) diff --git a/docs/docs/api/interfaces/Patch.MaterialExtPrototype.md b/docs/docs/api/interfaces/Patch.MaterialExtPrototype.md new file mode 100644 index 0000000..dee28ef --- /dev/null +++ b/docs/docs/api/interfaces/Patch.MaterialExtPrototype.md @@ -0,0 +1,40 @@ +--- +id: "Patch.MaterialExtPrototype" +title: "Interface: MaterialExtPrototype" +sidebar_label: "MaterialExtPrototype" +custom_edit_url: null +--- + +[Patch](../namespaces/Patch.md).MaterialExtPrototype + +Represents the prototype for extended Material functionality. + +## Methods + +### tween + +▸ **tween**<`T`\>(`id?`): [`Tween`](../classes/Tweening.Tween.md)<`T`\> + +Initiates a Tween animation for the material. + +#### Type parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `T` | extends [`MaterialExtPrototype`](Patch.MaterialExtPrototype.md)<`T`\> | The type of the target. | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id?` | `string` | Unique identifier. If you start a new tween, the old one with the same id (if specified) will be stopped. | + +#### Returns + +[`Tween`](../classes/Tweening.Tween.md)<`T`\> + +A Tween instance for further configuration. + +#### Defined in + +[src/patch/Material.ts:14](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Material.ts#L14) diff --git a/docs/docs/api/interfaces/Patch.Object3DExtPrototype.md b/docs/docs/api/interfaces/Patch.Object3DExtPrototype.md index 933f28d..f937d89 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/16c77a5/src/patch/Object3D.ts#L53) +[src/patch/Object3D.ts:53](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/patch/Object3D.ts#L55) +[src/patch/Object3D.ts:55](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L55) ___ @@ -43,7 +43,19 @@ Cursor style when dropping an object onto this one. #### Defined in -[src/patch/Object3D.ts:57](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L57) +[src/patch/Object3D.ts:57](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L57) + +___ + +### dragTarget + +• **dragTarget**: `Object3D`<`Object3DEventMap`\> + +Indicates which object will be dragged instead of this one. + +#### Defined in + +[src/patch/Object3D.ts:43](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L43) ___ @@ -55,7 +67,7 @@ Indicates whether the object is draggable (default: false). #### Defined in -[src/patch/Object3D.ts:47](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L47) +[src/patch/Object3D.ts:47](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L47) ___ @@ -68,7 +80,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/16c77a5/src/patch/Object3D.ts#L39) +[src/patch/Object3D.ts:37](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L37) ___ @@ -80,7 +92,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/16c77a5/src/patch/Object3D.ts#L49) +[src/patch/Object3D.ts:49](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L49) ___ @@ -92,19 +104,19 @@ Indicates whether the object can receive focus (default: true). #### Defined in -[src/patch/Object3D.ts:45](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L45) +[src/patch/Object3D.ts:45](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L45) ___ ### hitboxes -• **hitboxes**: `Mesh`<`BufferGeometry`<`NormalBufferAttributes`\>, `Material` \| `Material`[]\>[] +• **hitboxes**: `Mesh`<`BufferGeometry`<`NormalBufferAttributes`\>, `Material` \| `Material`[], `Object3DEventMap`\>[] Array of hitboxes for collision detection. #### Defined in -[src/patch/Object3D.ts:43](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L43) +[src/patch/Object3D.ts:41](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L41) ___ @@ -116,7 +128,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/16c77a5/src/patch/Object3D.ts#L41) +[src/patch/Object3D.ts:39](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L39) ___ @@ -128,7 +140,7 @@ Indicates whether the scene needs rendering. #### Defined in -[src/patch/Object3D.ts:59](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L59) +[src/patch/Object3D.ts:59](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L59) ___ @@ -140,7 +152,7 @@ Reference to the scene the object belongs to. #### Defined in -[src/patch/Object3D.ts:51](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L51) +[src/patch/Object3D.ts:51](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L51) ## Accessors @@ -156,7 +168,7 @@ Indicates if the object is currently being clicked. #### Defined in -[src/patch/Object3D.ts:65](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L65) +[src/patch/Object3D.ts:65](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L65) ___ @@ -172,7 +184,7 @@ Indicates if the object is currently being dragged. #### Defined in -[src/patch/Object3D.ts:67](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L67) +[src/patch/Object3D.ts:67](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L67) ___ @@ -188,7 +200,7 @@ Retrieves the combined enabled state considering parent objects. #### Defined in -[src/patch/Object3D.ts:69](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L69) +[src/patch/Object3D.ts:69](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L69) ___ @@ -196,7 +208,7 @@ ___ • `get` **firstFocusable**(): `Object3D`<`Object3DEventMap`\> -Retrieves the first possibile focusable object. +Retrieves the first possible focusable object. #### Returns @@ -204,7 +216,7 @@ Retrieves the first possibile focusable object. #### Defined in -[src/patch/Object3D.ts:73](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L73) +[src/patch/Object3D.ts:73](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L73) ___ @@ -220,7 +232,7 @@ Indicates if the object is currently focused. #### Defined in -[src/patch/Object3D.ts:63](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L63) +[src/patch/Object3D.ts:63](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L63) ___ @@ -236,7 +248,7 @@ Indicates if the primary pointer is over this object. #### Defined in -[src/patch/Object3D.ts:61](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L61) +[src/patch/Object3D.ts:61](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L61) ___ @@ -252,7 +264,7 @@ Retrieves the combined visibility state considering parent objects. #### Defined in -[src/patch/Object3D.ts:71](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L71) +[src/patch/Object3D.ts:71](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L71) ## Methods @@ -268,7 +280,7 @@ Applies blur (removes focus) from the object. #### Defined in -[src/patch/Object3D.ts:81](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L81) +[src/patch/Object3D.ts:81](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L81) ___ @@ -284,7 +296,7 @@ Applies focus to the object. #### Defined in -[src/patch/Object3D.ts:77](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L77) +[src/patch/Object3D.ts:77](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L77) ___ @@ -316,7 +328,7 @@ The instance of the object with the binding applied. #### Defined in -[src/patch/Object3D.ts:133](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L133) +[src/patch/Object3D.ts:133](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L133) ___ @@ -339,7 +351,7 @@ If 'recursive' is set to true, it will also calculate bindings for all children. #### Defined in -[src/patch/Object3D.ts:125](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L125) +[src/patch/Object3D.ts:125](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L125) ___ @@ -370,7 +382,7 @@ Checks if the object has a specific event listener. #### Defined in -[src/patch/Object3D.ts:95](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L95) +[src/patch/Object3D.ts:95](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L95) ___ @@ -399,7 +411,7 @@ Removes an event listener from the object. #### Defined in -[src/patch/Object3D.ts:101](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L101) +[src/patch/Object3D.ts:101](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L101) ___ @@ -420,7 +432,7 @@ Attaches an event listener to the object. | Name | Type | Description | | :------ | :------ | :------ | | `type` | `K` \| `K`[] | The type of event to listen for. | -| `listener` | (`event?`: `Events`[`K`]) => `void` | The callback function to execute when the event occurs. | +| `listener` | (`this`: [`Object3DExtPrototype`](Patch.Object3DExtPrototype.md), `event?`: `Events`[`K`]) => `void` | The callback function to execute when the event occurs. | #### Returns @@ -446,7 +458,7 @@ A function to remove the event listener. #### Defined in -[src/patch/Object3D.ts:88](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L88) +[src/patch/Object3D.ts:88](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L88) ___ @@ -464,7 +476,7 @@ Instead, they must be manually computed using the 'detectChanges' function. #### Defined in -[src/patch/Object3D.ts:119](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L119) +[src/patch/Object3D.ts:119](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L119) ___ @@ -493,7 +505,7 @@ Triggers a specific event on the object. #### Defined in -[src/patch/Object3D.ts:107](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L107) +[src/patch/Object3D.ts:107](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L107) ___ @@ -522,13 +534,13 @@ Triggers a specific event on the object and all its ancestors. #### Defined in -[src/patch/Object3D.ts:113](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L113) +[src/patch/Object3D.ts:113](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L113) ___ ### tween -▸ **tween**<`T`\>(): [`Tween`](../classes/Tweening.Tween.md)<`T`\> +▸ **tween**<`T`\>(`id?`): [`Tween`](../classes/Tweening.Tween.md)<`T`\> Initiates a Tween animation for the object. @@ -536,7 +548,13 @@ Initiates a Tween animation for the object. | Name | Type | Description | | :------ | :------ | :------ | -| `T` | extends `Object3D`<`Object3DEventMap`, `T`\> | The type of the target. | +| `T` | extends `Object3D`<`Object3DEventMap`, `T`\> = `Object3D`<`Object3DEventMap`\> | The type of the target. | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id?` | `string` | Unique identifier. If you start a new tween, the old one with the same id (if specified) will be stopped. | #### Returns @@ -546,7 +564,7 @@ A Tween instance for further configuration. #### Defined in -[src/patch/Object3D.ts:145](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L145) +[src/patch/Object3D.ts:146](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L146) ___ @@ -576,4 +594,4 @@ The instance of the object with the binding removed. #### Defined in -[src/patch/Object3D.ts:139](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Object3D.ts#L139) +[src/patch/Object3D.ts:139](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Object3D.ts#L139) diff --git a/docs/docs/api/interfaces/Patch.SceneExtPrototype.md b/docs/docs/api/interfaces/Patch.SceneExtPrototype.md index 748ff57..d5959fe 100644 --- a/docs/docs/api/interfaces/Patch.SceneExtPrototype.md +++ b/docs/docs/api/interfaces/Patch.SceneExtPrototype.md @@ -7,7 +7,7 @@ custom_edit_url: null [Patch](../namespaces/Patch.md).SceneExtPrototype -Represents the prototype for extended Scene functionality. +Represents the prototype for extending Scene functionality. ## Properties @@ -15,39 +15,39 @@ Represents the prototype for extended Scene functionality. • **blurOnClickOut**: `boolean` -Flag indicating whether to blur focused object3D when clicking outside of any object. +A flag indicating whether to blur the focused Object3D when clicking outside of any object. #### Defined in -[src/patch/Scene.ts:38](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Scene.ts#L38) +[src/patch/Scene.ts:36](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Scene.ts#L36) ___ -### continousRaycasting +### continuousRaycasting -• **continousRaycasting**: `boolean` +• **continuousRaycasting**: `boolean` -Flag indicating whether continuous raycasting is enabled (default: false). -If set to true, raycasting will occur every frame, otherwise it will occur only upon mouse movement. -Also, if set to true, the 'pointerintersection' event will be triggered every frame. +A flag indicating whether continuous raycasting is enabled (default: false). +When set to true, main raycasting occurs every frame, while false triggers raycasting only upon mouse movement. +Additionally, if set to true, the 'pointerintersection' event will be fired every frame. #### Defined in -[src/patch/Scene.ts:24](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Scene.ts#L24) +[src/patch/Scene.ts:20](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Scene.ts#L20) ___ -### continousRaycastingDropTarget +### continuousRaycastingDropTarget -• **continousRaycastingDropTarget**: `boolean` +• **continuousRaycastingDropTarget**: `boolean` -Flag indicating whether continuous raycasting when searching for drop targets is enabled (default: false). -If set to true, raycasting will occur every frame, otherwise it will occur only upon mouse movement. -Also, if set to true, the 'dragover' event will be triggered every frame. +A flag indicating whether continuous raycasting is enabled when searching for drop targets (default: false). +When set to true, main raycasting for drop targets occurs every frame, while false triggers it only upon mouse movement. +Additionally, if set to true, the 'dragover' event will be fired every frame. #### Defined in -[src/patch/Scene.ts:30](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Scene.ts#L30) +[src/patch/Scene.ts:26](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Scene.ts#L26) ___ @@ -59,7 +59,7 @@ A reference to the currently focused Object3D within the scene. #### Defined in -[src/patch/Scene.ts:36](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Scene.ts#L36) +[src/patch/Scene.ts:32](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Scene.ts#L32) ___ @@ -71,7 +71,7 @@ An array of intersections computed from the pointer (primary pointer only). #### Defined in -[src/patch/Scene.ts:32](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Scene.ts#L32) +[src/patch/Scene.ts:28](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Scene.ts#L28) ___ @@ -79,11 +79,11 @@ ___ • **intersectionsDropTarget**: [`IntersectionExt`](Events.IntersectionExt.md)[] -An array of intersections computed from the pointer if an object is dragged and has 'findDropTarget' to true (primary pointer only). +An array of intersections computed from the pointer if an object is dragged and has 'findDropTarget' set to true (primary pointer only). #### Defined in -[src/patch/Scene.ts:34](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Scene.ts#L34) +[src/patch/Scene.ts:30](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Scene.ts#L30) ___ @@ -95,7 +95,7 @@ The time scale for scene animations. #### Defined in -[src/patch/Scene.ts:40](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Scene.ts#L40) +[src/patch/Scene.ts:38](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Scene.ts#L38) ___ @@ -107,7 +107,7 @@ The total time elapsed in the scene. #### Defined in -[src/patch/Scene.ts:42](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Scene.ts#L42) +[src/patch/Scene.ts:40](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Scene.ts#L40) ## Methods @@ -115,7 +115,7 @@ The total time elapsed in the scene. ▸ **activeSmartRendering**(): [`SceneExtPrototype`](Patch.SceneExtPrototype.md) -Activate smart rendering for the scene. +Activates smart rendering for the scene. #### Returns @@ -125,7 +125,7 @@ The updated instance of the scene. #### Defined in -[src/patch/Scene.ts:47](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Scene.ts#L47) +[src/patch/Scene.ts:45](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Scene.ts#L45) ___ @@ -133,7 +133,7 @@ ___ ▸ **focus**(`target?`): `void` -Set the focus to the specified Object3D within the scene, or clears the focus if no target is provided. +Sets the focus to the specified Object3D within the scene, or clears the focus if no target is provided. #### Parameters @@ -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:52](https://github.com/agargaro/three.ez/blob/16c77a5/src/patch/Scene.ts#L52) +[src/patch/Scene.ts:50](https://github.com/agargaro/three.ez/blob/a81f57c/src/patch/Scene.ts#L50) diff --git a/docs/docs/api/interfaces/Rendering.ViewParameters.md b/docs/docs/api/interfaces/Rendering.ViewParameters.md index e6337c9..bc7daf2 100644 --- a/docs/docs/api/interfaces/Rendering.ViewParameters.md +++ b/docs/docs/api/interfaces/Rendering.ViewParameters.md @@ -23,7 +23,7 @@ Background alpha value of the view (optional, default: 1). #### Defined in -[src/rendering/RenderView.ts:37](https://github.com/agargaro/three.ez/blob/16c77a5/src/rendering/RenderView.ts#L37) +[src/rendering/RenderView.ts:37](https://github.com/agargaro/three.ez/blob/a81f57c/src/rendering/RenderView.ts#L37) ___ @@ -35,7 +35,7 @@ Background color of the view (optional, default: 'black'). #### Defined in -[src/rendering/RenderView.ts:35](https://github.com/agargaro/three.ez/blob/16c77a5/src/rendering/RenderView.ts#L35) +[src/rendering/RenderView.ts:35](https://github.com/agargaro/three.ez/blob/a81f57c/src/rendering/RenderView.ts#L35) ___ @@ -47,7 +47,7 @@ Camera used to view the scene (avoid using the same camera for different scenes) #### Defined in -[src/rendering/RenderView.ts:25](https://github.com/agargaro/three.ez/blob/16c77a5/src/rendering/RenderView.ts#L25) +[src/rendering/RenderView.ts:25](https://github.com/agargaro/three.ez/blob/a81f57c/src/rendering/RenderView.ts#L25) ___ @@ -59,7 +59,7 @@ Effect composer used for post-processing (optional). #### Defined in -[src/rendering/RenderView.ts:39](https://github.com/agargaro/three.ez/blob/16c77a5/src/rendering/RenderView.ts#L39) +[src/rendering/RenderView.ts:39](https://github.com/agargaro/three.ez/blob/a81f57c/src/rendering/RenderView.ts#L39) ___ @@ -71,7 +71,7 @@ Determines whether InteractionEvents will be triggered for the view (optional, d #### Defined in -[src/rendering/RenderView.ts:33](https://github.com/agargaro/three.ez/blob/16c77a5/src/rendering/RenderView.ts#L33) +[src/rendering/RenderView.ts:33](https://github.com/agargaro/three.ez/blob/a81f57c/src/rendering/RenderView.ts#L33) ___ @@ -83,7 +83,7 @@ ___ ▸ (): `void` -Function to be called after rendering the view (optional). +Function called after rendering the view (optional). ##### Returns @@ -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/16c77a5/src/rendering/RenderView.ts#L43) +[src/rendering/RenderView.ts:43](https://github.com/agargaro/three.ez/blob/a81f57c/src/rendering/RenderView.ts#L43) ___ @@ -111,7 +111,7 @@ Function called before rendering the view (optional). #### Defined in -[src/rendering/RenderView.ts:41](https://github.com/agargaro/three.ez/blob/16c77a5/src/rendering/RenderView.ts#L41) +[src/rendering/RenderView.ts:41](https://github.com/agargaro/three.ez/blob/a81f57c/src/rendering/RenderView.ts#L41) ___ @@ -123,7 +123,7 @@ Scene rendered in the view. #### Defined in -[src/rendering/RenderView.ts:23](https://github.com/agargaro/three.ez/blob/16c77a5/src/rendering/RenderView.ts#L23) +[src/rendering/RenderView.ts:23](https://github.com/agargaro/three.ez/blob/a81f57c/src/rendering/RenderView.ts#L23) ___ @@ -135,7 +135,7 @@ Tags of the view (optional). #### Defined in -[src/rendering/RenderView.ts:29](https://github.com/agargaro/three.ez/blob/16c77a5/src/rendering/RenderView.ts#L29) +[src/rendering/RenderView.ts:29](https://github.com/agargaro/three.ez/blob/a81f57c/src/rendering/RenderView.ts#L29) ___ @@ -147,7 +147,7 @@ Normalized viewport defining dimensions and position of the view (optional). Val #### Defined in -[src/rendering/RenderView.ts:27](https://github.com/agargaro/three.ez/blob/16c77a5/src/rendering/RenderView.ts#L27) +[src/rendering/RenderView.ts:27](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/rendering/RenderView.ts#L31) +[src/rendering/RenderView.ts:31](https://github.com/agargaro/three.ez/blob/a81f57c/src/rendering/RenderView.ts#L31) diff --git a/docs/docs/api/interfaces/Rendering.Viewport.md b/docs/docs/api/interfaces/Rendering.Viewport.md index 48bb1d2..0021168 100644 --- a/docs/docs/api/interfaces/Rendering.Viewport.md +++ b/docs/docs/api/interfaces/Rendering.Viewport.md @@ -7,7 +7,7 @@ custom_edit_url: null [Rendering](../namespaces/Rendering.md).Viewport -Represents an object that defines the dimensions and position of a viewport. +Represents an object defining the dimensions and position of a viewport. ## Properties @@ -19,7 +19,7 @@ Bottom coordinate of the viewport. #### Defined in -[src/rendering/RenderView.ts:11](https://github.com/agargaro/three.ez/blob/16c77a5/src/rendering/RenderView.ts#L11) +[src/rendering/RenderView.ts:11](https://github.com/agargaro/three.ez/blob/a81f57c/src/rendering/RenderView.ts#L11) ___ @@ -31,7 +31,7 @@ Height of the viewport. #### Defined in -[src/rendering/RenderView.ts:15](https://github.com/agargaro/three.ez/blob/16c77a5/src/rendering/RenderView.ts#L15) +[src/rendering/RenderView.ts:15](https://github.com/agargaro/three.ez/blob/a81f57c/src/rendering/RenderView.ts#L15) ___ @@ -43,7 +43,7 @@ Left coordinate of the viewport. #### Defined in -[src/rendering/RenderView.ts:9](https://github.com/agargaro/three.ez/blob/16c77a5/src/rendering/RenderView.ts#L9) +[src/rendering/RenderView.ts:9](https://github.com/agargaro/three.ez/blob/a81f57c/src/rendering/RenderView.ts#L9) ___ @@ -55,4 +55,4 @@ Width of the viewport. #### Defined in -[src/rendering/RenderView.ts:13](https://github.com/agargaro/three.ez/blob/16c77a5/src/rendering/RenderView.ts#L13) +[src/rendering/RenderView.ts:13](https://github.com/agargaro/three.ez/blob/a81f57c/src/rendering/RenderView.ts#L13) diff --git a/docs/docs/api/interfaces/Tweening.MotionConfig.md b/docs/docs/api/interfaces/Tweening.MotionConfig.md index b02238b..fdf2ef7 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:22](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Actions.ts#L22) +[src/tweening/Actions.ts:22](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Actions.ts#L22) ___ @@ -52,7 +52,7 @@ A callback function to execute when the animation completes. #### Defined in -[src/tweening/Actions.ts:27](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Actions.ts#L27) +[src/tweening/Actions.ts:27](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Actions.ts#L27) ___ @@ -80,11 +80,11 @@ A callback function to be executed before each property is updated. `boolean` \| `void` -If `false` will not assign new value to property. +If `false`, will not assign a new value to the property. #### Defined in -[src/tweening/Actions.ts:47](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Actions.ts#L47) +[src/tweening/Actions.ts:47](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Actions.ts#L47) ___ @@ -110,7 +110,7 @@ A callback function to execute when the animation starts. #### Defined in -[src/tweening/Actions.ts:32](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Actions.ts#L32) +[src/tweening/Actions.ts:32](https://github.com/agargaro/three.ez/blob/a81f57c/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:37](https://github.com/agargaro/three.ez/blob/16c77a5/src/tweening/Actions.ts#L37) +[src/tweening/Actions.ts:37](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Actions.ts#L37) diff --git a/docs/docs/api/modules.md b/docs/docs/api/modules.md index 6060f45..ea9fbbe 100644 --- a/docs/docs/api/modules.md +++ b/docs/docs/api/modules.md @@ -1,6 +1,6 @@ --- id: "modules" -title: "@three.ez/main" +title: "three.ez-doc" sidebar_label: "Exports" sidebar_position: 0.5 custom_edit_url: null diff --git a/docs/docs/api/namespaces/Events.md b/docs/docs/api/namespaces/Events.md index 2b08226..6a3d149 100644 --- a/docs/docs/api/namespaces/Events.md +++ b/docs/docs/api/namespaces/Events.md @@ -33,11 +33,11 @@ custom_edit_url: null Ƭ **Cursor**: [`CursorsKeys`](Events.md#cursorskeys) \| `String` -Indicates a cursor by a list or by url. +Represents a cursor, either by a CSS cursor key or a URL. #### Defined in -[src/events/CursorManager.ts:18](https://github.com/agargaro/three.ez/blob/16c77a5/src/events/CursorManager.ts#L18) +[src/events/CursorManager.ts:18](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/CursorManager.ts#L18) ___ @@ -45,11 +45,11 @@ ___ Ƭ **CursorsKeys**: ``"auto"`` \| ``"default"`` \| ``"none"`` \| ``"context-menu"`` \| ``"help"`` \| ``"pointer"`` \| ``"progress"`` \| ``"wait"`` \| ``"cell"`` \| ``"crosshair"`` \| ``"text"`` \| ``"vertical-text"`` \| ``"alias"`` \| ``"copy"`` \| ``"move"`` \| ``"no-drop"`` \| ``"not-allowed"`` \| ``"grab"`` \| ``"grabbing"`` \| ``"all-scroll"`` \| ``"col-resize"`` \| ``"row-resize"`` \| ``"n-resize"`` \| ``"e-resize"`` \| ``"s-resize"`` \| ``"w-resize"`` \| ``"ne-resize"`` \| ``"nw-resize"`` \| ``"se-resize"`` \| ``"sw-resize"`` \| ``"ew-resize"`` \| ``"ns-resize"`` \| ``"nesw-resize"`` \| ``"nwse-resize"`` \| ``"zoom-in"`` \| ``"zoom-out"`` -https://developer.mozilla.org/en-US/docs/Web/CSS/cursor +Valid cursor values based on the CSS cursor property. #### Defined in -[src/events/CursorManager.ts:5](https://github.com/agargaro/three.ez/blob/16c77a5/src/events/CursorManager.ts#L5) +[src/events/CursorManager.ts:5](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/CursorManager.ts#L5) ___ @@ -61,7 +61,7 @@ ___ ▸ (`a`, `b`): `number` -A custom sorting comparer function used to order intersections when performing raycasting. +A custom sorting comparison function used for ordering intersections during raycasting. ##### Parameters @@ -74,8 +74,8 @@ A custom sorting comparer function used to order intersections when performing r `number` -A negative number if `a` should come before `b`, a positive number if `b` should come before `a`, or zero if their order does not matter. +A negative value if `a` should precede `b`, a positive value if `b` should precede `a`, or zero if their order is indeterminate. #### Defined in -[src/events/RaycasterManager.ts:11](https://github.com/agargaro/three.ez/blob/16c77a5/src/events/RaycasterManager.ts#L11) +[src/events/RaycasterManager.ts:11](https://github.com/agargaro/three.ez/blob/a81f57c/src/events/RaycasterManager.ts#L11) diff --git a/docs/docs/api/namespaces/Patch.md b/docs/docs/api/namespaces/Patch.md index 5a18eae..fc0e053 100644 --- a/docs/docs/api/namespaces/Patch.md +++ b/docs/docs/api/namespaces/Patch.md @@ -8,5 +8,6 @@ custom_edit_url: null ## Interfaces +- [MaterialExtPrototype](../interfaces/Patch.MaterialExtPrototype.md) - [Object3DExtPrototype](../interfaces/Patch.Object3DExtPrototype.md) - [SceneExtPrototype](../interfaces/Patch.SceneExtPrototype.md) diff --git a/docs/docs/api/namespaces/Tweening.md b/docs/docs/api/namespaces/Tweening.md index 54f9440..3ea279b 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/16c77a5/src/tweening/Easings.ts#L4) +[src/tweening/Easings.ts:4](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/tweening/Easings.ts#L2) +[src/tweening/Easings.ts:2](https://github.com/agargaro/three.ez/blob/a81f57c/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/16c77a5/src/tweening/Easings.ts#L6) +[src/tweening/Easings.ts:6](https://github.com/agargaro/three.ez/blob/a81f57c/src/tweening/Easings.ts#L6) diff --git a/docs/scripts/patch.ts b/docs/scripts/patch.ts index 7480c5d..6dac6f1 100644 --- a/docs/scripts/patch.ts +++ b/docs/scripts/patch.ts @@ -1,4 +1,5 @@ export * from '../../src/patch/Euler'; +export * from '../../src/patch/Material'; export * from '../../src/patch/Matrix4'; export * from '../../src/patch/Object3D'; export * from '../../src/patch/Quaternion';