angular-three 2.0.0-beta.273 → 2.0.0-beta.275

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/esm2022/index.mjs +5 -5
  2. package/esm2022/lib/canvas.mjs +2 -1
  3. package/esm2022/lib/dom/events.mjs +1 -1
  4. package/esm2022/lib/events.mjs +1 -1
  5. package/esm2022/lib/instance.mjs +1 -1
  6. package/esm2022/lib/loop.mjs +2 -2
  7. package/esm2022/lib/portal.mjs +1 -1
  8. package/esm2022/lib/renderer/index.mjs +1 -1
  9. package/esm2022/lib/renderer/utils.mjs +1 -1
  10. package/esm2022/lib/roots.mjs +2 -3
  11. package/esm2022/lib/store.mjs +1 -1
  12. package/esm2022/lib/three-types.mjs +1 -1
  13. package/esm2022/lib/types.mjs +1 -1
  14. package/esm2022/lib/utils/apply-props.mjs +1 -1
  15. package/esm2022/lib/utils/attach.mjs +1 -1
  16. package/esm2022/lib/utils/before-render.mjs +1 -1
  17. package/esm2022/lib/utils/is.mjs +1 -1
  18. package/esm2022/lib/utils/make.mjs +1 -1
  19. package/esm2022/lib/utils/object-events.mjs +1 -1
  20. package/esm2022/lib/utils/update.mjs +1 -1
  21. package/esm2022/testing/lib/test-bed.mjs +12 -6
  22. package/fesm2022/angular-three-testing.mjs +10 -4
  23. package/fesm2022/angular-three-testing.mjs.map +1 -1
  24. package/fesm2022/angular-three.mjs +528 -527
  25. package/fesm2022/angular-three.mjs.map +1 -1
  26. package/index.d.ts +4 -5
  27. package/lib/canvas.d.ts +199 -256
  28. package/lib/dom/events.d.ts +1 -2
  29. package/lib/events.d.ts +2 -78
  30. package/lib/html.d.ts +1 -1
  31. package/lib/instance.d.ts +1 -38
  32. package/lib/loop.d.ts +2 -2
  33. package/lib/portal.d.ts +3 -4
  34. package/lib/renderer/index.d.ts +1 -2
  35. package/lib/renderer/utils.d.ts +1 -1
  36. package/lib/roots.d.ts +1 -5
  37. package/lib/store.d.ts +2 -127
  38. package/lib/three-types.d.ts +1 -3
  39. package/lib/types.d.ts +290 -0
  40. package/lib/utils/apply-props.d.ts +1 -2
  41. package/lib/utils/attach.d.ts +1 -3
  42. package/lib/utils/before-render.d.ts +1 -1
  43. package/lib/utils/is.d.ts +1 -3
  44. package/lib/utils/make.d.ts +2 -5
  45. package/lib/utils/object-events.d.ts +1 -1
  46. package/lib/utils/update.d.ts +1 -1
  47. package/package.json +1 -1
@@ -1,5 +1,4 @@
1
- import { NgtEventManager } from '../events';
2
- import { NgtState } from '../store';
1
+ import { NgtEventManager, NgtState } from '../types';
3
2
  import { NgtSignalStore } from '../utils/signal-store';
4
3
  export declare const supportedEvents: readonly ["click", "contextmenu", "dblclick", "pointerup", "pointerdown", "pointerover", "pointerout", "pointerenter", "pointerleave", "pointermove", "pointermissed", "pointercancel", "wheel"];
5
4
  export declare function createPointerEvents(store: NgtSignalStore<NgtState>): NgtEventManager<HTMLElement>;
package/lib/events.d.ts CHANGED
@@ -1,82 +1,6 @@
1
- import { Intersection, Object3D, OrthographicCamera, PerspectiveCamera, Ray, Vector2, Vector3 } from 'three';
2
- import { NgtState } from './store';
3
- import { NgtProperties } from './types';
1
+ import { Object3D } from 'three';
2
+ import { NgtDomEvent, NgtState } from './types';
4
3
  import { NgtSignalStore } from './utils/signal-store';
