@tresjs/core 4.1.0-next.0 → 4.1.0

package/README.md

@@ -92,4 +92,8 @@ pnpm run docs:build
 
 ## Sponsors
 
-Be the first to support this project [here](https://github.com/sponsors/alvarosabu) ☺️
+<p align="center">
+  <a target="_blank" href="https://github.com/sponsors/tresjs">
+    <img alt="sponsors" src="./sponsorkit/sponsors.png">
+  </a>
+</p>

package/dist/src/components/TresCanvas.vue.d.ts

@@ -37,6 +37,7 @@ declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<__
     render: (...args: any[]) => void;
     click: (...args: any[]) => void;
     wheel: (...args: any[]) => void;
+    ready: (...args: any[]) => void;
     "double-click": (...args: any[]) => void;
     "context-menu": (...args: any[]) => void;
     "pointer-move": (...args: any[]) => void;
@@ -64,6 +65,7 @@ declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<__
     onClick?: ((...args: any[]) => any) | undefined;
     onWheel?: ((...args: any[]) => any) | undefined;
     onRender?: ((...args: any[]) => any) | undefined;
+    onReady?: ((...args: any[]) => any) | undefined;
     "onDouble-click"?: ((...args: any[]) => any) | undefined;
     "onContext-menu"?: ((...args: any[]) => any) | undefined;
     "onPointer-move"?: ((...args: any[]) => any) | undefined;

package/dist/src/composables/index.d.ts

@@ -10,3 +10,4 @@ export * from './usePointerEventHandler';
 export * from './useTresContextProvider';
 export * from './useLoop';
 export * from './useTresEventManager';
+export { onTresReady } from './useTresReady';

package/dist/src/composables/useCamera/index.d.ts

@@ -4400,7 +4400,7 @@ export declare const useCamera: ({ sizes }: Pick<TresContext, 'sizes'> & {
         };
         dispatchEvent: <T_13 extends keyof import('three').Object3DEventMap>(event: import('three').BaseEvent<T_13> & import('three').Object3DEventMap[T_13]) => void;
     }[]>;
-    registerCamera: (newCamera: Camera, active?: boolean) => void;
-    deregisterCamera: (camera: Camera) => void;
+    registerCamera: (maybeCamera: unknown, active?: boolean) => void;
+    deregisterCamera: (maybeCamera: unknown) => void;
     setCameraActive: (cameraOrUuid: string | Camera) => void;
 };

package/dist/src/composables/useRaycaster/index.d.ts

@@ -3,7 +3,7 @@ import { Ref, ShallowRef } from 'vue';
 import { TresEvent } from 'src/types';
 import { TresContext } from '../useTresContextProvider';
 
