@tresjs/core 2.3.0 → 2.4.0-next.1

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

@@ -0,0 +1,114 @@
+import { type ColorSpace, type ShadowMapType, type ToneMapping } from 'three';
+import type { TresCamera } from '../types/';
+import type { RendererPresetsType } from '../composables/useRenderer/const';
+export interface TresCanvasProps {
+    shadows?: boolean;
+    shadowMapType?: ShadowMapType;
+    useLegacyLights?: boolean;
+    outputColorSpace?: ColorSpace;
+    toneMapping?: ToneMapping;
+    toneMappingExposure?: number;
+    context?: WebGLRenderingContext;
+    powerPreference?: 'high-performance' | 'low-power' | 'default';
+    preserveDrawingBuffer?: boolean;
+    clearColor?: string;
+    windowSize?: boolean;
+    preset?: RendererPresetsType;
+    disableRender?: boolean;
+    camera?: TresCamera;
+}
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    shadows: {
+        type: import("vue").PropType<boolean>;
+    };
+    shadowMapType: {
+        type: import("vue").PropType<ShadowMapType>;
+    };
+    useLegacyLights: {
+        type: import("vue").PropType<boolean>;
+    };
+    outputColorSpace: {
+        type: import("vue").PropType<ColorSpace>;
+    };
+    toneMapping: {
+        type: import("vue").PropType<ToneMapping>;
+    };
+    toneMappingExposure: {
+        type: import("vue").PropType<number>;
+    };
+    context: {
+        type: import("vue").PropType<WebGLRenderingContext>;
+    };
+    powerPreference: {
+        type: import("vue").PropType<"high-performance" | "low-power" | "default">;
+    };
+    preserveDrawingBuffer: {
+        type: import("vue").PropType<boolean>;
+    };
+    clearColor: {
+        type: import("vue").PropType<string>;
+    };
+    windowSize: {
+        type: import("vue").PropType<boolean>;
+    };
+    preset: {
+        type: import("vue").PropType<"realistic">;
+    };
+    disableRender: {
+        type: import("vue").PropType<boolean>;
+    };
+    camera: {
+        type: import("vue").PropType<TresCamera>;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    shadows: {
+        type: import("vue").PropType<boolean>;
+    };
+    shadowMapType: {
+        type: import("vue").PropType<ShadowMapType>;
+    };
+    useLegacyLights: {
+        type: import("vue").PropType<boolean>;
+    };
+    outputColorSpace: {
+        type: import("vue").PropType<ColorSpace>;
+    };
+    toneMapping: {
+        type: import("vue").PropType<ToneMapping>;
+    };
+    toneMappingExposure: {
+        type: import("vue").PropType<number>;
+    };
+    context: {
+        type: import("vue").PropType<WebGLRenderingContext>;
+    };
+    powerPreference: {
+        type: import("vue").PropType<"high-performance" | "low-power" | "default">;
+    };
+    preserveDrawingBuffer: {
+        type: import("vue").PropType<boolean>;
+    };
+    clearColor: {
+        type: import("vue").PropType<string>;
+    };
+    windowSize: {
+        type: import("vue").PropType<boolean>;
+    };
+    preset: {
+        type: import("vue").PropType<"realistic">;
+    };
+    disableRender: {
+        type: import("vue").PropType<boolean>;
+    };
+    camera: {
+        type: import("vue").PropType<TresCamera>;
+    };
+}>>, {}, {}>, {
+    default(): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/index.d.ts

@@ -1 +1,2 @@
-export * from './TresCanvas';
+import TresCanvas from './TresCanvas.vue';
+export { TresCanvas };

package/dist/composables/index.d.ts

@@ -1,4 +1,4 @@
-export * from './useCamera';
+export * from './useCamera/';
 export * from './useRenderLoop/';
 export * from './useRenderer/';
 export * from './useLoader';

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

@@ -1,97 +1,8 @@
-import { PerspectiveCamera, OrthographicCamera } from 'three';
-import { Ref } from 'vue';
-export declare enum CameraType {
-    Perspective = "Perspective",
-    Orthographic = "Orthographic"
-}
-export type Camera = PerspectiveCamera | OrthographicCamera;
-export interface PerspectiveCameraOptions {
-    /**
-     * Camera frustum vertical field of view, from bottom to top of view, in degrees.
-     *
-     * @type {number}
-     * @memberof PerspectiveCameraOptions
-     */
-    fov?: number;
-    /**
-     * Camera frustum near plane.
-     *
-     * @type {number}
-     * @memberof PerspectiveCameraOptions
-     */
-    near?: number;
-    /**
-     * Camera frustum far plane.
-     *
-     * @type {number}
-     * @memberof PerspectiveCameraOptions
-     */
-    far?: number;
-}
-export interface OrthographicCameraOptions {
-    /**
-     * Camera frustum left plane.
-     *
-     * @type {number}
-     * @memberof OrthographicCameraOptions
-     */
-    left?: number;
-    /**
-     * Camera frustum right plane.
-     *
-     * @type {number}
-     * @memberof OrthographicCameraOptions
-     */
-    right?: number;
-    /**
-     * Camera frustum top plane.
-     *
-     * @type {number}
-     * @memberof OrthographicCameraOptions
-     */
-    top?: number;
-    /**
-     * Camera frustum bottom plane.
-     *
-     * @type {number}
-     * @memberof OrthographicCameraOptions
-     */
-    bottom?: number;
-    /**
-     * Camera frustum near plane.
-     *
-     * @type {number}
-     * @memberof OrthographicCameraOptions
-     */
-    near?: number;
-    /**
-     * Camera frustum far plane.
-     *
-     * @type {number}
-     * @memberof OrthographicCameraOptions
-     */
-    far?: number;
-}
-interface UseCameraReturn {
-    activeCamera: Ref<Camera | undefined>;
-    createCamera: (cameraType?: CameraType, options?: PerspectiveCameraOptions | OrthographicCameraOptions) => Camera;
-    updateCamera: () => void;
-    pushCamera: (camera: Camera) => void;
+import { ComputedRef } from "vue";
+export declare function useCamera(sizes: any): {
+    cameras: import("vue").ShallowRef<TresCamera[]>;
+    camera: ComputedRef<any>;
+    addCamera: (camera: TresCamera, active?: boolean) => void;
+    setCameraToActive: (cameraId: string) => void;
     clearCameras: () => void;
-    setFirstCamera: (camera: Camera) => void;
-}
-/**
- * Create and update cameras
- *
- * ```ts
- * import { useCamera } from '@tresjs/core'
- * const { createCamera, updateCamera } = useCamera()
- * const camera = createCamera(new PerspectiveCamera(45, 1, 0.1, 1000))
- * updateCamera()
- * ```
- *
- * @export
- * @return {*}  {UseCameraReturn}
- */
-export declare function useCamera(): UseCameraReturn;
-export {};
+};

package/dist/composables/useCamera/old.d.ts

@@ -0,0 +1,98 @@
+import { TresCamera } from 'src/types';
+import { PerspectiveCamera, OrthographicCamera } from 'three';
+import { Ref } from 'vue';
+export declare enum CameraType {
+    Perspective = "Perspective",
+    Orthographic = "Orthographic"
+}
+export type Camera = PerspectiveCamera | OrthographicCamera;
+export interface PerspectiveCameraOptions {
+    /**
+     * Camera frustum vertical field of view, from bottom to top of view, in degrees.
+     *
+     * @type {number}
+     * @memberof PerspectiveCameraOptions
+     */
+    fov?: number;
+    /**
+     * Camera frustum near plane.
+     *
+     * @type {number}
+     * @memberof PerspectiveCameraOptions
+     */
+    near?: number;
+    /**
+     * Camera frustum far plane.
+     *
+     * @type {number}
+     * @memberof PerspectiveCameraOptions
+     */
+    far?: number;
+}
+export interface OrthographicCameraOptions {
+    /**
+     * Camera frustum left plane.
+     *
+     * @type {number}
+     * @memberof OrthographicCameraOptions
+     */
+    left?: number;
+    /**
+     * Camera frustum right plane.
+     *
+     * @type {number}
+     * @memberof OrthographicCameraOptions
+     */
+    right?: number;
+    /**
+     * Camera frustum top plane.
+     *
+     * @type {number}
+     * @memberof OrthographicCameraOptions
+     */
+    top?: number;
+    /**
+     * Camera frustum bottom plane.
+     *
+     * @type {number}
+     * @memberof OrthographicCameraOptions
+     */
+    bottom?: number;
+    /**
+     * Camera frustum near plane.
+     *
+     * @type {number}
+     * @memberof OrthographicCameraOptions
+     */
+    near?: number;
+    /**
+     * Camera frustum far plane.
+     *
+     * @type {number}
+     * @memberof OrthographicCameraOptions
+     */
+    far?: number;
+}
+interface UseCameraReturn {
+    activeCamera: Ref<TresCamera | undefined>;
+    createCamera: (cameraType?: CameraType, options?: PerspectiveCameraOptions | OrthographicCameraOptions) => Camera;
+    updateCamera: () => void;
+    pushCamera: (camera: TresCamera) => void;
+    clearCameras: () => void;
+    setFirstCamera: (camera: TresCamera) => void;
+}
+/**
+ * Create and update cameras
+ *
+ * ```ts
+ * import { useCamera } from '@tresjs/core'
+ * const { createCamera, updateCamera } = useCamera()
+ * const camera = createCamera(new PerspectiveCamera(45, 1, 0.1, 1000))
+ * updateCamera()
+ * ```
+ *
+ * @export
+ * @return {*}  {UseCameraReturn}
+ */
+export declare function useCamera(): UseCameraReturn;
+export {};

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

@@ -1,8 +1,10 @@
+import { Ref } from 'vue';
 import { MaybeRefOrGetter } from '@vueuse/core';
 import { WebGLRendererParameters, WebGLRenderer, ShadowMapType, ColorSpace } from 'three';
 import type { ToneMapping } from 'three';
 import { TresColor } from '../../types';
 import { RendererPresetsType } from './const';
+import { TresState } from '../../provider';
 export interface UseRendererOptions extends WebGLRendererParameters {
     /**
      * Enable shadows in the Renderer
@@ -87,10 +89,9 @@ export interface UseRendererOptions extends WebGLRendererParameters {
  * @param canvas
  * @param {UseRendererOptions} [options]
  */
-export declare function useRenderer(options: UseRendererOptions): {
+export declare function useRenderer(canvas: Ref<HTMLCanvasElement>, tres: TresState, options: UseRendererOptions): {
     renderer: import("vue").ShallowRef<WebGLRenderer | undefined>;
-    isReady: import("vue").Ref<boolean>;
+    isReady: Ref<boolean>;
     dispose: () => void;
-    aspectRatio: import("vue").ComputedRef<number>;
 };
 export type UseRendererReturn = ReturnType<typeof useRenderer>;

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

@@ -1,6 +1,6 @@
 import { Clock, EventDispatcher, Raycaster, Scene, Vector2, WebGLRenderer } from 'three';
 import { ComputedRef, Ref } from 'vue';
-import { Camera } from '../useCamera';
+import { Camera } from '../useCamera/old';
 import type { usePointerEventHandler } from '../usePointerEventHandler';
 export interface TresState {
     /**

package/dist/index.d.ts

@@ -3,7 +3,9 @@ export * from './composables';
 export * from './core/catalogue';
 export * from './components';
 export * from './types';
+export * from './provider';
 import { normalizeColor, normalizeVectorFlexibleParam } from './utils/normalize';
+import templateCompilerOptions from './utils/template-compiler-options';
 export interface TresOptions {
     extends?: Record<string, unknown>;
 }
@@ -13,4 +15,4 @@ export interface TresPlugin {
 }
 declare const plugin: TresPlugin;
 export default plugin;
-export { normalizeColor, normalizeVectorFlexibleParam };
+export { normalizeColor, normalizeVectorFlexibleParam, templateCompilerOptions };

package/dist/provider/index.d.ts

@@ -0,0 +1,20 @@
+import { Scene, WebGLRenderer } from 'three';
+import type { ComputedRef, Ref, ShallowRef } from 'vue';
+import { TresCamera } from '../types';
+export type TresState = {
+    scene: Readonly<ShallowRef<Scene>>;
+    cameras: Readonly<ShallowRef<TresCamera[]>>;
+    camera: ComputedRef<TresCamera | undefined>;
+    renderer?: Readonly<ShallowRef<WebGLRenderer | null>>;
+    addCamera: (camera: TresCamera) => void;
+    setCameraToActive: (cameraId: string) => void;
+    clearCameras: () => void;
+    setRenderer: (renderer: WebGLRenderer) => void;
+    sizes: {
+        height: Ref<number>;
+        width: Ref<number>;
+        aspectRatio: ComputedRef<number>;
+    };
+};
+export declare function useTresContextProvider(scene: Scene, canvas: Ref<HTMLCanvasElement | undefined>, props: any): TresState;
+export declare function useTresContext(): TresState;