@tresjs/core 3.6.0-next.0 → 3.6.1

package/README.md

@@ -19,7 +19,7 @@ Tres (Spanish word for "three", pronounced `/tres/` ) is a way of creating Three
 
 It's build on-top of a [Vue Custom Renderer](https://vuejs.org/api/custom-renderer.html#createrenderer) and it's powered by Vite.
 
-The goal is to provide the Vue's community an easy way of building 3D scenes with Vue, always up to date with the latest ThreeJS features and with 0-to-none mantainance.
+The goal is to provide the Vue's community an easy way of building 3D scenes with Vue, always up to date with the latest ThreeJS features and with 0-to-none maintenance.
 
 ## Installation
 
@@ -39,11 +39,11 @@ Checkout the [docs](https://tresjs.org)
 
 | Package                     | Version                                                                                            |
 | --------------------------- | :------------------------------------------------------------------------------------------------- |
-| [Tres](packages/tres)       | ![tres version](https://img.shields.io/npm/v/@tresjs/core/latest.svg?label=%20&color=%2382DBCA)    |
-| [Cientos](packages/cientos) | ![cientos version](https://img.shields.io/npm/v/@tresjs/cientos/latest.svg?label=%20&color=%23f19b00) |
-| [Post-processing](packages/post-processing) | ![post-processing version](https://img.shields.io/npm/v/@tresjs/post-processing/latest.svg?label=%20&color=ff7bac) |
-| [Nuxt](packages/nuxt) | ![nuxt version](https://img.shields.io/npm/v/@tresjs/nuxt/latest.svg?label=%20&color=4f4f4f&logo=nuxt.js) |
-| [TresLeches 🍰](packages/leches) | ![tresleches version](https://img.shields.io/npm/v/@tresjs/leches/latest.svg?label=%20&color=ffffff) |
+| [Tres](https://github.com/TresJS/tres)       | ![tres version](https://img.shields.io/npm/v/@tresjs/core/latest.svg?label=%20&color=%2382DBCA)    |
+| [Cientos](https://github.com/TresJS/cientos) | ![cientos version](https://img.shields.io/npm/v/@tresjs/cientos/latest.svg?label=%20&color=%23f19b00) |
+| [Post-processing](https://github.com/TresJS/post-processing) | ![post-processing version](https://img.shields.io/npm/v/@tresjs/post-processing/latest.svg?label=%20&color=ff7bac) |
+| [Nuxt](https://github.com/TresJS/nuxt) | ![nuxt version](https://img.shields.io/npm/v/@tresjs/nuxt/latest.svg?label=%20&color=4f4f4f&logo=nuxt.js) |
+| [TresLeches 🍰](https://github.com/TresJS/leches) | ![tresleches version](https://img.shields.io/npm/v/@tresjs/leches/latest.svg?label=%20&color=ffffff) |
 
 ## Contribution
 

package/dist/index.d.ts

@@ -1,17 +1,3 @@
-import type { App } from 'vue';
-import { normalizeColor, normalizeVectorFlexibleParam } from './utils/normalize';
-import templateCompilerOptions from './utils/template-compiler-options';
-export * from './composables';
-export * from './core/catalogue';
-export * from './components';
-export * from './types';
-export interface TresOptions {
-    extends?: Record<string, unknown>;
-}
-export interface TresPlugin {
-    [key: string]: any;
-    install: (app: App, options?: TresOptions) => void;
-}
-declare const plugin: TresPlugin;
-export default plugin;
-export { normalizeColor, normalizeVectorFlexibleParam, templateCompilerOptions, };
+export * from './src/index'
+import Tres from './src/index'
+export default Tres

package/dist/{components → src/components}/TresCanvas.vue.d.ts

@@ -1,5 +1,4 @@
 import type { WebGLRendererParameters, ColorSpace, ShadowMapType, ToneMapping } from 'three';
-import type { Ref } from 'vue';
 import { type TresContext } from '../composables';
 import type { RendererPresetsType } from '../composables/useRenderer/const';
 import type { TresCamera } from '../types/';
@@ -29,8 +28,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
     logarithmicDepthBuffer: undefined;
     failIfMajorPerformanceCaveat: undefined;
 }>, {
-    context: Ref<TresContext | null> | import("vue").ShallowRef<TresContext | null>;
-}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<TresCanvasProps>, {
+    context: import("vue").ShallowRef<TresContext | null>;
+    dispose: () => void;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<TresCanvasProps>, {
     alpha: undefined;
     depth: undefined;
     shadows: undefined;
@@ -56,7 +56,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
     disableRender: boolean;
 }, {}>, Readonly<{
     default(): any;
-}>>;
+}> & {
+    default(): any;
+}>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
 type __VLS_TypePropsToRuntimeProps<T> = {

package/dist/{composables → src/composables}/useCamera/index.d.ts

@@ -1052,10 +1052,9 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 clone: () => import("three").AnimationClip;
                 toJSON: (clip: import("three").AnimationClip) => any;
             }[];
-            userData: {
-                [key: string]: any;
-            };
+            userData: Record<string, any>;
             customDepthMaterial?: {
+                readonly isMaterial: true;
                 alphaHash: boolean;
                 alphaTest: number;
                 alphaToCoverage: boolean;
@@ -1240,7 +1239,6 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 stencilFail: import("three").StencilOp;
                 stencilZFail: import("three").StencilOp;
                 stencilZPass: import("three").StencilOp;
-                readonly isMaterial: true;
                 name: string;
                 needsUpdate: boolean;
                 opacity: number;
@@ -1259,12 +1257,12 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 uuid: string;
                 vertexColors: boolean;
                 visible: boolean;
-                userData: any;
+                userData: Record<string, any>;
                 version: number;
                 clone: () => import("three").Material;
                 copy: (material: import("three").Material) => import("three").Material;
                 dispose: () => void;
-                onBeforeCompile: (shader: import("three").Shader, renderer: import("three").WebGLRenderer) => void;
+                onBeforeCompile: (parameters: import("three").WebGLProgramParametersWithUniforms, renderer: import("three").WebGLRenderer) => void;
                 customProgramCacheKey: () => string;
                 setValues: (values: import("three").MaterialParameters) => void;
                 toJSON: (meta?: any) => any;
@@ -1291,6 +1289,7 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 }[T_6]) => void;
             } | undefined;
             customDistanceMaterial?: {
+                readonly isMaterial: true;
                 alphaHash: boolean;
                 alphaTest: number;
                 alphaToCoverage: boolean;
@@ -1475,7 +1474,6 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 stencilFail: import("three").StencilOp;
                 stencilZFail: import("three").StencilOp;
                 stencilZPass: import("three").StencilOp;
-                readonly isMaterial: true;
                 name: string;
                 needsUpdate: boolean;
                 opacity: number;
@@ -1494,12 +1492,12 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 uuid: string;
                 vertexColors: boolean;
                 visible: boolean;
-                userData: any;
+                userData: Record<string, any>;
                 version: number;
                 clone: () => import("three").Material;
                 copy: (material: import("three").Material) => import("three").Material;
                 dispose: () => void;
-                onBeforeCompile: (shader: import("three").Shader, renderer: import("three").WebGLRenderer) => void;
+                onBeforeCompile: (parameters: import("three").WebGLProgramParametersWithUniforms, renderer: import("three").WebGLRenderer) => void;
                 customProgramCacheKey: () => string;
                 setValues: (values: import("three").MaterialParameters) => void;
                 toJSON: (meta?: any) => any;
@@ -1525,6 +1523,8 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                     dispose: {};
                 }[T_6]) => void;
             } | undefined;
+            onBeforeShadow: (renderer: import("three").WebGLRenderer, scene: import("three").Scene, shadowCamera: Camera, geometry: import("three").BufferGeometry<import("three").NormalBufferAttributes>, depthMaterial: import("three").Material, group: import("three").Group<import("three").Object3DEventMap>) => void;
+            onAfterShadow: (renderer: import("three").WebGLRenderer, scene: import("three").Scene, shadowCamera: Camera, geometry: import("three").BufferGeometry<import("three").NormalBufferAttributes>, depthMaterial: import("three").Material, group: import("three").Group<import("three").Object3DEventMap>) => void;
             onBeforeRender: (renderer: import("three").WebGLRenderer, scene: import("three").Scene, camera: Camera, geometry: import("three").BufferGeometry<import("three").NormalBufferAttributes>, material: import("three").Material, group: import("three").Group<import("three").Object3DEventMap>) => void;
             onAfterRender: (renderer: import("three").WebGLRenderer, scene: import("three").Scene, camera: Camera, geometry: import("three").BufferGeometry<import("three").NormalBufferAttributes>, material: import("three").Material, group: import("three").Group<import("three").Object3DEventMap>) => void;
             applyMatrix4: (matrix: import("three").Matrix4) => void;
@@ -1556,7 +1556,7 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
             getObjectById: (id: number) => import("three").Object3D<import("three").Object3DEventMap> | undefined;
             getObjectByName: (name: string) => import("three").Object3D<import("three").Object3DEventMap> | undefined;
             getObjectByProperty: (name: string, value: any) => import("three").Object3D<import("three").Object3DEventMap> | undefined;
-            getObjectsByProperty: (name: string, value: any) => import("three").Object3D<import("three").Object3DEventMap>[];
+            getObjectsByProperty: (name: string, value: any, optionalTarget?: import("three").Object3D<import("three").Object3DEventMap>[] | undefined) => import("three").Object3D<import("three").Object3DEventMap>[];
             getWorldPosition: (target: import("three").Vector3) => import("three").Vector3;
             getWorldQuaternion: (target: import("three").Quaternion) => import("three").Quaternion;
             getWorldScale: (target: import("three").Vector3) => import("three").Vector3;
@@ -2440,10 +2440,9 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 clone: () => import("three").AnimationClip;
                 toJSON: (clip: import("three").AnimationClip) => any;
             }[];
-            userData: {
-                [key: string]: any;
-            };
+            userData: Record<string, any>;
             customDepthMaterial?: {
+                readonly isMaterial: true;
                 alphaHash: boolean;
                 alphaTest: number;
                 alphaToCoverage: boolean;
@@ -2628,7 +2627,6 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 stencilFail: import("three").StencilOp;
                 stencilZFail: import("three").StencilOp;
                 stencilZPass: import("three").StencilOp;
-                readonly isMaterial: true;
                 name: string;
                 needsUpdate: boolean;
                 opacity: number;
@@ -2647,12 +2645,12 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 uuid: string;
                 vertexColors: boolean;
                 visible: boolean;
-                userData: any;
+                userData: Record<string, any>;
                 version: number;
                 clone: () => import("three").Material;
                 copy: (material: import("three").Material) => import("three").Material;
                 dispose: () => void;
-                onBeforeCompile: (shader: import("three").Shader, renderer: import("three").WebGLRenderer) => void;
+                onBeforeCompile: (parameters: import("three").WebGLProgramParametersWithUniforms, renderer: import("three").WebGLRenderer) => void;
                 customProgramCacheKey: () => string;
                 setValues: (values: import("three").MaterialParameters) => void;
                 toJSON: (meta?: any) => any;
@@ -2679,6 +2677,7 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 }[T_6]) => void;
             } | undefined;
             customDistanceMaterial?: {
+                readonly isMaterial: true;
                 alphaHash: boolean;
                 alphaTest: number;
                 alphaToCoverage: boolean;
@@ -2863,7 +2862,6 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 stencilFail: import("three").StencilOp;
                 stencilZFail: import("three").StencilOp;
                 stencilZPass: import("three").StencilOp;
-                readonly isMaterial: true;
                 name: string;
                 needsUpdate: boolean;
                 opacity: number;
@@ -2882,12 +2880,12 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 uuid: string;
                 vertexColors: boolean;
                 visible: boolean;
-                userData: any;
+                userData: Record<string, any>;
                 version: number;
                 clone: () => import("three").Material;
                 copy: (material: import("three").Material) => import("three").Material;
                 dispose: () => void;
-                onBeforeCompile: (shader: import("three").Shader, renderer: import("three").WebGLRenderer) => void;
+                onBeforeCompile: (parameters: import("three").WebGLProgramParametersWithUniforms, renderer: import("three").WebGLRenderer) => void;
                 customProgramCacheKey: () => string;
                 setValues: (values: import("three").MaterialParameters) => void;
                 toJSON: (meta?: any) => any;
@@ -2913,6 +2911,8 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                     dispose: {};
                 }[T_6]) => void;
             } | undefined;
+            onBeforeShadow: (renderer: import("three").WebGLRenderer, scene: import("three").Scene, shadowCamera: Camera, geometry: import("three").BufferGeometry<import("three").NormalBufferAttributes>, depthMaterial: import("three").Material, group: import("three").Group<import("three").Object3DEventMap>) => void;
+            onAfterShadow: (renderer: import("three").WebGLRenderer, scene: import("three").Scene, shadowCamera: Camera, geometry: import("three").BufferGeometry<import("three").NormalBufferAttributes>, depthMaterial: import("three").Material, group: import("three").Group<import("three").Object3DEventMap>) => void;
             onBeforeRender: (renderer: import("three").WebGLRenderer, scene: import("three").Scene, camera: Camera, geometry: import("three").BufferGeometry<import("three").NormalBufferAttributes>, material: import("three").Material, group: import("three").Group<import("three").Object3DEventMap>) => void;
             onAfterRender: (renderer: import("three").WebGLRenderer, scene: import("three").Scene, camera: Camera, geometry: import("three").BufferGeometry<import("three").NormalBufferAttributes>, material: import("three").Material, group: import("three").Group<import("three").Object3DEventMap>) => void;
             applyMatrix4: (matrix: import("three").Matrix4) => void;
@@ -2944,7 +2944,7 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
             getObjectById: (id: number) => import("three").Object3D<import("three").Object3DEventMap> | undefined;
             getObjectByName: (name: string) => import("three").Object3D<import("three").Object3DEventMap> | undefined;
             getObjectByProperty: (name: string, value: any) => import("three").Object3D<import("three").Object3DEventMap> | undefined;
-            getObjectsByProperty: (name: string, value: any) => import("three").Object3D<import("three").Object3DEventMap>[];
+            getObjectsByProperty: (name: string, value: any, optionalTarget?: import("three").Object3D<import("three").Object3DEventMap>[] | undefined) => import("three").Object3D<import("three").Object3DEventMap>[];
             getWorldPosition: (target: import("three").Vector3) => import("three").Vector3;
             getWorldQuaternion: (target: import("three").Quaternion) => import("three").Quaternion;
             getWorldScale: (target: import("three").Vector3) => import("three").Vector3;
@@ -3809,10 +3809,9 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
             clone: () => import("three").AnimationClip;
             toJSON: (clip: import("three").AnimationClip) => any;
         }[];