5
- export interface NgtIntersection extends Intersection {
6
- /** The event source (the object which registered the handler) */
7
- eventObject: Object3D;
8
- }
9
- export interface NgtIntersectionEvent<TSourceEvent> extends NgtIntersection {
10
- /** The event source (the object which registered the handler) */
11
- eventObject: Object3D;
12
- /** An array of intersections */
13
- intersections: NgtIntersection[];
14
- /** vec3.set(pointer.x, pointer.y, 0).unproject(camera) */
15
- unprojectedPoint: Vector3;
16
- /** Normalized event coordinates */
17
- pointer: Vector2;
18
- /** Delta between first click and this event */
19
- delta: number;
20
- /** The ray that pierced it */
21
- ray: Ray;
22
- /** The camera that was used by the raycaster */
23
- camera: NgtCamera;
24
- /** stopPropagation will stop underlying handlers from firing */
25
- stopPropagation: () => void;
26
- /** The original host event */
27
- nativeEvent: TSourceEvent;
28
- /** If the event was stopped by calling stopPropagation */
29
- stopped: boolean;
30
- }
31
- export type NgtCamera = OrthographicCamera | PerspectiveCamera;
32
- export type NgtThreeEvent<TEvent> = NgtIntersectionEvent<TEvent> & NgtProperties<TEvent>;
33
- export type NgtDomEvent = PointerEvent | MouseEvent | WheelEvent;
34
- export type NgtEventHandlers = {
35
- click?: (event: NgtThreeEvent<MouseEvent>) => void;
36
- contextmenu?: (event: NgtThreeEvent<MouseEvent>) => void;
37
- dblclick?: (event: NgtThreeEvent<MouseEvent>) => void;
38
- pointerup?: (event: NgtThreeEvent<PointerEvent>) => void;
39
- pointerdown?: (event: NgtThreeEvent<PointerEvent>) => void;
40
- pointerover?: (event: NgtThreeEvent<PointerEvent>) => void;
41
- pointerout?: (event: NgtThreeEvent<PointerEvent>) => void;
42
- pointerenter?: (event: NgtThreeEvent<PointerEvent>) => void;
43
- pointerleave?: (event: NgtThreeEvent<PointerEvent>) => void;
44
- pointermove?: (event: NgtThreeEvent<PointerEvent>) => void;
45
- pointermissed?: (event: MouseEvent) => void;
46
- pointercancel?: (event: NgtThreeEvent<PointerEvent>) => void;
47
- wheel?: (event: NgtThreeEvent<WheelEvent>) => void;
48
- };
49
- export type NgtEvents = {
50
- [TEvent in keyof NgtEventHandlers]-?: EventListener;
51
- };
52
- export type NgtFilterFunction = (items: Intersection[], store: NgtSignalStore<NgtState>) => Intersection[];
53
- export type NgtComputeFunction = (event: NgtDomEvent, root: NgtSignalStore<NgtState>, previous: NgtSignalStore<NgtState> | null) => void;
54
- export type NgtEventManager<TTarget> = {
55
- /** Determines if the event layer is active */
56
- enabled: boolean;
57
- /** Event layer priority, higher prioritized layers come first and may stop(-propagate) lower layer */
58
- priority: number;
59
- /** The compute function needs to set up the raycaster and an xy- pointer */
60
- compute?: NgtComputeFunction;
61
- /** The filter can re-order or re-structure the intersections */
62
- filter?: NgtFilterFunction;
63
- /** The target node the event layer is tied to */
64
- connected?: TTarget;
65
- /** All the pointer event handlers through which the host forwards native events */
66
- handlers?: NgtEvents;
67
- /** Allows re-connecting to another target */
68
- connect?: (target: TTarget) => void;
69
- /** Removes all existing events handlers from the target */
70
- disconnect?: () => void;
71
- /** Triggers a onPointerMove with the last known event. This can be useful to enable raycasting without
72
- * explicit user interaction, for instance when the camera moves a hoverable object underneath the cursor.
73
- */
74
- update?: () => void;
75
- };
76
- export interface NgtPointerCaptureTarget {
77
- intersection: NgtIntersection;
78
- target: Element;
79
- }
80
4
  export declare function removeInteractivity(store: NgtSignalStore<NgtState>, object: Object3D): void;
81
5
  export declare function createEvents(store: NgtSignalStore<NgtState>): {
82
6
  handlePointer: (name: string) => (event: NgtDomEvent) => void;
package/lib/html.d.ts CHANGED
@@ -7,7 +7,7 @@ export declare function provideHTMLDomElement<TDeps extends Array<ProviderToken<
7
7
  }>(deps: TDeps, factory: (...args: TValues) => HTMLElement): Provider;