-export declare const useRaycaster: (objects: Ref<Object3D[]>, ctx: TresContext) => {
+export declare const useRaycaster: (objectsWithEvents: Ref<Object3D[]>, ctx: TresContext) => {
     intersects: ShallowRef<Intersection<Object3D<import('three').Object3DEventMap>>[]>;
     onClick: (fn: (value: TresEvent) => void) => () => void;
     onDblClick: (fn: (value: TresEvent) => void) => () => void;

package/dist/src/composables/useTresContextProvider/index.d.ts

@@ -58,9 +58,9 @@ export interface TresContext {
      * Advance one frame when renderMode === 'manual'
      */
     advance: () => void;
-    registerCamera: (camera: Camera) => void;
+    registerCamera: (maybeCamera: unknown) => void;
     setCameraActive: (cameraOrUuid: Camera | string) => void;
-    deregisterCamera: (camera: Camera) => void;
+    deregisterCamera: (maybeCamera: unknown) => void;
     eventManager?: TresEventManager;
     registerObjectAtPointerEventHandler?: (object: TresObject & EventProps) => void;
     deregisterObjectAtPointerEventHandler?: (object: TresObject) => void;

package/dist/src/composables/useTresEventManager/index.d.ts

@@ -1,5 +1,5 @@
 import { Scene } from 'three';
-import { EmitEventFn, TresObject } from 'src/types';
+import { EmitEventFn } from 'src/types';
 import { TresContext } from '../useTresContextProvider';
 
 export interface TresEventManager {
@@ -12,11 +12,11 @@ export interface TresEventManager {
      * So we need to track them separately
      * Note: These are used in nodeOps
      */
-    registerPointerMissedObject: (object: TresObject) => void;
-    deregisterPointerMissedObject: (object: TresObject) => void;
+    registerPointerMissedObject: (object: unknown) => void;
+    deregisterPointerMissedObject: (object: unknown) => void;
 }
 export declare function useTresEventManager(scene: Scene, context: TresContext, emit: EmitEventFn): {
     forceUpdate: () => void;
-    registerPointerMissedObject: (object: TresObject) => void;
-    deregisterPointerMissedObject: (object: TresObject) => void;
+    registerPointerMissedObject: (maybeTresObject: unknown) => void;
+    deregisterPointerMissedObject: (maybeTresObject: unknown) => void;
 };

package/dist/src/composables/useTresReady/createReadyEventHook/index.d.ts

@@ -0,0 +1,5 @@
+import { EventHook } from '@vueuse/core';
+
+export declare function createReadyEventHook<T>(getIsReady: () => boolean, triggerParams: T, pollIntervalMs?: number): EventHook<T> & {
+    cancel: () => void;
+};

package/dist/src/composables/useTresReady/index.d.ts

@@ -0,0 +1,8 @@
+import { TresContext } from '../useTresContextProvider';
+
+export declare function useTresReady(ctx?: TresContext): import('@vueuse/core').EventHook<TresContext> & {
+    cancel: () => void;
+};
+export declare function onTresReady(fn: (ctx: TresContext) => void): {
+    off: () => void;
+} | undefined;

package/dist/src/core/loop.d.ts

@@ -34,5 +34,6 @@ export interface RendererLoop {
     isActive: Ref<boolean>;
     isRenderPaused: Ref<boolean>;
     setContext: (newContext: Record<string, any>) => void;
+    setReady: (isReady: boolean) => void;
 }
 export declare function createRenderLoop(): RendererLoop;

package/dist/src/core/nodeOps.d.ts

@@ -1,5 +1,5 @@
 import { RendererOptions } from 'vue';
+import { TresContext } from '../composables';
 import { TresObject } from '../types';
 
-export declare function invalidateInstance(instance: TresObject): void;
-export declare const nodeOps: () => RendererOptions<TresObject, TresObject | null>;
+export declare const nodeOps: (context: TresContext) => RendererOptions<TresObject, TresObject | null>;

package/dist/src/types/index.d.ts

@@ -17,7 +17,7 @@ export type Args<T> = T extends ConstructorRepresentation ? ConstructorParameter
 export interface TresCatalogue {
     [name: string]: ConstructorRepresentation;
 }
-export type EmitEventName = 'render' | 'click' | 'double-click' | 'context-menu' | 'pointer-move' | 'pointer-up' | 'pointer-down' | 'pointer-enter' | 'pointer-leave' | 'pointer-over' | 'pointer-out' | 'pointer-missed' | 'wheel';
+export type EmitEventName = 'render' | 'ready' | 'click' | 'double-click' | 'context-menu' | 'pointer-move' | 'pointer-up' | 'pointer-down' | 'pointer-enter' | 'pointer-leave' | 'pointer-over' | 'pointer-out' | 'pointer-missed' | 'wheel';
 export type EmitEventFn = (event: EmitEventName, ...args: any[]) => void;
 export type TresCamera = THREE.OrthographicCamera | THREE.PerspectiveCamera;
 export interface InstanceProps<T = any, P = any> {
@@ -36,16 +36,16 @@ interface TresBaseObject {
 }
 export interface LocalState {
     type: string;
-    objects?: TresObject3D[];
-    parent?: TresObject3D | null;
-    primitive?: boolean;
-    eventCount?: number;
-    handlers?: Partial<EventHandlers>;
-    memoizedProps?: {
+    eventCount: number;
+    root: TresContext;
+    handlers: Partial<EventHandlers>;
+    memoizedProps: {
         [key: string]: any;
     };
+    objects: TresObject[];
+    parent: TresObject | null;
+    primitive?: boolean;
     disposable?: boolean;
-    root?: TresContext;
 }
 export interface TresObject3D extends THREE.Object3D<THREE.Object3DEventMap> {
     geometry?: THREE.BufferGeometry & TresBaseObject;
@@ -54,6 +54,9 @@ export interface TresObject3D extends THREE.Object3D<THREE.Object3DEventMap> {
 export type TresObject = TresBaseObject & (TresObject3D | THREE.BufferGeometry | THREE.Material | THREE.Fog) & {
     __tres?: LocalState;
 };
+export type TresInstance = TresObject & {
+    __tres: LocalState;
+};
 export interface TresScene extends THREE.Scene {
     __tres: {
         root: TresContext;

package/dist/src/utils/index.d.ts

@@ -25,3 +25,9 @@ export declare function createHighlightMesh(object: TresObject): Mesh;
 export declare function extractBindingPosition(binding: any): Vector3;
 export declare function disposeMaterial(material: Material): void;
 export declare function disposeObject3D(object: TresObject): void;
+/**
+ * Like Array.filter, but modifies the array in place.
+ * @param array - Array to modify
+ * @param callbackFn - A function called for each element of the array. It should return a truthy value to keep the element in the array.
+ */
+export declare function filterInPlace<T>(array: T[], callbackFn: (element: T, index: number) => unknown): T[];

package/dist/src/utils/is.d.ts

@@ -0,0 +1,12 @@
+import { TresObject } from 'src/types';
+import { BufferGeometry, Camera, Fog, Material, Object3D } from 'three';
+
+export declare function arr(u: unknown): boolean;
+export declare function fun(u: unknown): u is Function;
+export declare function obj(u: unknown): u is Record<string | number | symbol, unknown>;
+export declare function object3D(u: unknown): u is Object3D;
+export declare function camera(u: unknown): u is Camera;
+export declare function bufferGeometry(u: unknown): u is BufferGeometry;
+export declare function material(u: unknown): u is Material;
+export declare function fog(u: unknown): u is Fog;
+export declare function tresObject(u: unknown): u is TresObject;

package/dist/src/utils/nodeOpsUtils.d.ts

@@ -0,0 +1,6 @@
+import { TresContext } from '../composables/useTresContextProvider';
+import { LocalState, TresInstance, TresObject } from '../types';
+
+export declare function prepareTresInstance<T extends TresObject>(obj: T, state: Partial<LocalState>, context: TresContext): TresInstance;
+export declare function invalidateInstance(instance: TresObject): void;
+export declare function noop(fn: string): any;