-        userData: {
-            [key: string]: any;
-        };
+        userData: Record<string, any>;
         customDepthMaterial?: {
+            readonly isMaterial: true;
             alphaHash: boolean;
             alphaTest: number;
             alphaToCoverage: boolean;
@@ -3997,7 +3996,6 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
             stencilFail: import("three").StencilOp;
             stencilZFail: import("three").StencilOp;
             stencilZPass: import("three").StencilOp;
-            readonly isMaterial: true;
             name: string;
             needsUpdate: boolean;
             opacity: number;
@@ -4016,12 +4014,12 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
             uuid: string;
             vertexColors: boolean;
             visible: boolean;
-            userData: any;
+            userData: Record<string, any>;
             version: number;
             clone: () => import("three").Material;
             copy: (material: import("three").Material) => import("three").Material;
             dispose: () => void;
-            onBeforeCompile: (shader: import("three").Shader, renderer: import("three").WebGLRenderer) => void;
+            onBeforeCompile: (parameters: import("three").WebGLProgramParametersWithUniforms, renderer: import("three").WebGLRenderer) => void;
             customProgramCacheKey: () => string;
             setValues: (values: import("three").MaterialParameters) => void;
             toJSON: (meta?: any) => any;
@@ -4048,6 +4046,7 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
             }[T_6]) => void;
         } | undefined;
         customDistanceMaterial?: {
+            readonly isMaterial: true;
             alphaHash: boolean;
             alphaTest: number;
             alphaToCoverage: boolean;
@@ -4232,7 +4231,6 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
             stencilFail: import("three").StencilOp;
             stencilZFail: import("three").StencilOp;
             stencilZPass: import("three").StencilOp;
-            readonly isMaterial: true;
             name: string;
             needsUpdate: boolean;
             opacity: number;
@@ -4251,12 +4249,12 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
             uuid: string;
             vertexColors: boolean;
             visible: boolean;
-            userData: any;
+            userData: Record<string, any>;
             version: number;
             clone: () => import("three").Material;
             copy: (material: import("three").Material) => import("three").Material;
             dispose: () => void;
-            onBeforeCompile: (shader: import("three").Shader, renderer: import("three").WebGLRenderer) => void;
+            onBeforeCompile: (parameters: import("three").WebGLProgramParametersWithUniforms, renderer: import("three").WebGLRenderer) => void;
             customProgramCacheKey: () => string;
             setValues: (values: import("three").MaterialParameters) => void;
             toJSON: (meta?: any) => any;
@@ -4282,6 +4280,8 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 dispose: {};
             }[T_6]) => void;
         } | undefined;