8
8
  export declare abstract class NgtHTML {
9
9
  static [HTML]: boolean;
10
- protected store: import("angular-three").NgtSignalStore<import("./store").NgtState>;
10
+ protected store: import("angular-three").NgtSignalStore<import("./types").NgtState>;
11
11
  protected destroyRef: DestroyRef;
12
12
  protected host: ElementRef<HTMLElement>;
13
13
  protected domElement: HTMLElement | "gl" | null;
package/lib/instance.d.ts CHANGED
@@ -1,41 +1,4 @@
1
- import { Signal } from '@angular/core';
2
- import { NgtEventHandlers } from './events';
3
- import { NgtState } from './store';
4
- import { NgtAnyRecord } from './types';
5
- import { NgtSignalStore } from './utils/signal-store';
6
- export type NgtAttachFunction<TChild = any, TParent = any> = (parent: TParent, child: TChild, store: NgtSignalStore<NgtState>) => void | (() => void);
7
- export interface NgtAfterAttach<TChild extends NgtInstanceNode = NgtInstanceNode, TParent extends NgtInstanceNode = NgtInstanceNode> {
8
- parent: TParent;
9
- node: TChild;
10
- }
11
- export interface NgtLocalInstanceState {
12
- objects: NgtInstanceNode[];
13
- nonObjects: NgtInstanceNode[];
14
- parent: NgtInstanceNode | null;
15
- }
16
- export interface NgtLocalState {
17
- /** the store of the canvas that the instance is being rendered to */
18
- store: NgtSignalStore<NgtState>;
19
- instanceStore: NgtSignalStore<NgtLocalInstanceState>;
20
- parent: Signal<NgtLocalInstanceState['parent']>;
21
- objects: Signal<NgtLocalInstanceState['objects']>;
22
- nonObjects: Signal<NgtLocalInstanceState['nonObjects']>;
23
- add: (instance: NgtInstanceNode, type: 'objects' | 'nonObjects') => void;
24
- remove: (instance: NgtInstanceNode, type: 'objects' | 'nonObjects') => void;
25
- setParent: (parent: NgtInstanceNode | null) => void;
26
- primitive?: boolean;
27
- eventCount: number;
28
- handlers: Partial<NgtEventHandlers>;
29
- attach?: string[] | NgtAttachFunction;
30
- previousAttach?: unknown | (() => void);
31
- isRaw?: boolean;
32
- priority?: number;
33
- onUpdate?: (node: NgtInstanceNode) => void;
34
- onAttach?: (afterAttach: NgtAfterAttach) => void;
35
- }
36
- export type NgtInstanceNode<TNode = any> = {
37
- __ngt__: NgtLocalState;
38
- } & NgtAnyRecord & TNode;
1
+ import { NgtAnyRecord, NgtInstanceNode, NgtLocalState } from './types';
39
2
  export declare function getLocalState<TInstance extends object>(obj: TInstance | undefined): NgtLocalState | undefined;
40
3
  export declare function invalidateInstance<TInstance extends object>(instance: TInstance): void;
41
4
  export declare function prepare<TInstance extends object = NgtAnyRecord>(object: TInstance, localState?: Partial<NgtLocalState>): NgtInstanceNode<TInstance>;
package/lib/loop.d.ts CHANGED
@@ -1,6 +1,6 @@
1
- import { NgtState } from './store';
1
+ import { NgtCanvasElement, NgtGlobalRenderCallback, NgtState } from './types';
2
2
  import { NgtSignalStore } from './utils/signal-store';
3
- export type NgtGlobalRenderCallback = (timeStamp: number) => void;
3
+ export declare const roots: Map<NgtCanvasElement, NgtSignalStore<NgtState>>;
4
4
  /**
5
5
  * Adds a global render callback which is called each frame.
6
6
  * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#addEffect
package/lib/portal.d.ts CHANGED
@@ -1,7 +1,6 @@
1
1
  import { Injector, TemplateRef, ViewContainerRef } from '@angular/core';
2
2
  import { Camera, Object3D, Scene } from 'three';
3
- import { NgtComputeFunction } from './events';
4
- import { NgtSize, NgtState } from './store';
3
+ import { NgtComputeFunction, NgtSize, NgtState } from './types';
5
4
  import * as i0 from "@angular/core";
6
5
  export declare class NgtPortalBeforeRender {
7
6
  private portalStore;
@@ -35,7 +34,7 @@ export type NgtPortalInjectableState = Partial<Omit<NgtState, NgtPortalPrivateKe
35
34
  }>;
36
35
  export declare class NgtPortal {
37
36
  container: import("@angular/core").InputSignal<Object3D<import("three").Object3DEventMap>>;
38
- state: import("@angular/core").InputSignal<Partial<Omit<NgtState, "setSize" | "viewport" | "events" | "size" | "invalidate" | "advance" | "setEvents" | "setDpr" | "setFrameloop"> & {
37
+ state: import("@angular/core").InputSignal<Partial<Omit<NgtState, "viewport" | "size" | "setSize" | "events" | "invalidate" | "advance" | "setEvents" | "setDpr" | "setFrameloop"> & {
39
38
  events?: {
40
39
  enabled?: boolean;
41
40
  priority?: number;
@@ -55,7 +54,7 @@ export declare class NgtPortal {
55
54
  private portalStore;
56
55
  private parentStore;
57
56
  parentScene: import("@angular/core").Signal<Scene>;
58
- parentCamera: import("@angular/core").Signal<import("./store").NgtCameraManual>;
57
+ parentCamera: import("@angular/core").Signal<import("./types").NgtCameraManual>;
59
58
  private raycaster;
60
59
  private pointer;
61
60
  private portalRendered;
@@ -1,6 +1,5 @@
1
1
  import { Renderer2, RendererFactory2, RendererType2 } from '@angular/core';
2
- import { NgtState } from '../store';
3
- import { NgtAnyRecord } from '../types';
2
+ import { NgtAnyRecord, NgtState } from '../types';
4
3
  import { NgtSignalStore } from '../utils/signal-store';
5
4
  import { NgtAnyConstructor } from './catalogue';
6
5
  import { NgtRendererNode, NgtRendererState } from './state';
@@ -1,4 +1,4 @@
1
- import { NgtInstanceNode } from '../instance';
1
+ import { NgtInstanceNode } from '../types';
2
2
  export declare const enum NgtRendererClassId {
3
3
  type = 0,
4
4
  parent = 1,
package/lib/roots.d.ts CHANGED
@@ -1,9 +1,5 @@
1
1
  import { Injector } from '@angular/core';
2
- import { NgtCanvasOptions } from './canvas';
3
- import { NgtState } from './store';
4
- import { NgtSignalStore } from './utils/signal-store';
5
- export type NgtCanvasElement = HTMLCanvasElement | OffscreenCanvas;
6
- export declare const roots: Map<NgtCanvasElement, NgtSignalStore<NgtState>>;
2
+ import { NgtCanvasElement, NgtCanvasOptions } from './types';
7
3
  export declare function injectCanvasRootInitializer(injector?: Injector): (canvas: NgtCanvasElement) => {
8
4
  isConfigured: boolean;
9
5
  destroy: (timeout?: number) => void;
package/lib/store.d.ts CHANGED
@@ -1,131 +1,6 @@
1
- import { ElementRef, InjectOptions, InjectionToken } from '@angular/core';
2
- import { Observable } from 'rxjs';
3
- import { Camera, Clock, EventDispatcher, Object3D, Raycaster, Scene, Vector2, Vector3, WebGLRenderer } from 'three';
4
- import { NgtCamera, NgtDomEvent, NgtEventManager, NgtPointerCaptureTarget, NgtThreeEvent } from './events';
5
- import { NgtInstanceNode } from './instance';
1
+ import { InjectOptions, InjectionToken } from '@angular/core';
2
+ import { NgtState } from './types';
6
3
  import { NgtSignalStore } from './utils/signal-store';
7
- export type NgtRendererLike = {
8
- render: (scene: Scene, camera: Camera) => any;
9
- };
10
- export type NgtCameraManual = NgtCamera & {
11
- manual?: boolean;
12
- };
13
- export type NgtDpr = number | [min: number, max: number];
14
- export type NgtSize = {
15
- width: number;
16
- height: number;
17
- top: number;
18
- left: number;
19
- };
20
- export type NgtViewport = NgtSize & {
21
- /** The initial pixel ratio */
22
- initialDpr: number;
23
- /** Current pixel ratio */
24
- dpr: number;
25
- /** size.width / viewport.width */
26
- factor: number;
27
- /** Camera distance */
28
- distance: number;
29
- /** Camera aspect ratio: width / height */
30
- aspect: number;
31
- };
32
- export type NgtPerformance = {
33
- /** Current performance normal, between min and max */
34
- current: number;
35
- /** How low the performance can go, between 0 and max */
36
- min: number;
37
- /** How high the performance can go, between min and max */
38
- max: number;
39
- /** Time until current returns to max in ms */
40
- debounce: number;
41
- /** Sets current to min, puts the system in regression */
42
- regress: () => void;
43
- };
44
- export type NgtRenderState = NgtState & {
45
- delta: number;
46
- frame?: XRFrame;
47
- };
48
- export type NgtBeforeRenderEvent<TObject extends NgtInstanceNode = NgtInstanceNode> = {
49
- state: NgtRenderState;
50
- object: TObject;
51
- };
52
- export type NgtBeforeRenderRecord = {
53
- callback: (state: NgtRenderState) => void;
54
- store: NgtSignalStore<NgtState>;
55
- priority?: number;
56
- };
57
- export type NgtInternalState = {
58
- active: boolean;
59
- priority: number;
60
- frames: number;
61
- lastEvent: ElementRef<NgtDomEvent | null>;
62
- interaction: Object3D[];
63
- hovered: Map<string, NgtThreeEvent<NgtDomEvent>>;
64
- capturedMap: Map<number, Map<Object3D, NgtPointerCaptureTarget>>;
65
- initialClick: [x: number, y: number];
66
- initialHits: Object3D[];
67
- subscribers: NgtBeforeRenderRecord[];
68
- subscribe: (callback: NgtBeforeRenderRecord['callback'], priority?: number, store?: NgtSignalStore<NgtState>) => () => void;
69
- };
70
- export type NgtState = {
71
- /** The instance of the renderer */
72
- gl: WebGLRenderer;
73
- /** Default camera */
74
- camera: NgtCameraManual;
75
- /** Default scene */
76
- scene: Scene;
77
- /** Default raycaster */
78
- raycaster: Raycaster;
79
- /** Default clock */
80
- clock: Clock;
81
- /** Event layer interface, contains the event handler and the node they're connected to */
82
- events: NgtEventManager<any>;
83
- /** XR interface */
84
- xr: {
85
- connect: () => void;
86
- disconnect: () => void;
87
- };
88
- /** Currently used controls */
89
- controls: EventDispatcher | null;
90
- /** Normalized event coordinates */
91
- pointer: Vector2;
92
- legacy: boolean;
93
- /** Shortcut to gl.outputColorSpace = LinearSRGBColorSpace */
94
- linear: boolean;
95
- /** Shortcut to gl.toneMapping = NoTonemapping */
96
- flat: boolean;
97
- /** Render loop flags */
98
- frameloop: 'always' | 'demand' | 'never';
99
- /** Adaptive performance interface */
100
- performance: NgtPerformance;
101
- /** Reactive pixel-size of the canvas */
102
- size: NgtSize;
103
- /** Reactive size of the viewport in threejs units */
104
- viewport: NgtViewport & {
105
- getCurrentViewport: (camera?: NgtCamera, target?: Vector3 | Parameters<Vector3['set']>, size?: NgtSize) => Omit<NgtViewport, 'dpr' | 'initialDpr'>;
106
- };
107
- /** Flags the canvas for render, but doesn't render in itself */
108
- invalidate: (frames?: number) => void;
109
- /** Advance (render) one step */
110
- advance: (timestamp: number, runGlobalEffects?: boolean) => void;
111
- /** Shortcut to setting the event layer */
112
- setEvents: (events: Partial<NgtEventManager<any>>) => void;
113
- /**
114
- * Shortcut to manual sizing
115
- */
116
- setSize: (width: number, height: number, top?: number, left?: number) => void;
117
- /** Shortcut to manual setting the pixel ratio */
118
- setDpr: (dpr: NgtDpr) => void;
119
- /** Shortcut to frameloop flags */
120
- setFrameloop: (frameloop?: 'always' | 'demand' | 'never') => void;
121
- /** When the canvas was clicked but nothing was hit */
122
- /** PointerMissed Observable */
123
- pointerMissed$: Observable<MouseEvent>;
124
- /** If this state model is layered (via createPortal) then this contains the previous layer */
125
- previousRoot: NgtSignalStore<NgtState> | null;
126
- /** Internals */
127
- internal: NgtInternalState;
128
- };
129
4
  declare function storeFactory(previousStore: NgtSignalStore<NgtState> | null): NgtSignalStore<NgtState>;
