@tresjs/cientos 3.9.0 → 4.0.0-next.1

package/dist/composables/useOnDemandInvalidation.d.ts

@@ -0,0 +1,3 @@
+export declare function useOnDemandInvalidation(props: Record<string, any>): {
+    invalidateOnDemand: () => void;
+};

package/dist/core/abstractions/AnimatedSprite/Atlas.d.ts

@@ -0,0 +1,38 @@
+import { Texture } from 'three';
+
+export declare function getTextureAndAtlasAsync(imagePathOrImageData: string, atlasPathOrAtlasish: string | Atlasish): Promise<[Texture, Atlas]>;
+export interface AtlasFrame {
+    name: string;
+    width: number;
+    height: number;
+    offsetX: number;
+    offsetY: number;
+    repeatX: number;
+    repeatY: number;
+}
+export interface Atlas {
+    frames: AtlasFrame[];
+    animations: Record<string, AtlasFrame[]>;
+}
+export declare function getAtlas(atlasish: Atlasish, textureWidth: number, textureHeight: number): Atlas;
+export declare function getAtlasFrames(atlas: Atlas, animationNameOrFrameNumber: string | number | [number, number], reversed: boolean): AtlasFrame[];
+export declare function getNullAtlasFrame(): AtlasFrame;
+export type AtlasData = TexturePackerFrameDataArray | TexturePackerFrameDataObject;
+export type Atlasish = AtlasData | [number, number] | number;
+interface TexturePackerFrameData {
+    filename: string;
+    frame: {
+        x: number;
+        y: number;
+        w: number;
+        h: number;
+    };
+}
+interface TexturePackerFrameDataArray {
+    frames: TexturePackerFrameData[];
+}
+interface TexturePackerFrameDataObject {
+    frames: Record<string, TexturePackerFrameData>;
+}
+export declare function setAtlasDefinitions(atlas: Atlas, definitions?: Record<string, string>): void;
+export {};

package/dist/core/abstractions/AnimatedSprite/AtlasAnimationDefinitionParser.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Expand an animation definition string into an array of numbers.
+ * @param definitionStr - A comma-separated string of frame numbers with optional parentheses-surrounded durations.
+ * @example - expand("0,2") === [0,2]
+ * @example - expand("2(10)") === [2,2,2,2,2,2,2,2,2,2]
+ * @example - expand("1-4") === [1,2,3,4]
+ * @example - expand("10-5(2)") === [10,10,9,9,8,8,7,7,6,6,5,5]
+ * @example - expand("1-4(3),10(2)") === [1,1,1,2,2,2,3,3,3,4,4,4,10,10]
+ */
+export declare function expand(definitionStr: string): number[];

package/dist/core/abstractions/AnimatedSprite/StringOps.d.ts

@@ -0,0 +1,2 @@
+export declare function stripUnderscoresNumbersFromEnd(str: string): string;
+export declare function getNumbersFromEnd(str: string): number | null;

package/dist/core/abstractions/AnimatedSprite/component.vue.d.ts

