angular-three 2.0.0-beta.31 → 2.0.0-beta.310
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.
- package/README.md +221 -4
- package/esm2022/index.mjs +13 -13
- package/esm2022/lib/canvas.mjs +128 -200
- package/esm2022/lib/directives/args.mjs +46 -20
- package/esm2022/lib/directives/selection.mjs +65 -0
- package/esm2022/lib/dom/events.mjs +2 -2
- package/esm2022/lib/events.mjs +33 -31
- package/esm2022/lib/html.mjs +40 -0
- package/esm2022/lib/instance.mjs +43 -36
- package/esm2022/lib/loader.mjs +62 -31
- package/esm2022/lib/loop.mjs +28 -25
- package/esm2022/lib/pipes/hexify.mjs +67 -0
- package/esm2022/lib/portal.mjs +173 -193
- package/esm2022/lib/renderer/catalogue.mjs +2 -2
- package/esm2022/lib/renderer/constants.mjs +5 -6
- package/esm2022/lib/renderer/index.mjs +387 -234
- package/esm2022/lib/renderer/state.mjs +49 -0
- package/esm2022/lib/renderer/utils.mjs +107 -95
- package/esm2022/lib/roots.mjs +85 -61
- package/esm2022/lib/routed-scene.mjs +6 -7
- package/esm2022/lib/store.mjs +170 -194
- package/esm2022/lib/three-types.mjs +2 -2
- package/esm2022/lib/types.mjs +1 -1
- package/esm2022/lib/utils/apply-props.mjs +24 -28
- package/esm2022/lib/utils/attach.mjs +12 -9
- package/esm2022/lib/utils/before-render.mjs +12 -0
- package/esm2022/lib/utils/is.mjs +6 -5
- package/esm2022/lib/utils/make.mjs +19 -17
- package/esm2022/lib/utils/non-nullish.mjs +7 -0
- package/esm2022/lib/utils/object-events.mjs +92 -0
- package/esm2022/lib/utils/parameters.mjs +70 -0
- package/esm2022/lib/utils/resolve-ref.mjs +8 -0
- package/esm2022/lib/utils/signal-store.mjs +52 -58
- package/esm2022/lib/utils/update.mjs +8 -4
- package/esm2022/testing/angular-three-testing.mjs +5 -0
- package/esm2022/testing/index.mjs +3 -0
- package/esm2022/testing/lib/test-bed.mjs +130 -0
- package/esm2022/testing/lib/test-canvas.mjs +45 -0
- package/esm2022/testing/lib/utils/mock-canvas.mjs +37 -0
- package/esm2022/testing/lib/utils/web-gl-rendering-context.mjs +752 -0
- package/fesm2022/angular-three-testing.mjs +966 -0
- package/fesm2022/angular-three-testing.mjs.map +1 -0
- package/fesm2022/angular-three.mjs +2506 -2539
- package/fesm2022/angular-three.mjs.map +1 -1
- package/index.d.ts +14 -12
- package/lib/canvas.d.ts +366 -96
- package/lib/directives/args.d.ts +14 -7
- package/lib/directives/selection.d.ts +17 -0
- package/lib/dom/events.d.ts +2 -3
- package/lib/events.d.ts +4 -80
- package/lib/html.d.ts +17 -0
- package/lib/instance.d.ts +3 -35
- package/lib/loader.d.ts +18 -6
- package/lib/loop.d.ts +11 -59
- package/lib/pipes/hexify.d.ts +20 -0
- package/lib/portal.d.ts +54 -48
- package/lib/renderer/catalogue.d.ts +7 -3
- package/lib/renderer/constants.d.ts +4 -5
- package/lib/renderer/index.d.ts +64 -4
- package/lib/renderer/state.d.ts +24 -0
- package/lib/renderer/utils.d.ts +9 -27
- package/lib/roots.d.ts +9 -7
- package/lib/store.d.ts +13 -141
- package/lib/three-types.d.ts +500 -147
- package/lib/types.d.ts +291 -0
- package/lib/utils/apply-props.d.ts +1 -3
- package/lib/utils/attach.d.ts +3 -5
- package/lib/{before-render.d.ts → utils/before-render.d.ts} +1 -1
- package/lib/utils/is.d.ts +13 -14
- package/lib/utils/make.d.ts +7 -13
- package/lib/utils/non-nullish.d.ts +4 -0
- package/lib/utils/object-events.d.ts +34 -0
- package/lib/utils/parameters.d.ts +20 -0
- package/lib/utils/resolve-ref.d.ts +2 -0
- package/lib/utils/signal-store.d.ts +13 -4
- package/lib/utils/update.d.ts +1 -1
- package/metadata.json +1 -1
- package/package.json +40 -24
- package/plugin/generators.json +8 -30
- package/plugin/package.json +3 -22
- package/plugin/src/generators/add-soba/compat.js.map +1 -0
- package/plugin/src/generators/add-soba/generator.d.ts +3 -0
- package/plugin/src/generators/add-soba/generator.js +78 -0
- package/plugin/src/generators/add-soba/generator.js.map +1 -0
- package/plugin/src/generators/add-soba/schema.json +4 -0
- package/plugin/src/generators/init/compat.d.ts +1 -3
- package/plugin/src/generators/init/files/experience/experience.component.ts__tmpl__ +18 -7
- package/plugin/src/generators/init/generator.d.ts +5 -5
- package/plugin/src/generators/init/generator.js +100 -106
- package/plugin/src/generators/init/generator.js.map +1 -1
- package/plugin/src/generators/init/schema.json +8 -12
- package/plugin/src/generators/utils.js +4 -3
- package/plugin/src/generators/utils.js.map +1 -1
- package/plugin/src/generators/version.d.ts +17 -0
- package/plugin/src/generators/version.js +21 -0
- package/plugin/src/generators/version.js.map +1 -0
- package/plugin/src/index.d.ts +0 -3
- package/plugin/src/index.js +0 -9
- package/plugin/src/index.js.map +1 -1
- package/testing/README.md +3 -0
- package/testing/index.d.ts +2 -0
- package/testing/lib/test-bed.d.ts +38 -0
- package/testing/lib/test-canvas.d.ts +11 -0
- package/testing/lib/utils/mock-canvas.d.ts +5 -0
- package/testing/lib/utils/web-gl-rendering-context.d.ts +16 -0
- package/testing/package.json +3 -0
- package/web-types.json +1 -1
- package/esm2022/lib/before-render.mjs +0 -13
- package/esm2022/lib/directives/common.mjs +0 -41
- package/esm2022/lib/directives/key.mjs +0 -29
- package/esm2022/lib/directives/parent.mjs +0 -35
- package/esm2022/lib/ref.mjs +0 -48
- package/esm2022/lib/renderer/store.mjs +0 -408
- package/esm2022/lib/utils/safe-detect-changes.mjs +0 -17
- package/lib/directives/common.d.ts +0 -15
- package/lib/directives/key.d.ts +0 -10
- package/lib/directives/parent.d.ts +0 -11
- package/lib/ref.d.ts +0 -8
- package/lib/renderer/store.d.ts +0 -67
- package/lib/utils/safe-detect-changes.d.ts +0 -2
- package/plugin/migrations.json +0 -16
- package/plugin/src/generators/init/files/experience/experience.component.html__tmpl__ +0 -4
- package/plugin/src/generators/init-cannon/compat.js.map +0 -1
- package/plugin/src/generators/init-cannon/generator.d.ts +0 -2
- package/plugin/src/generators/init-cannon/generator.js +0 -23
- package/plugin/src/generators/init-cannon/generator.js.map +0 -1
- package/plugin/src/generators/init-cannon/schema.json +0 -6
- package/plugin/src/generators/init-postprocessing/compat.d.ts +0 -2
- package/plugin/src/generators/init-postprocessing/compat.js +0 -6
- package/plugin/src/generators/init-postprocessing/compat.js.map +0 -1
- package/plugin/src/generators/init-postprocessing/generator.d.ts +0 -2
- package/plugin/src/generators/init-postprocessing/generator.js +0 -21
- package/plugin/src/generators/init-postprocessing/generator.js.map +0 -1
- package/plugin/src/generators/init-postprocessing/schema.json +0 -6
- package/plugin/src/generators/init-soba/compat.d.ts +0 -2
- package/plugin/src/generators/init-soba/compat.js +0 -6
- package/plugin/src/generators/init-soba/compat.js.map +0 -1
- package/plugin/src/generators/init-soba/generator.d.ts +0 -2
- package/plugin/src/generators/init-soba/generator.js +0 -27
- package/plugin/src/generators/init-soba/generator.js.map +0 -1
- package/plugin/src/generators/init-soba/schema.json +0 -6
- package/plugin/src/generators/versions.d.ts +0 -13
- package/plugin/src/generators/versions.js +0 -17
- package/plugin/src/generators/versions.js.map +0 -1
- package/plugin/src/migrations/migrate-to-ngxtension/compat.d.ts +0 -2
- package/plugin/src/migrations/migrate-to-ngxtension/compat.js +0 -6
- package/plugin/src/migrations/migrate-to-ngxtension/compat.js.map +0 -1
- package/plugin/src/migrations/migrate-to-ngxtension/migrate-to-ngxtension.d.ts +0 -2
- package/plugin/src/migrations/migrate-to-ngxtension/migrate-to-ngxtension.js +0 -41
- package/plugin/src/migrations/migrate-to-ngxtension/migrate-to-ngxtension.js.map +0 -1
- /package/plugin/src/generators/{init-cannon → add-soba}/compat.d.ts +0 -0
- /package/plugin/src/generators/{init-cannon → add-soba}/compat.js +0 -0
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,289 @@ 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 type NgtAttachable<TChild = any, TParent = any> = NgtAttachFunction<TChild, TParent> | string | string[];
|
|
148
|
+
export interface NgtAfterAttach<TChild extends NgtInstanceNode = NgtInstanceNode, TParent extends NgtInstanceNode = NgtInstanceNode> {
|
|
149
|
+
parent: TParent;
|
|
150
|
+
node: TChild;
|
|
151
|
+
}
|
|
152
|
+
export interface NgtLocalInstanceState {
|
|
153
|
+
objects: NgtInstanceNode[];
|
|
154
|
+
nonObjects: NgtInstanceNode[];
|
|
155
|
+
parent: NgtInstanceNode | null;
|
|
156
|
+
}
|
|
157
|
+
export interface NgtLocalState {
|
|
158
|
+
/** the store of the canvas that the instance is being rendered to */
|
|
159
|
+
store: NgtSignalStore<NgtState>;
|
|
160
|
+
instanceStore: NgtSignalStore<NgtLocalInstanceState>;
|
|
161
|
+
parent: Signal<NgtLocalInstanceState['parent']>;
|
|
162
|
+
objects: Signal<NgtLocalInstanceState['objects']>;
|
|
163
|
+
nonObjects: Signal<NgtLocalInstanceState['nonObjects']>;
|
|
164
|
+
add: (instance: NgtInstanceNode, type: 'objects' | 'nonObjects') => void;
|
|
165
|
+
remove: (instance: NgtInstanceNode, type: 'objects' | 'nonObjects') => void;
|
|
166
|
+
setParent: (parent: NgtInstanceNode | null) => void;
|
|
167
|
+
primitive?: boolean;
|
|
168
|
+
eventCount: number;
|
|
169
|
+
handlers: Partial<NgtEventHandlers>;
|
|
170
|
+
attach?: string[] | NgtAttachFunction;
|
|
171
|
+
previousAttach?: unknown | (() => void);
|
|
172
|
+
isRaw?: boolean;
|
|
173
|
+
priority?: number;
|
|
174
|
+
onUpdate?: (node: NgtInstanceNode) => void;
|
|
175
|
+
onAttach?: (afterAttach: NgtAfterAttach) => void;
|
|
176
|
+
}
|
|
177
|
+
export type NgtInstanceNode<TNode = any> = {
|
|
178
|
+
__ngt__: NgtLocalState;
|
|
179
|
+
} & NgtAnyRecord & TNode;
|
|
180
|
+
export type NgtCanvasElement = HTMLCanvasElement | OffscreenCanvas;
|
|
181
|
+
export type NgtGlobalRenderCallback = (timeStamp: number) => void;
|
|
182
|
+
export type NgtRendererLike = {
|
|
183
|
+
render: (scene: Scene, camera: Camera) => any;
|
|
184
|
+
};
|
|
185
|
+
export type NgtCameraManual = NgtCamera & {
|
|
186
|
+
manual?: boolean;
|
|
187
|
+
};
|
|
188
|
+
export type NgtDpr = number | [min: number, max: number];
|
|
189
|
+
export type NgtSize = {
|
|
190
|
+
width: number;
|
|
191
|
+
height: number;
|
|
192
|
+
top: number;
|
|
193
|
+
left: number;
|
|
194
|
+
};
|
|
195
|
+
export type NgtViewport = NgtSize & {
|
|
196
|
+
/** The initial pixel ratio */
|
|
197
|
+
initialDpr: number;
|
|
198
|
+
/** Current pixel ratio */
|
|
199
|
+
dpr: number;
|
|
200
|
+
/** size.width / viewport.width */
|
|
201
|
+
factor: number;
|
|
202
|
+
/** Camera distance */
|
|
203
|
+
distance: number;
|
|
204
|
+
/** Camera aspect ratio: width / height */
|
|
205
|
+
aspect: number;
|
|
206
|
+
};
|
|
207
|
+
export type NgtPerformance = {
|
|
208
|
+
/** Current performance normal, between min and max */
|
|
209
|
+
current: number;
|
|
210
|
+
/** How low the performance can go, between 0 and max */
|
|
211
|
+
min: number;
|
|
212
|
+
/** How high the performance can go, between min and max */
|
|
213
|
+
max: number;
|
|
214
|
+
/** Time until current returns to max in ms */
|
|
215
|
+
debounce: number;
|
|
216
|
+
/** Sets current to min, puts the system in regression */
|
|
217
|
+
regress: () => void;
|
|
218
|
+
};
|
|
219
|
+
export type NgtRenderState = NgtState & {
|
|
220
|
+
delta: number;
|
|
221
|
+
frame?: XRFrame;
|
|
222
|
+
};
|
|
223
|
+
export type NgtBeforeRenderEvent<TObject extends NgtInstanceNode = NgtInstanceNode> = {
|
|
224
|
+
state: NgtRenderState;
|
|
225
|
+
object: TObject;
|
|
226
|
+
};
|
|
227
|
+
export type NgtBeforeRenderRecord = {
|
|
228
|
+
callback: (state: NgtRenderState) => void;
|
|
229
|
+
store: NgtSignalStore<NgtState>;
|
|
230
|
+
priority?: number;
|
|
231
|
+
};
|
|
232
|
+
export type NgtInternalState = {
|
|
233
|
+
active: boolean;
|
|
234
|
+
priority: number;
|
|
235
|
+
frames: number;
|
|
236
|
+
lastEvent: ElementRef<NgtDomEvent | null>;
|
|
237
|
+
interaction: Object3D[];
|
|
238
|
+
hovered: Map<string, NgtThreeEvent<NgtDomEvent>>;
|
|
239
|
+
capturedMap: Map<number, Map<Object3D, NgtPointerCaptureTarget>>;
|
|
240
|
+
initialClick: [x: number, y: number];
|
|
241
|
+
initialHits: Object3D[];
|
|
242
|
+
subscribers: NgtBeforeRenderRecord[];
|
|
243
|
+
subscribe: (callback: NgtBeforeRenderRecord['callback'], priority?: number, store?: NgtSignalStore<NgtState>) => () => void;
|
|
244
|
+
};
|
|
245
|
+
export type NgtState = {
|
|
246
|
+
/** The instance of the renderer */
|
|
247
|
+
gl: WebGLRenderer;
|
|
248
|
+
/** Default camera */
|
|
249
|
+
camera: NgtCameraManual;
|
|
250
|
+
/** Default scene */
|
|
251
|
+
scene: Scene;
|
|
252
|
+
/** Default raycaster */
|
|
253
|
+
raycaster: Raycaster;
|
|
254
|
+
/** Default clock */
|
|
255
|
+
clock: Clock;
|
|
256
|
+
/** Event layer interface, contains the event handler and the node they're connected to */
|
|
257
|
+
events: NgtEventManager<any>;
|
|
258
|
+
/** XR interface */
|
|
259
|
+
xr: {
|
|
260
|
+
connect: () => void;
|
|
261
|
+
disconnect: () => void;
|
|
262
|
+
};
|
|
263
|
+
/** Currently used controls */
|
|
264
|
+
controls: EventDispatcher | null;
|
|
265
|
+
/** Normalized event coordinates */
|
|
266
|
+
pointer: Vector2;
|
|
267
|
+
legacy: boolean;
|
|
268
|
+
/** Shortcut to gl.outputColorSpace = LinearSRGBColorSpace */
|
|
269
|
+
linear: boolean;
|
|
270
|
+
/** Shortcut to gl.toneMapping = NoTonemapping */
|
|
271
|
+
flat: boolean;
|
|
272
|
+
/** Render loop flags */
|
|
273
|
+
frameloop: 'always' | 'demand' | 'never';
|
|
274
|
+
/** Adaptive performance interface */
|
|
275
|
+
performance: NgtPerformance;
|
|
276
|
+
/** Reactive pixel-size of the canvas */
|
|
277
|
+
size: NgtSize;
|
|
278
|
+
/** Reactive size of the viewport in threejs units */
|
|
279
|
+
viewport: NgtViewport & {
|
|
280
|
+
getCurrentViewport: (camera?: NgtCamera, target?: Vector3 | Parameters<Vector3['set']>, size?: NgtSize) => Omit<NgtViewport, 'dpr' | 'initialDpr'>;
|
|
281
|
+
};
|
|
282
|
+
/** Flags the canvas for render, but doesn't render in itself */
|
|
283
|
+
invalidate: (frames?: number) => void;
|
|
284
|
+
/** Advance (render) one step */
|
|
285
|
+
advance: (timestamp: number, runGlobalEffects?: boolean) => void;
|
|
286
|
+
/** Shortcut to setting the event layer */
|
|
287
|
+
setEvents: (events: Partial<NgtEventManager<any>>) => void;
|
|
288
|
+
/**
|
|
289
|
+
* Shortcut to manual sizing
|
|
290
|
+
*/
|
|
291
|
+
setSize: (width: number, height: number, top?: number, left?: number) => void;
|
|
292
|
+
/** Shortcut to manual setting the pixel ratio */
|
|
293
|
+
setDpr: (dpr: NgtDpr) => void;
|
|
294
|
+
/** Shortcut to frameloop flags */
|
|
295
|
+
setFrameloop: (frameloop?: 'always' | 'demand' | 'never') => void;
|
|
296
|
+
/** When the canvas was clicked but nothing was hit */
|
|
297
|
+
/** PointerMissed Observable */
|
|
298
|
+
pointerMissed$: Observable<MouseEvent>;
|
|
299
|
+
/** If this state model is layered (via createPortal) then this contains the previous layer */
|
|
300
|
+
previousRoot: NgtSignalStore<NgtState> | null;
|
|
301
|
+
/** Internals */
|
|
302
|
+
internal: NgtInternalState;
|
|
303
|
+
};
|
|
@@ -1,4 +1,2 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import type { NgtAnyRecord } from '../types';
|
|
3
|
-
export declare function diffProps(instance: NgtAnyRecord, props: NgtAnyRecord): [key: string, value: unknown][];
|
|
1
|
+
import { NgtAnyRecord, NgtInstanceNode } from '../types';
|
|
4
2
|
export declare function applyProps(instance: NgtInstanceNode, props: NgtAnyRecord): any;
|
package/lib/utils/attach.d.ts
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import
|
|
3
|
-
|
|
4
|
-
import type { NgtSignalStore } from './signal-store';
|
|
5
|
-
export declare function attach(object: NgtAnyRecord, value: unknown, paths?: string[]): void;
|
|
1
|
+
import { NgtAnyRecord, NgtAttachFunction, NgtState } from '../types';
|
|
2
|
+
import { NgtSignalStore } from './signal-store';
|
|
3
|
+
export declare function attach(object: NgtAnyRecord, value: unknown, paths?: string[], useApplyProps?: boolean): void;
|
|
6
4
|
export declare function detach(parent: NgtAnyRecord, child: NgtAnyRecord, attachProp: string[] | NgtAttachFunction): void;
|
|
7
5
|
export declare function createAttachFunction<TChild = any, TParent = any>(cb: (params: {
|
|
8
6
|
parent: TParent;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Injector } from '@angular/core';
|
|
2
|
-
import {
|
|
2
|
+
import { NgtBeforeRenderRecord } from '../types';
|
|
3
3
|
export declare function injectBeforeRender(cb: NgtBeforeRenderRecord['callback'], { priority, injector }?: {
|
|
4
4
|
priority?: number;
|
|
5
5
|
injector?: Injector;
|
package/lib/utils/is.d.ts
CHANGED
|
@@ -1,20 +1,19 @@
|
|
|
1
1
|
import { ElementRef } from '@angular/core';
|
|
2
|
-
import
|
|
3
|
-
import
|
|
4
|
-
import type { NgtEquConfig } from '../types';
|
|
2
|
+
import { BufferGeometry, Camera, Material, Object3D, OrthographicCamera, PerspectiveCamera, Scene, Texture } from 'three';
|
|
3
|
+
import { NgtEquConfig, NgtInstanceNode, NgtRendererLike } from '../types';
|
|
5
4
|
export declare const is: {
|
|
6
5
|
obj: (a: unknown) => a is object;
|
|
7
|
-
material: (a: unknown) => a is
|
|
8
|
-
geometry: (a: unknown) => a is
|
|
9
|
-
orthographicCamera: (a: unknown) => a is
|
|
10
|
-
perspectiveCamera: (a: unknown) => a is
|
|
11
|
-
camera: (a: unknown) => a is
|
|
12
|
-
renderer: (a: unknown) =>
|
|
13
|
-
scene: (a: unknown) => a is
|
|
14
|
-
|
|
15
|
-
instance: (a: unknown) => a is
|
|
16
|
-
|
|
17
|
-
colorSpaceExist: <T extends
|
|
6
|
+
material: (a: unknown) => a is Material;
|
|
7
|
+
geometry: (a: unknown) => a is BufferGeometry;
|
|
8
|
+
orthographicCamera: (a: unknown) => a is OrthographicCamera;
|
|
9
|
+
perspectiveCamera: (a: unknown) => a is PerspectiveCamera;
|
|
10
|
+
camera: (a: unknown) => a is Camera;
|
|
11
|
+
renderer: (a: unknown) => boolean;
|
|
12
|
+
scene: (a: unknown) => a is Scene;
|
|
13
|
+
ref: (a: unknown) => a is ElementRef;
|
|
14
|
+
instance: (a: unknown) => a is NgtInstanceNode;
|
|
15
|
+
object3D: (a: unknown) => a is Object3D;
|
|
16
|
+
colorSpaceExist: <T extends NgtRendererLike | Texture | object, P = T extends NgtRendererLike ? {
|
|
18
17
|
outputColorSpace: string;
|
|
19
18
|
} : {
|
|
20
19
|
colorSpace: string;
|
package/lib/utils/make.d.ts
CHANGED
|
@@ -1,18 +1,12 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
3
|
-
import type { NgtIntersection } from '../events';
|
|
4
|
-
import type { NgtDpr, NgtSize } from '../store';
|
|
1
|
+
import { Material, Object3D, OrthographicCamera, PerspectiveCamera, WebGLRenderer } from 'three';
|
|
2
|
+
import { NgtCanvasElement, NgtDpr, NgtGLOptions, NgtIntersection, NgtSize } from '../types';
|
|
5
3
|
export declare function makeId(event?: NgtIntersection): string;
|
|
6
4
|
export declare function makeDpr(dpr: NgtDpr, window?: Window): number;
|
|
7
|
-
export declare function
|
|
8
|
-
export declare function
|
|
5
|
+
export declare function makeRendererInstance<TCanvas extends NgtCanvasElement>(glOptions: NgtGLOptions, canvas: TCanvas): WebGLRenderer;
|
|
6
|
+
export declare function makeCameraInstance(isOrthographic: boolean, size: NgtSize): PerspectiveCamera | OrthographicCamera;
|
|
9
7
|
export type NgtObjectMap = {
|
|
10
|
-
nodes:
|
|
11
|
-
|
|
12
|
-
};
|
|
13
|
-
materials: {
|
|
14
|
-
[name: string]: THREE.Material;
|
|
15
|
-
};
|
|
8
|
+
nodes: Record<string, Object3D<any>>;
|
|
9
|
+
materials: Record<string, Material>;
|
|
16
10
|
[key: string]: any;
|
|
17
11
|
};
|
|
18
|
-
export declare function makeObjectGraph(object:
|
|
12
|
+
export declare function makeObjectGraph(object: Object3D): NgtObjectMap;
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { ElementRef, Injector } from '@angular/core';
|
|
2
|
+
import { Object3D } from 'three';
|
|
3
|
+
import { supportedEvents } from '../dom/events';
|
|
4
|
+
import { NgtDomEvent, NgtThreeEvent } from '../types';
|
|
5
|
+
import * as i0 from "@angular/core";
|
|
6
|
+
export declare class NgtObjectEvents {
|
|
7
|
+
click: import("@angular/core").OutputEmitterRef<NgtThreeEvent<MouseEvent>>;
|
|
8
|
+
dblclick: import("@angular/core").OutputEmitterRef<NgtThreeEvent<MouseEvent>>;
|
|
9
|
+
contextmenu: import("@angular/core").OutputEmitterRef<NgtThreeEvent<MouseEvent>>;
|
|
10
|
+
pointerup: import("@angular/core").OutputEmitterRef<NgtThreeEvent<PointerEvent>>;
|
|
11
|
+
pointerdown: import("@angular/core").OutputEmitterRef<NgtThreeEvent<PointerEvent>>;
|
|
12
|
+
pointerover: import("@angular/core").OutputEmitterRef<NgtThreeEvent<PointerEvent>>;
|
|
13
|
+
pointerout: import("@angular/core").OutputEmitterRef<NgtThreeEvent<PointerEvent>>;
|
|
14
|
+
pointerenter: import("@angular/core").OutputEmitterRef<NgtThreeEvent<PointerEvent>>;
|
|
15
|
+
pointerleave: import("@angular/core").OutputEmitterRef<NgtThreeEvent<PointerEvent>>;
|
|
16
|
+
pointermove: import("@angular/core").OutputEmitterRef<NgtThreeEvent<PointerEvent>>;
|
|
17
|
+
pointermissed: import("@angular/core").OutputEmitterRef<NgtThreeEvent<MouseEvent>>;
|
|
18
|
+
pointercancel: import("@angular/core").OutputEmitterRef<NgtThreeEvent<PointerEvent>>;
|
|
19
|
+
wheel: import("@angular/core").OutputEmitterRef<NgtThreeEvent<WheelEvent>>;
|
|
20
|
+
ngtObjectEvents: import("@angular/core").ModelSignal<Object3D<import("three").Object3DEventMap> | ElementRef<Object3D<import("three").Object3DEventMap>> | null | undefined>;
|
|
21
|
+
constructor();
|
|
22
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<NgtObjectEvents, never>;
|
|
23
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<NgtObjectEvents, "[ngtObjectEvents]", never, { "ngtObjectEvents": { "alias": "ngtObjectEvents"; "required": false; "isSignal": true; }; }, { "click": "click"; "dblclick": "dblclick"; "contextmenu": "contextmenu"; "pointerup": "pointerup"; "pointerdown": "pointerdown"; "pointerover": "pointerover"; "pointerout": "pointerout"; "pointerenter": "pointerenter"; "pointerleave": "pointerleave"; "pointermove": "pointermove"; "pointermissed": "pointermissed"; "pointercancel": "pointercancel"; "wheel": "wheel"; "ngtObjectEvents": "ngtObjectEventsChange"; }, never, never, true, never>;
|
|
24
|
+
}
|
|
25
|
+
export declare const NgtObjectEventsHostDirective: {
|
|
26
|
+
directive: typeof NgtObjectEvents;
|
|
27
|
+
inputs: string[];
|
|
28
|
+
outputs: string[];
|
|
29
|
+
};
|
|
30
|
+
export declare function injectObjectEvents(target: () => ElementRef<Object3D> | Object3D | null | undefined, events: {
|
|
31
|
+
[K in (typeof supportedEvents)[number]]?: (event: NgtThreeEvent<NgtDomEvent>) => void;
|
|
32
|
+
}, { injector }?: {
|
|
33
|
+
injector?: Injector;
|
|
34
|
+
}): (() => void)[];
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { Signal } from '@angular/core';
|
|
2
|
+
import { Vector2, Vector3, Vector4 } from 'three';
|
|
3
|
+
import { NgtVector2, NgtVector3, NgtVector4 } from '../three-types';
|
|
4
|
+
type KeysOfType<TObject extends object, TType> = Exclude<{
|
|
5
|
+
[K in keyof TObject]: TObject[K] extends TType | undefined | null ? K : never;
|
|
6
|
+
}[keyof TObject], undefined>;
|
|
7
|
+
export declare function omit<TObject extends object, TKeys extends (keyof TObject)[]>(objFn: () => TObject, keysToOmit: TKeys): Signal<Omit<TObject, TKeys[number]>>;
|
|
8
|
+
export declare function pick<TObject extends object, TKey extends keyof TObject>(objFn: () => TObject, key: TKey): Signal<TObject[TKey]>;
|
|
9
|
+
export declare function pick<TObject extends object, TKeys extends (keyof TObject)[]>(objFn: () => TObject, keys: TKeys): Signal<Pick<TObject, TKeys[number]>>;
|
|
10
|
+
export declare function merge<TObject extends object>(objFn: () => TObject, toMerge: Partial<TObject>, mode?: 'override' | 'backfill'): Signal<TObject & Partial<TObject>>;
|
|
11
|
+
type NgtVectorComputed<TVector extends Vector2 | Vector3 | Vector4, TNgtVector = TVector extends Vector2 ? NgtVector2 : TVector extends Vector3 ? NgtVector3 : NgtVector4> = {
|
|
12
|
+
(input: Signal<TNgtVector>): Signal<TVector>;
|
|
13
|
+
(input: Signal<TNgtVector>, keepUndefined: true): Signal<TVector | undefined>;
|
|
14
|
+
<TObject extends object>(options: Signal<TObject>, key: KeysOfType<TObject, TNgtVector>): Signal<TVector>;
|
|
15
|
+
<TObject extends object>(options: Signal<TObject>, key: KeysOfType<TObject, TNgtVector>, keepUndefined: true): Signal<TVector | undefined>;
|
|
16
|
+
};
|
|
17
|
+
export declare const vector2: NgtVectorComputed<Vector2, NgtVector2>;
|
|
18
|
+
export declare const vector3: NgtVectorComputed<Vector3, NgtVector3>;
|
|
19
|
+
export declare const vector4: NgtVectorComputed<Vector4, NgtVector4>;
|
|
20
|
+
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CreateComputedOptions, CreateSignalOptions, Signal } from '@angular/core';
|
|
2
2
|
export type NgtSignalStore<State extends object> = {
|
|
3
3
|
select<Key1 extends keyof State, Key2 extends keyof State[Key1], Key3 extends keyof State[Key1][Key2], Key4 extends keyof State[Key1][Key2][Key3]>(key1: Key1, key2: Key2, key3: Key3, key4: Key4, options?: CreateComputedOptions<State[Key1][Key2][Key3][Key4]>): Signal<State[Key1][Key2][Key3][Key4]>;
|
|
4
4
|
select<Key1 extends keyof State, Key2 extends keyof State[Key1], Key3 extends keyof State[Key1][Key2]>(key1: Key1, key2: Key2, key3: Key3, options?: CreateComputedOptions<State[Key1][Key2][Key3]>): Signal<State[Key1][Key2][Key3]>;
|
|
@@ -10,8 +10,17 @@ export type NgtSignalStore<State extends object> = {
|
|
|
10
10
|
get<Key1 extends keyof State, Key2 extends keyof State[Key1]>(key1: Key1, key2: Key2): State[Key1][Key2];
|
|
11
11
|
get<Key extends keyof State>(key: Key): State[Key];
|
|
12
12
|
get(): State;
|
|
13
|
-
|
|
14
|
-
|
|
13
|
+
/**
|
|
14
|
+
* New state takes precedence
|
|
15
|
+
*/
|
|
16
|
+
update(state: Partial<State> | ((previous: State) => Partial<State>)): void;
|
|
17
|
+
/**
|
|
18
|
+
* Equivalence to select()
|
|
19
|
+
*/
|
|
15
20
|
state: Signal<State>;
|
|
21
|
+
/**
|
|
22
|
+
* Equivalence to get()
|
|
23
|
+
*/
|
|
24
|
+
get snapshot(): State;
|
|
16
25
|
};
|
|
17
|
-
export declare function signalStore<State extends object>(initialState?: Partial<State> | ((storeApi: Pick<NgtSignalStore<State>, 'get' | '
|
|
26
|
+
export declare function signalStore<State extends object>(initialState?: Partial<State> | ((storeApi: Pick<NgtSignalStore<State>, 'get' | 'update' | 'select'>) => Partial<State>), options?: CreateSignalOptions<State>): NgtSignalStore<State>;
|
package/lib/utils/update.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { NgtCameraManual, NgtSize } from '../types';
|
|
2
2
|
export declare function checkNeedsUpdate(value: unknown): void;
|
|
3
3
|
export declare function checkUpdate(value: unknown): void;
|
|
4
4
|
export declare function updateCamera(camera: NgtCameraManual, size: NgtSize): void;
|