+        onBeforeShadow: (renderer: import("three").WebGLRenderer, scene: import("three").Scene, shadowCamera: Camera, geometry: import("three").BufferGeometry<import("three").NormalBufferAttributes>, depthMaterial: import("three").Material, group: import("three").Group<import("three").Object3DEventMap>) => void;
+        onAfterShadow: (renderer: import("three").WebGLRenderer, scene: import("three").Scene, shadowCamera: Camera, geometry: import("three").BufferGeometry<import("three").NormalBufferAttributes>, depthMaterial: import("three").Material, group: import("three").Group<import("three").Object3DEventMap>) => void;
         onBeforeRender: (renderer: import("three").WebGLRenderer, scene: import("three").Scene, camera: Camera, geometry: import("three").BufferGeometry<import("three").NormalBufferAttributes>, material: import("three").Material, group: import("three").Group<import("three").Object3DEventMap>) => void;
         onAfterRender: (renderer: import("three").WebGLRenderer, scene: import("three").Scene, camera: Camera, geometry: import("three").BufferGeometry<import("three").NormalBufferAttributes>, material: import("three").Material, group: import("three").Group<import("three").Object3DEventMap>) => void;
         applyMatrix4: (matrix: import("three").Matrix4) => void;
@@ -4313,7 +4313,7 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
         getObjectById: (id: number) => import("three").Object3D<import("three").Object3DEventMap> | undefined;
         getObjectByName: (name: string) => import("three").Object3D<import("three").Object3DEventMap> | undefined;
         getObjectByProperty: (name: string, value: any) => import("three").Object3D<import("three").Object3DEventMap> | undefined;