@@ -0,0 +1,130 @@
+import { TresVector2 } from '@tresjs/core';
+import { Intersection } from 'three';
+import { Atlasish } from './Atlas';
+
+export interface AnimatedSpriteProps {
+    /** URL of the image texture or an image dataURL. This prop is not reactive. */
+    image: string;
+    /**
+     * If `string`, the URL of the JSON atlas.
+     * If `number`, the number of columns in the texture.
+     * If `[number, number]`, the number of columns/rows in the texture.
+     * If `AtlasData`, the atlas as a JS object.
+     * This prop is not reactive.
+     */
+    atlas: string | Atlasish;
+    /**
+    * Specify playback frame order and repeated frames (delays). `definitions` is a record where keys are atlas animation names and values are strings containing an animation definition.
+    * A "animation definition" comma-separated string of frame numbers with optional parentheses-surrounded durations.
+    * Here is how various definition strings convert to arrays of frames for playback:
+    * "0,2,1" - [0,2,1], i.e., play frame 0, 2, then 1.
+    * "2(10)" - [2,2,2,2,2,2,2,2,2,2], i.e., play from 2 10 times.
+    * "1-4" - [1,2,3,4]
+    * "10-5(2)" - [10,10,9,9,8,8,7,7,6,6,5,5]
+    * "1-4(3),10(2)" - [1,1,1,2,2,2,3,3,3,4,4,4,10,10]
+     */
+    definitions?: Record<string, string>;
+    /** Desired frames per second of the animation. */
+    fps?: number;
+    /** Whether or not the animation should loop. */
+    loop?: boolean;
+    /** If `string`, name of the animation to play. If `[number, number]`, start and end frames of the animation. If `number`, frame number to display. */
+    animation?: string | [number, number] | number;
+    /** Event callback when the animation ends. */
+    paused?: boolean;
+    /** Whether to play the animation in reverse. */
+    reversed?: boolean;
+    /** Whether the sprite should be flipped, left to right. */
+    flipX?: boolean;
+    /** For a non-looping animation, when the animation ends, whether to display the zeroth frame. */
+    resetOnEnd?: boolean;
+    /** Whether to display the object as a THREE.Sprite. [See THREE.Sprite](https://threejs.org/docs/?q=sprite#api/en/objects/Sprite) */
+    asSprite?: boolean;
+    /** Anchor point of the object. A value of [0.5, 0.5] corresponds to the center. [0, 0] is left, bottom. */
+    center?: TresVector2;
+    /** Alpha test value for the material. [See THREE.Material.alphaTest](https://threejs.org/docs/#api/en/materials/Material.alphaTest) */
+    alphaTest?: number;
+    /** Depth test value for the material. [See THREE.Material.depthTest](https://threejs.org/docs/#api/en/materials/Material.depthTest) */
+    depthTest?: boolean;
+    /** Depth write value for the material. [See THREE.Material.depthWrite](https://threejs.org/docs/#api/en/materials/Material.depthWrite) */
+    depthWrite?: boolean;
+}
+declare function __VLS_template(): {
+    default?(_: {}): any;
+};
+declare const __VLS_component: import('vue').DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<AnimatedSpriteProps>, {
+    fps: number;
+    loop: boolean;
+    animation: number;
+    paused: boolean;
+    reversed: boolean;
+    flipX: boolean;
+    resetOnEnd: boolean;
+    asSprite: boolean;
+    center: () => number[];
+    alphaTest: number;
+    depthTest: boolean;
+    depthWrite: boolean;
+}>, {
+    instance: import('vue').ShallowRef<any>;
+}, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    frame: (frameName: string) => void;
+    end: (frameName: string) => void;
+    loop: (frameName: string) => void;
+    click: (event: Intersection<import('three').Object3D<import('three').Object3DEventMap>>) => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<AnimatedSpriteProps>, {
+    fps: number;
+    loop: boolean;
+    animation: number;
+    paused: boolean;
+    reversed: boolean;
+    flipX: boolean;
+    resetOnEnd: boolean;
+    asSprite: boolean;
+    center: () => number[];
+    alphaTest: number;
+    depthTest: boolean;
+    depthWrite: boolean;
+}>>> & {
+    onClick?: ((event: Intersection<import('three').Object3D<import('three').Object3DEventMap>>) => any) | undefined;
+    onLoop?: ((frameName: string) => any) | undefined;
+    onFrame?: ((frameName: string) => any) | undefined;
+    onEnd?: ((frameName: string) => any) | undefined;
+}, {
+    loop: boolean;
+    depthTest: boolean;
+    depthWrite: boolean;
+    alphaTest: number;
+    center: TresVector2;
+    fps: number;
+    animation: string | [number, number] | number;
+    paused: boolean;
+    reversed: boolean;
+    flipX: boolean;
+    resetOnEnd: boolean;
+    asSprite: boolean;
+}, {}>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, ReturnType<typeof __VLS_template>>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/core/abstractions/Lensflare/component.vue.d.ts

@@ -47,7 +47,7 @@ declare const _default: import('vue').DefineComponent<__VLS_WithDefaults<__VLS_T
     size: undefined;
     texture: undefined;
 }>, {
-    value: import('vue').ShallowRef<Lensflare | undefined>;
+    instance: import('vue').ShallowRef<Lensflare | undefined>;
 }, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<LensflareProps>, {
     scale: number;
     elements: undefined;
@@ -58,12 +58,12 @@ declare const _default: import('vue').DefineComponent<__VLS_WithDefaults<__VLS_T
     size: undefined;
     texture: undefined;
 }>>>, {
-    color: import('three').ColorRepresentation | [r: number, g: number, b: number];
-    texture: string[] | Texture;
+    color: TresColor;
+    texture: Texture | string[];
     scale: number;
-    elements: Partial<LensflareElementProps>[];
     distance: number;
     size: number;
+    elements: Partial<LensflareElementProps>[];
     seed: number;
     seedProps: SeedProps[];
 }, {}>;

