@tresjs/core 3.6.0 → 4.0.0-next.0

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/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,7 +28,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
     logarithmicDepthBuffer: undefined;
     failIfMajorPerformanceCaveat: undefined;
 }>, {
-    context: Ref<TresContext | null> | import("vue").ShallowRef<TresContext | null>;
+    context: import("vue").ShallowRef<TresContext | null>;
     dispose: () => void;
 }, 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;
@@ -57,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/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/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/devtools/index.d.ts

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

package/dist/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/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;