-        getObjectsByProperty: (name: string, value: any) => import("three").Object3D<import("three").Object3DEventMap>[];
+        getObjectsByProperty: (name: string, value: any, optionalTarget?: import("three").Object3D<import("three").Object3DEventMap>[] | undefined) => import("three").Object3D<import("three").Object3DEventMap>[];
         getWorldPosition: (target: import("three").Vector3) => import("three").Vector3;
         getWorldQuaternion: (target: import("three").Quaternion) => import("three").Quaternion;
         getWorldScale: (target: import("three").Vector3) => import("three").Vector3;

package/dist/{composables → src/composables}/useRenderer/index.d.ts

@@ -83,7 +83,7 @@ export declare function useRenderer({ scene, canvas, options, disableRender, con
     contextParts: Pick<TresContext, 'sizes' | 'camera'>;
     disableRender: MaybeRefOrGetter<boolean>;
 }): {
-    renderer: import("vue").Ref<WebGLRenderer> | import("vue").ShallowRef<WebGLRenderer>;
+    renderer: import("vue").ShallowRef<WebGLRenderer>;
 };
 export type UseRendererReturn = ReturnType<typeof useRenderer>;
 export {};

package/dist/src/index.d.ts

@@ -0,0 +1,17 @@
+import type { App } from 'vue';
+import { normalizeColor, normalizeVectorFlexibleParam } from './utils/normalize';
+import templateCompilerOptions from './utils/template-compiler-options';
+export * from './composables';
+export * from './core/catalogue';
+export * from './components';
+export * from './types';
+export interface TresOptions {
+    extends?: Record<string, unknown>;
+}
+export interface TresPlugin {
+    [key: string]: any;
+    install: (app: App, options?: TresOptions) => void;
+}
+declare const plugin: TresPlugin;
+export default plugin;
+export { normalizeColor, normalizeVectorFlexibleParam, templateCompilerOptions, };

package/dist/{types → src/types}/index.d.ts

@@ -107,7 +107,7 @@ export interface EventHandlers {
     onWheel?: (event: ThreeEvent<WheelEvent>) => void;
 }
 interface MathRepresentation {
-    set(...args: number[]): any;
+    set(...args: number[] | [THREE.ColorRepresentation]): any;
 }
 interface VectorRepresentation extends MathRepresentation {
     setScalar(s: number): any;