package/dist/core/abstractions/Levioso.vue.d.ts

@@ -1,20 +1,23 @@
-declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
-    speed?: number | undefined;
-    rotationFactor?: number | undefined;
-    floatFactor?: number | undefined;
-    range?: [number, number] | undefined;
+declare function __VLS_template(): {
+    default?(_: {}): any;
+};
+declare const __VLS_component: import('vue').DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+    speed?: number;
+    rotationFactor?: number;
+    floatFactor?: number;
+    range?: [number, number];
 }>, {
     speed: number;
     rotationFactor: number;
     floatFactor: number;
     range: () => number[];
 }>, {
-    value: import('vue').ShallowRef<any>;
+    instance: import('vue').ShallowRef<any>;
 }, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
-    speed?: number | undefined;
-    rotationFactor?: number | undefined;
-    floatFactor?: number | undefined;
-    range?: [number, number] | undefined;
+    speed?: number;
+    rotationFactor?: number;
+    floatFactor?: number;
+    range?: [number, number];
 }>, {
     speed: number;
     rotationFactor: number;
@@ -25,9 +28,8 @@ declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<__
     rotationFactor: number;
     floatFactor: number;
     range: [number, number];
-}, {}>, {
-    default?(_: {}): any;
-}>;
+}, {}>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, ReturnType<typeof __VLS_template>>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
 type __VLS_TypePropsToRuntimeProps<T> = {

package/dist/core/abstractions/MouseParallax.vue.d.ts

@@ -9,20 +9,20 @@ export interface MouseParallaxProps {
     disabled?: boolean;
     /**
      * The factor to multiply the mouse movement by.
-     * @type {number}
+     * @type {number | [number, number]}
      * @default 2.5
      * @memberof MouseParallaxProps
      *
      */
-    factor?: number;
+    factor?: number | [number, number];
     /**
      * The factor to smooth the mouse movement by.
-     * @type {number}
+     * @type {number | [number, number]}
      * @default 2.5
      * @memberof MouseParallaxProps
      *
      */
-    ease?: number;
+    ease?: number | [number, number];
     /**
      * Whether to apply the parallax effect to the local canvas.
      * @type {boolean}
@@ -44,8 +44,8 @@ declare const _default: import('vue').DefineComponent<__VLS_WithDefaults<__VLS_T
     local: boolean;
 }>>>, {
     disabled: boolean;
-    factor: number;
-    ease: number;
+    factor: number | [number, number];
+    ease: number | [number, number];
     local: boolean;
 }, {}>;
 export default _default;

package/dist/core/abstractions/Reflector.vue.d.ts

@@ -1,5 +1,5 @@
 import { TresColor } from '@tresjs/core';
-import { Reflector } from 'three/examples/jsm/objects/Reflector.js';
+import { Reflector } from 'three-stdlib';
 
 export interface ReflectorProps {
     /**
@@ -57,7 +57,10 @@ export interface ReflectorProps {
      */
     shader?: object;
 }
-declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<ReflectorProps>, {
+declare function __VLS_template(): {
+    default?(_: {}): any;
+};
+declare const __VLS_component: import('vue').DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<ReflectorProps>, {
     color: string;
     textureWidth: number;
     textureHeight: number;
@@ -65,7 +68,7 @@ declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<__
     multisample: number;
     shader: any;
 }>, {
-    reflectorRef: import('vue').ShallowRef<Reflector | undefined>;
+    instance: import('vue').ShallowRef<Reflector | undefined>;
 }, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<ReflectorProps>, {
     color: string;
     textureWidth: number;
@@ -74,15 +77,14 @@ declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<__
     multisample: number;
     shader: any;
 }>>>, {
-    color: import('three').ColorRepresentation | [r: number, g: number, b: number];
+    color: TresColor;
     textureWidth: number;
     textureHeight: number;
     clipBias: number;
     multisample: number;
     shader: object;
-}, {}>, {
-    default?(_: {}): any;
-}>;
+}, {}>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, ReturnType<typeof __VLS_template>>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
 type __VLS_TypePropsToRuntimeProps<T> = {

package/dist/core/abstractions/Text3D.vue.d.ts

@@ -114,7 +114,10 @@ export interface Text3DProps {
      */
     needUpdates?: boolean;
 }
-declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Text3DProps>, {
+declare function __VLS_template(): {
+    default?(_: {}): any;
+};
+declare const __VLS_component: import('vue').DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Text3DProps>, {
     size: number;
     height: number;
     curveSegments: number;
@@ -126,7 +129,7 @@ declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<__
     center: boolean;
     needUpdates: boolean;
 }>, {
-    value: import('vue').ShallowRef<any>;
+    instance: import('vue').ShallowRef<any>;
 }, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Text3DProps>, {
     size: number;
     height: number;
@@ -149,9 +152,8 @@ declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<__
     bevelOffset: number;
     bevelSegments: number;
     needUpdates: boolean;
-}, {}>, {
-    default?(_: {}): any;
-}>;
+}, {}>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, ReturnType<typeof __VLS_template>>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
 type __VLS_TypePropsToRuntimeProps<T> = {

package/dist/core/abstractions/index.d.ts

@@ -7,9 +7,10 @@ import { GlobalAudio } from './GlobalAudio';
 import { default as Lensflare } from './Lensflare/component.vue';
 import { default as Fbo } from './useFBO/component.vue';
 import { default as Sampler } from './useSurfaceSampler/component.vue';
+import { default as AnimatedSprite } from './AnimatedSprite/component.vue';
 import { default as PositionalAudio } from './PositionalAudio.vue';
 
 export * from './useFBO/';
 export * from './useSurfaceSampler';
 export * from '../staging/useEnvironment';
-export { Text3D, useAnimations, MouseParallax, Levioso, Reflector, Lensflare, GlobalAudio, Fbo, Sampler, PositionalAudio, };
+export { Text3D, useAnimations, MouseParallax, Levioso, Reflector, Lensflare, GlobalAudio, Fbo, Sampler, AnimatedSprite, PositionalAudio, };

package/dist/core/abstractions/useFBO/component.vue.d.ts

@@ -4,12 +4,12 @@ declare const _default: import('vue').DefineComponent<__VLS_WithDefaults<__VLS_T
     depth: boolean;
     settings: undefined;
 }>, {
-    value: import('vue').Ref<import('three').WebGLRenderTarget<import('three').Texture> | null>;
+    instance: import('vue').Ref<import('three').WebGLRenderTarget<import('three').Texture> | null>;
 }, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FboOptions>, {
     depth: boolean;
     settings: undefined;
 }>>>, {
-    settings: any;
+    settings: import('three').RenderTargetOptions;
     depth: boolean;
 }, {}>;
 export default _default;

package/dist/core/abstractions/useFBO/index.d.ts

@@ -1,10 +1,10 @@
-import { WebGLRenderTargetOptions, WebGLRenderTarget } from 'three';
+import { RenderTargetOptions, WebGLRenderTarget } from 'three';
 import { Ref } from 'vue';
 
 export interface FboOptions {
     width?: number;
     height?: number;
     depth?: boolean;
-    settings?: WebGLRenderTargetOptions;
+    settings?: RenderTargetOptions;
 }
 export declare function useFBO(options: FboOptions): Ref<WebGLRenderTarget<import('three').Texture> | null>;

package/dist/core/abstractions/useSurfaceSampler/component.vue.d.ts

@@ -1,10 +1,12 @@
 import { useSurfaceSamplerProps } from '.';
 
-declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<__VLS_TypePropsToRuntimeProps<useSurfaceSamplerProps>, {
-    samplerRef: import('vue').Ref<any>;
-}, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<useSurfaceSamplerProps>>>, {}, {}>, {
+declare function __VLS_template(): {
     default?(_: {}): any;
-}>;
+};
+declare const __VLS_component: import('vue').DefineComponent<__VLS_TypePropsToRuntimeProps<useSurfaceSamplerProps>, {
+    samplerRef: import('vue').Ref<any>;
+}, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<useSurfaceSamplerProps>>>, {}, {}>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, ReturnType<typeof __VLS_template>>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
 type __VLS_TypePropsToRuntimeProps<T> = {