130
5
  export declare const NGT_STORE: InjectionToken<NgtSignalStore<NgtState>>;
131
6
  export declare function provideStore(store?: () => NgtSignalStore<NgtState>): {
@@ -1,7 +1,5 @@
1
1
  import { AmbientLight, ArrayCamera, ArrowHelper, Audio, AxesHelper, BatchedMesh, Bone, Box3Helper, BoxGeometry, BoxHelper, BufferAttribute, BufferGeometry, Camera, CameraHelper, CanvasTexture, CapsuleGeometry, CircleGeometry, Color, ColorRepresentation, CompressedTexture, ConeGeometry, CubeCamera, CubeTexture, CylinderGeometry, Data3DTexture, DataTexture, DepthTexture, DirectionalLight, DirectionalLightHelper, DirectionalLightShadow, DodecahedronGeometry, EdgesGeometry, Euler, ExtrudeGeometry, Float16BufferAttribute, Float32BufferAttribute, Fog, FogExp2, GridHelper, Group, HemisphereLight, HemisphereLightHelper, IcosahedronGeometry, InstancedBufferAttribute, InstancedBufferGeometry, InstancedMesh, Int16BufferAttribute, Int32BufferAttribute, Int8BufferAttribute, LOD, LatheGeometry, Layers, Light, LightProbe, LightShadow, Line, LineBasicMaterial, LineBasicMaterialParameters, LineDashedMaterial, LineDashedMaterialParameters, LineLoop, LineSegments, Material, Matrix3, Matrix4, Mesh, MeshBasicMaterial, MeshBasicMaterialParameters, MeshDepthMaterial, MeshDepthMaterialParameters, MeshDistanceMaterial, MeshDistanceMaterialParameters, MeshLambertMaterial, MeshLambertMaterialParameters, MeshMatcapMaterial, MeshMatcapMaterialParameters, MeshNormalMaterial, MeshNormalMaterialParameters, MeshPhongMaterial, MeshPhongMaterialParameters, MeshPhysicalMaterial, MeshPhysicalMaterialParameters, MeshStandardMaterial, MeshStandardMaterialParameters, MeshToonMaterial, MeshToonMaterialParameters, Object3D, OctahedronGeometry, OrthographicCamera, PerspectiveCamera, PlaneGeometry, PlaneHelper, PointLight, PointLightHelper, Points, PointsMaterial, PointsMaterialParameters, PolarGridHelper, PolyhedronGeometry, PositionalAudio, Quaternion, RawShaderMaterial, Raycaster, RectAreaLight, RingGeometry, Scene, ShaderMaterial, ShaderMaterialParameters, ShadowMaterial, Shape, ShapeGeometry, Skeleton, SkeletonHelper, SkinnedMesh, SphereGeometry, SpotLight, SpotLightHelper, SpotLightShadow, Sprite, SpriteMaterial, SpriteMaterialParameters, TetrahedronGeometry, Texture, TorusGeometry, TorusKnotGeometry, TubeGeometry, Uint16BufferAttribute, Uint32BufferAttribute, Uint8BufferAttribute, Vector2, Vector3, Vector4, VideoTexture, WireframeGeometry } from 'three';
2
- import { NgtEventHandlers } from './events';
3
- import { NgtAfterAttach, NgtAttachFunction, NgtInstanceNode } from './instance';
4
- import { NgtBeforeRenderEvent } from './store';
2
+ import { NgtAfterAttach, NgtAttachFunction, NgtBeforeRenderEvent, NgtEventHandlers, NgtInstanceNode } from './types';
5
3
  type Expand<T> = T extends infer O ? {
6
4
  [K in keyof O]: O[K];
7
5
  } : never;
package/lib/types.d.ts CHANGED
@@ -1,3 +1,8 @@
1
+ import { ElementRef, Signal } from '@angular/core';
2
+ import { Observable } from 'rxjs';
3
+ import { Camera, Clock, EventDispatcher, Intersection, Object3D, OrthographicCamera, PerspectiveCamera, Ray, Raycaster, Scene, Vector2, Vector3, WebGLRenderer, WebGLRendererParameters, WebGLShadowMap } from 'three';
4
+ import { NgtObject3DNode } from './three-types';
5
+ import { NgtSignalStore } from './utils/signal-store';
1
6
  export type NgtProperties<T> = Pick<T, {
2
7
  [K in keyof T]: T[K] extends (_: any) => any ? never : K;
3
8
  }[keyof T]>;
@@ -10,3 +15,288 @@ export type NgtEquConfig = {
10
15
  /** If true the keys in both a and b must match 1:1 (default), if false a's keys must intersect b's */
11
16
  strict?: boolean;
12
17
  };
18
+ export type NgtGLOptions = NgtRendererLike | ((canvas: NgtCanvasElement) => NgtRendererLike) | Partial<NgtProperties<WebGLRenderer> | WebGLRendererParameters> | undefined;
19
+ export interface NgtCanvasOptions {
20
+ /** A threejs renderer instance or props that go into the default renderer */
21
+ gl?: NgtGLOptions;
22
+ /** Dimensions to fit the renderer to. Will measure canvas dimensions if omitted */
23
+ size?: NgtSize;
24
+ /**
25
+ * Enables shadows (by default PCFsoft). Can accept `gl.shadowMap` options for fine-tuning,
26
+ * but also strings: 'basic' | 'percentage' | 'soft' | 'variance'.
27
+ * @see https://threejs.org/docs/#api/en/renderers/WebGLRenderer.shadowMap
28
+ */
29
+ shadows?: boolean | 'basic' | 'percentage' | 'soft' | 'variance' | Partial<WebGLShadowMap>;
30
+ /**
31
+ * Disables three r139 color management.
32
+ * @see https://threejs.org/docs/#manual/en/introduction/Color-management
33
+ */
34
+ legacy?: boolean;
35
+ /** Switch off automatic sRGB color space and gamma correction */
36
+ linear?: boolean;
37
+ /** Use `THREE.NoToneMapping` instead of `THREE.ACESFilmicToneMapping` */
38
+ flat?: boolean;
39
+ /** Creates an orthographic camera */
40
+ orthographic?: boolean;
41
+ /**
42
+ * R3F's render mode. Set to `demand` to only render on state change or `never` to take control.
43
+ * @see https://docs.pmnd.rs/react-three-fiber/advanced/scaling-performance#on-demand-rendering
44
+ */
45
+ frameloop?: 'always' | 'demand' | 'never';
46
+ /**
47
+ * R3F performance options for adaptive performance.
48
+ * @see https://docs.pmnd.rs/react-three-fiber/advanced/scaling-performance#movement-regression
49
+ */
50
+ performance?: Partial<Omit<NgtPerformance, 'regress'>>;
51
+ /** Target pixel ratio. Can clamp between a range: `[min, max]` */
52
+ dpr?: NgtDpr;
53
+ /** Props that go into the default raycaster */
54
+ raycaster?: Partial<Raycaster>;
55
+ /** A `Scene` instance or props that go into the default scene */
56
+ scene?: Scene | Partial<Scene>;
57
+ /** A `Camera` instance or props that go into the default camera */
58
+ camera?: (NgtCamera | Partial<NgtObject3DNode<Camera, typeof Camera> & NgtObject3DNode<PerspectiveCamera, typeof PerspectiveCamera> & NgtObject3DNode<OrthographicCamera, typeof OrthographicCamera>>) & {
59
+ /** Flags the camera as manual, putting projection into your own hands */
60
+ manual?: boolean;
61
+ };
62
+ /** An R3F event manager to manage elements' pointer events */
63
+ events?: (store: NgtSignalStore<NgtState>) => NgtEventManager<HTMLElement>;
64
+ /** The target where events are being subscribed to, default: the div that wraps canvas */
65
+ eventSource?: HTMLElement | ElementRef<HTMLElement>;
66
+ /** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
67
+ eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen';
68
+ /** Default coordinate for the camera to look at */
69
+ lookAt?: Vector3 | Parameters<Vector3['set']>;
70
+ }
71
+ export interface NgtIntersection extends Intersection {
72
+ /** The event source (the object which registered the handler) */
73
+ eventObject: Object3D;
74
+ }
75
+ export interface NgtIntersectionEvent<TSourceEvent> extends NgtIntersection {
76
+ /** The event source (the object which registered the handler) */
77
+ eventObject: Object3D;
78
+ /** An array of intersections */
79
+ intersections: NgtIntersection[];
80
+ /** vec3.set(pointer.x, pointer.y, 0).unproject(camera) */
81
+ unprojectedPoint: Vector3;
82
+ /** Normalized event coordinates */
83
+ pointer: Vector2;
84
+ /** Delta between first click and this event */
85
+ delta: number;
86
+ /** The ray that pierced it */
87
+ ray: Ray;
88
+ /** The camera that was used by the raycaster */
89
+ camera: NgtCamera;
90
+ /** stopPropagation will stop underlying handlers from firing */
91
+ stopPropagation: () => void;
92
+ /** The original host event */
93
+ nativeEvent: TSourceEvent;
94
+ /** If the event was stopped by calling stopPropagation */
95
+ stopped: boolean;
96
+ }
97
+ export type NgtCamera = OrthographicCamera | PerspectiveCamera;
98
+ export type NgtThreeEvent<TEvent> = NgtIntersectionEvent<TEvent> & NgtProperties<TEvent>;
99
+ export type NgtDomEvent = PointerEvent | MouseEvent | WheelEvent;
100
+ export type NgtEventHandlers = {
101
+ click?: (event: NgtThreeEvent<MouseEvent>) => void;
102
+ contextmenu?: (event: NgtThreeEvent<MouseEvent>) => void;
103
+ dblclick?: (event: NgtThreeEvent<MouseEvent>) => void;
104
+ pointerup?: (event: NgtThreeEvent<PointerEvent>) => void;
105
+ pointerdown?: (event: NgtThreeEvent<PointerEvent>) => void;
106
+ pointerover?: (event: NgtThreeEvent<PointerEvent>) => void;
107
+ pointerout?: (event: NgtThreeEvent<PointerEvent>) => void;
108
+ pointerenter?: (event: NgtThreeEvent<PointerEvent>) => void;
109
+ pointerleave?: (event: NgtThreeEvent<PointerEvent>) => void;
110
+ pointermove?: (event: NgtThreeEvent<PointerEvent>) => void;
111
+ pointermissed?: (event: MouseEvent) => void;
112
+ pointercancel?: (event: NgtThreeEvent<PointerEvent>) => void;
113
+ wheel?: (event: NgtThreeEvent<WheelEvent>) => void;
114
+ };
115
+ export type NgtEvents = {
116
+ [TEvent in keyof NgtEventHandlers]-?: EventListener;
117
+ };
118
+ export type NgtFilterFunction = (items: Intersection[], store: NgtSignalStore<NgtState>) => Intersection[];
119
+ export type NgtComputeFunction = (event: NgtDomEvent, root: NgtSignalStore<NgtState>, previous: NgtSignalStore<NgtState> | null) => void;
120
+ export type NgtEventManager<TTarget> = {
121
+ /** Determines if the event layer is active */
122
+ enabled: boolean;
123
+ /** Event layer priority, higher prioritized layers come first and may stop(-propagate) lower layer */
124
+ priority: number;
125
+ /** The compute function needs to set up the raycaster and an xy- pointer */
126
+ compute?: NgtComputeFunction;
127
+ /** The filter can re-order or re-structure the intersections */
128
+ filter?: NgtFilterFunction;
129
+ /** The target node the event layer is tied to */
130
+ connected?: TTarget;
131
+ /** All the pointer event handlers through which the host forwards native events */
132
+ handlers?: NgtEvents;
133
+ /** Allows re-connecting to another target */
134
+ connect?: (target: TTarget) => void;
135
+ /** Removes all existing events handlers from the target */
136
+ disconnect?: () => void;
137
+ /** Triggers a onPointerMove with the last known event. This can be useful to enable raycasting without
138
+ * explicit user interaction, for instance when the camera moves a hoverable object underneath the cursor.
139
+ */
140
+ update?: () => void;
141
+ };
142
+ export interface NgtPointerCaptureTarget {
143
+ intersection: NgtIntersection;
144
+ target: Element;
145
+ }
146
+ export type NgtAttachFunction<TChild = any, TParent = any> = (parent: TParent, child: TChild, store: NgtSignalStore<NgtState>) => void | (() => void);
147
+ export interface NgtAfterAttach<TChild extends NgtInstanceNode = NgtInstanceNode, TParent extends NgtInstanceNode = NgtInstanceNode> {
148
+ parent: TParent;
149
+ node: TChild;
150
+ }
151
+ export interface NgtLocalInstanceState {
152
+ objects: NgtInstanceNode[];
153
+ nonObjects: NgtInstanceNode[];
154
+ parent: NgtInstanceNode | null;
155
+ }
156
+ export interface NgtLocalState {
157
+ /** the store of the canvas that the instance is being rendered to */
158
+ store: NgtSignalStore<NgtState>;
159
+ instanceStore: NgtSignalStore<NgtLocalInstanceState>;
160
+ parent: Signal<NgtLocalInstanceState['parent']>;
161
+ objects: Signal<NgtLocalInstanceState['objects']>;
162
+ nonObjects: Signal<NgtLocalInstanceState['nonObjects']>;
163
+ add: (instance: NgtInstanceNode, type: 'objects' | 'nonObjects') => void;
164
+ remove: (instance: NgtInstanceNode, type: 'objects' | 'nonObjects') => void;
165
+ setParent: (parent: NgtInstanceNode | null) => void;
166
+ primitive?: boolean;
167
+ eventCount: number;
168
+ handlers: Partial<NgtEventHandlers>;
169
+ attach?: string[] | NgtAttachFunction;
170
+ previousAttach?: unknown | (() => void);
171
+ isRaw?: boolean;
172
+ priority?: number;
173
+ onUpdate?: (node: NgtInstanceNode) => void;
174
+ onAttach?: (afterAttach: NgtAfterAttach) => void;
175
+ }
176
+ export type NgtInstanceNode<TNode = any> = {
177
+ __ngt__: NgtLocalState;
178
+ } & NgtAnyRecord & TNode;
179
+ export type NgtCanvasElement = HTMLCanvasElement | OffscreenCanvas;
180
+ export type NgtGlobalRenderCallback = (timeStamp: number) => void;
181
+ export type NgtRendererLike = {
182
+ render: (scene: Scene, camera: Camera) => any;
183
+ };
184
+ export type NgtCameraManual = NgtCamera & {
185
+ manual?: boolean;
186
+ };
187
+ export type NgtDpr = number | [min: number, max: number];
188
+ export type NgtSize = {
189
+ width: number;
190
+ height: number;
191
+ top: number;
192
+ left: number;
193
+ };
194
+ export type NgtViewport = NgtSize & {
195
+ /** The initial pixel ratio */
196
+ initialDpr: number;
197
+ /** Current pixel ratio */
198
+ dpr: number;
199
+ /** size.width / viewport.width */
200
+ factor: number;
201
+ /** Camera distance */
202
+ distance: number;
203
+ /** Camera aspect ratio: width / height */
204
+ aspect: number;
205
+ };
206
+ export type NgtPerformance = {
207
+ /** Current performance normal, between min and max */
208
+ current: number;
209
+ /** How low the performance can go, between 0 and max */
210
+ min: number;
211
+ /** How high the performance can go, between min and max */
212
+ max: number;
213
+ /** Time until current returns to max in ms */
214
+ debounce: number;
215
+ /** Sets current to min, puts the system in regression */
216
+ regress: () => void;
217
+ };
218
+ export type NgtRenderState = NgtState & {
219
+ delta: number;
220
+ frame?: XRFrame;
221
+ };
222
+ export type NgtBeforeRenderEvent<TObject extends NgtInstanceNode = NgtInstanceNode> = {
223
+ state: NgtRenderState;
224
+ object: TObject;
225
+ };
226
+ export type NgtBeforeRenderRecord = {
227
+ callback: (state: NgtRenderState) => void;
228
+ store: NgtSignalStore<NgtState>;
229
+ priority?: number;
230
+ };
231
+ export type NgtInternalState = {
232
+ active: boolean;
233
+ priority: number;
234
+ frames: number;
235
+ lastEvent: ElementRef<NgtDomEvent | null>;
236
+ interaction: Object3D[];
237
+ hovered: Map<string, NgtThreeEvent<NgtDomEvent>>;
238
+ capturedMap: Map<number, Map<Object3D, NgtPointerCaptureTarget>>;
239
+ initialClick: [x: number, y: number];
240
+ initialHits: Object3D[];
241
+ subscribers: NgtBeforeRenderRecord[];
242
+ subscribe: (callback: NgtBeforeRenderRecord['callback'], priority?: number, store?: NgtSignalStore<NgtState>) => () => void;
243
+ };
244
+ export type NgtState = {
245
+ /** The instance of the renderer */
246
+ gl: WebGLRenderer;
247
+ /** Default camera */
248
+ camera: NgtCameraManual;
249
+ /** Default scene */
250
+ scene: Scene;
251
+ /** Default raycaster */
252
+ raycaster: Raycaster;
253
+ /** Default clock */
254
+ clock: Clock;
255
+ /** Event layer interface, contains the event handler and the node they're connected to */
256
+ events: NgtEventManager<any>;
257
+ /** XR interface */
258
+ xr: {
259
+ connect: () => void;
260
+ disconnect: () => void;
261
+ };
262
+ /** Currently used controls */
263
+ controls: EventDispatcher | null;
264
+ /** Normalized event coordinates */
265
+ pointer: Vector2;
266
+ legacy: boolean;
267
+ /** Shortcut to gl.outputColorSpace = LinearSRGBColorSpace */
268
+ linear: boolean;
269
+ /** Shortcut to gl.toneMapping = NoTonemapping */
270
+ flat: boolean;
271
+ /** Render loop flags */
272
+ frameloop: 'always' | 'demand' | 'never';
273
+ /** Adaptive performance interface */
274
+ performance: NgtPerformance;
275
+ /** Reactive pixel-size of the canvas */
276
+ size: NgtSize;
277
+ /** Reactive size of the viewport in threejs units */
278
+ viewport: NgtViewport & {
279
+ getCurrentViewport: (camera?: NgtCamera, target?: Vector3 | Parameters<Vector3['set']>, size?: NgtSize) => Omit<NgtViewport, 'dpr' | 'initialDpr'>;
280
+ };
281
+ /** Flags the canvas for render, but doesn't render in itself */
282
+ invalidate: (frames?: number) => void;
283
+ /** Advance (render) one step */
284
+ advance: (timestamp: number, runGlobalEffects?: boolean) => void;
285
+ /** Shortcut to setting the event layer */
286
+ setEvents: (events: Partial<NgtEventManager<any>>) => void;
287
+ /**
288
+ * Shortcut to manual sizing
289
+ */
290
+ setSize: (width: number, height: number, top?: number, left?: number) => void;
291
+ /** Shortcut to manual setting the pixel ratio */
292
+ setDpr: (dpr: NgtDpr) => void;
293
+ /** Shortcut to frameloop flags */
294
+ setFrameloop: (frameloop?: 'always' | 'demand' | 'never') => void;
295
+ /** When the canvas was clicked but nothing was hit */
296
+ /** PointerMissed Observable */
297
+ pointerMissed$: Observable<MouseEvent>;
298
+ /** If this state model is layered (via createPortal) then this contains the previous layer */
299
+ previousRoot: NgtSignalStore<NgtState> | null;
300
+ /** Internals */
301
+ internal: NgtInternalState;
302
+ };
@@ -1,3 +1,2 @@
1
- import { NgtInstanceNode } from '../instance';
2
- import { NgtAnyRecord } from '../types';
1
+ import { NgtAnyRecord, NgtInstanceNode } from '../types';
3
2
  export declare function applyProps(instance: NgtInstanceNode, props: NgtAnyRecord): any;