@tresjs/core 3.6.1 → 3.7.0

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

@@ -30,7 +30,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
 }>, {
     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>, {
+}, 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>, {
     alpha: undefined;
     depth: undefined;
     shadows: undefined;

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

@@ -1054,7 +1054,6 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
             }[];
             userData: Record<string, any>;
             customDepthMaterial?: {
-                readonly isMaterial: true;
                 alphaHash: boolean;
                 alphaTest: number;
                 alphaToCoverage: boolean;
@@ -1239,6 +1238,7 @@ 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;
@@ -1262,7 +1262,7 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 clone: () => import("three").Material;
                 copy: (material: import("three").Material) => import("three").Material;
                 dispose: () => void;
-                onBeforeCompile: (parameters: import("three").WebGLProgramParametersWithUniforms, renderer: import("three").WebGLRenderer) => void;
+                onBeforeCompile: (shader: import("three").Shader, renderer: import("three").WebGLRenderer) => void;
                 customProgramCacheKey: () => string;
                 setValues: (values: import("three").MaterialParameters) => void;
                 toJSON: (meta?: any) => any;
@@ -1289,7 +1289,6 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 }[T_6]) => void;
             } | undefined;
             customDistanceMaterial?: {
-                readonly isMaterial: true;
                 alphaHash: boolean;
                 alphaTest: number;
                 alphaToCoverage: boolean;
@@ -1474,6 +1473,7 @@ 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;
@@ -1497,7 +1497,7 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 clone: () => import("three").Material;
                 copy: (material: import("three").Material) => import("three").Material;
                 dispose: () => void;
-                onBeforeCompile: (parameters: import("three").WebGLProgramParametersWithUniforms, renderer: import("three").WebGLRenderer) => void;
+                onBeforeCompile: (shader: import("three").Shader, renderer: import("three").WebGLRenderer) => void;
                 customProgramCacheKey: () => string;
                 setValues: (values: import("three").MaterialParameters) => void;
                 toJSON: (meta?: any) => any;
@@ -2442,7 +2442,6 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
             }[];
             userData: Record<string, any>;
             customDepthMaterial?: {
-                readonly isMaterial: true;
                 alphaHash: boolean;
                 alphaTest: number;
                 alphaToCoverage: boolean;
@@ -2627,6 +2626,7 @@ 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;
@@ -2650,7 +2650,7 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 clone: () => import("three").Material;
                 copy: (material: import("three").Material) => import("three").Material;
                 dispose: () => void;
-                onBeforeCompile: (parameters: import("three").WebGLProgramParametersWithUniforms, renderer: import("three").WebGLRenderer) => void;
+                onBeforeCompile: (shader: import("three").Shader, renderer: import("three").WebGLRenderer) => void;
                 customProgramCacheKey: () => string;
                 setValues: (values: import("three").MaterialParameters) => void;
                 toJSON: (meta?: any) => any;
@@ -2677,7 +2677,6 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 }[T_6]) => void;
             } | undefined;
             customDistanceMaterial?: {
-                readonly isMaterial: true;
                 alphaHash: boolean;
                 alphaTest: number;
                 alphaToCoverage: boolean;
@@ -2862,6 +2861,7 @@ 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;
@@ -2885,7 +2885,7 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
                 clone: () => import("three").Material;
                 copy: (material: import("three").Material) => import("three").Material;
                 dispose: () => void;
-                onBeforeCompile: (parameters: import("three").WebGLProgramParametersWithUniforms, renderer: import("three").WebGLRenderer) => void;
+                onBeforeCompile: (shader: import("three").Shader, renderer: import("three").WebGLRenderer) => void;
                 customProgramCacheKey: () => string;
                 setValues: (values: import("three").MaterialParameters) => void;
                 toJSON: (meta?: any) => any;
@@ -3811,7 +3811,6 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
         }[];
         userData: Record<string, any>;
         customDepthMaterial?: {
-            readonly isMaterial: true;
             alphaHash: boolean;
             alphaTest: number;
             alphaToCoverage: boolean;
@@ -3996,6 +3995,7 @@ 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;
@@ -4019,7 +4019,7 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
             clone: () => import("three").Material;
             copy: (material: import("three").Material) => import("three").Material;
             dispose: () => void;
-            onBeforeCompile: (parameters: import("three").WebGLProgramParametersWithUniforms, renderer: import("three").WebGLRenderer) => void;
+            onBeforeCompile: (shader: import("three").Shader, renderer: import("three").WebGLRenderer) => void;
             customProgramCacheKey: () => string;
             setValues: (values: import("three").MaterialParameters) => void;
             toJSON: (meta?: any) => any;
@@ -4046,7 +4046,6 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
             }[T_6]) => void;
         } | undefined;
         customDistanceMaterial?: {
-            readonly isMaterial: true;
             alphaHash: boolean;
             alphaTest: number;
             alphaToCoverage: boolean;
@@ -4231,6 +4230,7 @@ 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;
@@ -4254,7 +4254,7 @@ export declare const useCamera: ({ sizes, scene }: Pick<TresContext, "sizes"> &
             clone: () => import("three").Material;
             copy: (material: import("three").Material) => import("three").Material;
             dispose: () => void;
-            onBeforeCompile: (parameters: import("three").WebGLProgramParametersWithUniforms, renderer: import("three").WebGLRenderer) => void;
+            onBeforeCompile: (shader: import("three").Shader, renderer: import("three").WebGLRenderer) => void;
             customProgramCacheKey: () => string;
             setValues: (values: import("three").MaterialParameters) => void;
             toJSON: (meta?: any) => any;

package/dist/src/devtools/highlight.d.ts

@@ -0,0 +1,7 @@
+import * as THREE from 'three';
+export declare class HightlightMesh extends THREE.Mesh {
+    type: string;
+    createTime: number;
+    constructor(...args: THREE.Mesh['args']);
+    onBeforeRender(): void;
+}

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

@@ -0,0 +1 @@
+export { registerTresDevtools } from './plugin';

package/dist/src/devtools/plugin.d.ts

@@ -0,0 +1,15 @@
+import type { App as DevtoolsApp } from '@vue/devtools-api';
+import type { TresContext } from '../composables';
+export interface Tags {
+    label: string;
+    textColor: number;
+    backgroundColor: number;
+    tooltip?: string;
+}
+export interface SceneGraphObject {
+    id: string;
+    label: string;
+    children: SceneGraphObject[];
+    tags: Tags[];
+}
+export declare function registerTresDevtools(app: DevtoolsApp, tres: TresContext): void;

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

@@ -0,0 +1,7 @@
+/**
+ * Shows a toast or console.log
+ *
+ * @param message - message to log
+ * @param type - different color of the tooltip
+ */
+export declare function toastMessage(message: string, type?: 'normal' | 'error' | 'warn' | undefined): void;

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

@@ -0,0 +1,5 @@
+import { vLog } from './vLog';
+import { vLightHelper } from './vLightHelper';
+import { vAlwaysLookAt } from './vAlwaysLookAt';
+import { vDistanceTo } from './vDistanceTo';
+export { vLog, vLightHelper, vAlwaysLookAt, vDistanceTo };

package/dist/src/directives/vAlwaysLookAt.d.ts

@@ -0,0 +1,6 @@
+import type { Object3D } from 'three';
+import type { Ref } from 'vue';
+import type { TresVector3 } from '../types';
+export declare const vAlwaysLookAt: {
+    updated: (el: Object3D, binding: Ref<TresVector3>) => void;
+};

package/dist/src/directives/vDistanceTo.d.ts

@@ -0,0 +1,6 @@
+import type { Ref } from 'vue';
+import type { TresObject } from '../types';
+export declare const vDistanceTo: {
+    updated: (el: TresObject, binding: Ref<TresObject>) => void;
+    unmounted: (el: TresObject) => void;
+};

package/dist/src/directives/vLightHelper.d.ts

@@ -0,0 +1,6 @@
+import type { TresObject } from '../types';
+export declare const vLightHelper: {
+    mounted: (el: TresObject) => void;
+    updated: (el: TresObject) => void;
+    unmounted: (el: TresObject) => void;
+};

package/dist/src/directives/vLog.d.ts

@@ -0,0 +1,6 @@
+import type { TresObject } from '../types';
+export declare const vLog: {
+    mounted: (el: TresObject, binding: {
+        arg: string;
+    }) => void;
+};

package/dist/src/index.d.ts

@@ -5,6 +5,7 @@ export * from './composables';
 export * from './core/catalogue';
 export * from './components';
 export * from './types';
+export * from './directives';
 export interface TresOptions {
     extends?: Record<string, unknown>;
 }

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

@@ -1,3 +1,5 @@
+import { MeshBasicMaterial, Vector3 } from 'three';
+import type { Mesh, Scene, Object3D } from 'three';
 export declare function toSetMethodName(key: string): string;
 export declare const merge: (target: any, source: any) => any;
 export declare const isHTMLTag: (key: string) => boolean;
@@ -13,3 +15,9 @@ export declare function deepArrayEqual(arr1: any[], arr2: any[]): boolean;
  * TypeSafe version of Array.isArray
  */
 export declare const isArray: (a: any) => a is any[] | readonly any[];
+export declare function editSceneObject(scene: Scene, objectUuid: string, propertyPath: string[], value: any): void;
+export declare function createHighlightMaterial(): MeshBasicMaterial;
+export declare function animateHighlight(highlightMesh: Mesh, startTime: number): void;
+export declare function stopHighlightAnimation(): void;
+export declare function createHighlightMesh(object: Object3D): Mesh;
+export declare function extractBindingPosition(binding: any): Vector3;