@tresjs/cientos 3.4.0 → 3.5.0

package/README.md

@@ -87,4 +87,4 @@ pnpm run docs:build
 
 ## Sponsors
 
-Be the first to support this project [here](https://github.com/sponsors/alvarosabu) ☺️
+Be the first to support this project [here](https://github.com/sponsors/alvarosabu) ☺️.

package/dist/composables/useLogger.d.ts

@@ -0,0 +1,8 @@
+export declare const isProd: boolean;
+interface LoggerComposition {
+    logError: (message: string, error?: Error | ErrorEvent) => void;
+    logWarning: (message: string) => void;
+    logMessage: (name: string, value: any) => void;
+}
+export declare function useLogger(): LoggerComposition;
+export {};

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

@@ -0,0 +1,50 @@
+export interface AudioProps {
+    /**
+     * Path to your audio file.
+     * @type {string}
+     * @memberof AudioProps
+     *
+     */
+    src: string;
+    /**
+     * Id of the DOM element that trigger the play/pause state.
+     * @type {string}
+     * @memberof AudioProps
+     * @default renderer.domElement
+     *
+     */
+    playTrigger?: string;
+    /**
+     * Id of the DOM element that trigger the stop state.
+     * @type {string}
+     * @memberof AudioProps
+     * @default
+     *
+     */
+    stopTrigger?: string;
+    /**
+     * If the audio must be replayed when ends.
+     * @type {boolean}
+     * @memberof AudioProps
+     * @default false
+     *
+     */
+    loop?: boolean;
+    /**
+     * Volume of the audio.
+     * @type {number}
+     * @memberof AudioProps
+     * @default 0.5
+     *
+     */
+    volume?: number;
+    /**
+     * PlaybackRate of the audio.
+     * @type {number}
+     * @memberof AudioProps
+     * @default 1
+     *
+     */
+    playbackRate?: number;
+}
+export declare const GlobalAudio: import("vue").DefineComponent<AudioProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<AudioProps>, {}, {}>;

package/dist/core/abstractions/Lensflare/RandUtils.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Seedable pseudorandom number tools
+ */
+export default class RandUtils {
+    private _getNext;
+    private _getGenerator;
+    /**
+     * Create a new seeded pseudorandom number generator.
+     * @param [seed=0] - the seed for the generator
+     * @param [getSeededRandomGenerator=getMulberry32] - a function that returns a pseudorandom number generator
+     * @constructor
+     */
+    constructor(seed?: number, getSeededRandomGenerator?: (seed: number) => () => number);
+    /**
+     * Reseed the pseudorandom number generator
+     */
+    seed(s: number): void;
+    /**
+     * Return the next pseudorandom number in the interval [0, 1]
+     */
+    rand(): number;
+    /**
+     * Random float from <low, high> interval
+     * @param low - Low value of the interval
+     * @param high - High value of the interval
+     */
+    float(low: number, high: number): number;
+    /**
+     * Random float from <-range/2, range/2> interval
+     * @param range - Interval range
+     */
+    floatSpread(range: number): number;
+    /**
+     * Random integer from <low, high> interval
+     * @param low Low value of the interval
+     * @param high High value of the interval
+     */
+    int(low: number, high: number): number;
+    /**
+     * Choose an element from an array.
+     * @param array The array to choose from
+     * @returns An element from the array or null if the array is empty
+     */
+    choice<T>(array: T[]): T | null;
+    /**
+     * Choose an element from an array or return defaultValue if array is empty.
+     * @param array The array to choose from
+     * @param defaultValue The value to return if the array is empty
+     * @returns An element from the array or defaultValue if the array is empty
+     */
+    defaultChoice<T>(array: T[], defaultValue: T): T;
+    /**
+     * Return n elements from an array.
+     * @param array The array to sample
+     * @param sampleSizeMin The minimum sample size
+     * @param sampleSizeMax The maximum sample size
+     */
+    sample<T>(array: T[], sampleSizeMin: number, sampleSizeMax?: number): T[];
+    /**
+     * Shuffle an array. Not in-place.
+     * @param array The array to shuffle
+     */
+    shuffle<T>(array: T[]): T[];
+    /**
+     * The default pseudorandom generator.
+     */
+    private getMulberry32;
+}

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

@@ -0,0 +1,69 @@
+import { Lensflare } from 'three/examples/jsm/objects/Lensflare';
+import type { LensflareElementProps, SeedProps } from '.';
+declare const _default: import("vue").DefineComponent<{
+    color: {
+        type: import("vue").PropType<import("three").ColorRepresentation | [r: number, g: number, b: number]>;
+    };
+    texture: {
+        type: import("vue").PropType<string | import("three").Texture>;
+    };
+    scale: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    elements: {
+        type: import("vue").PropType<Partial<LensflareElementProps>[]>;
+        default: undefined;
+    };
+    size: {
+        type: import("vue").PropType<number>;
+    };
+    distance: {
+        type: import("vue").PropType<number>;
+    };
+    seed: {
+        type: import("vue").PropType<number>;
+        default: undefined;
+    };
+    seedProps: {
+        type: import("vue").PropType<SeedProps[]>;
+        default: undefined;
+    };
+}, {
+    value: import("vue").ShallowRef<Lensflare | undefined>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    color: {
+        type: import("vue").PropType<import("three").ColorRepresentation | [r: number, g: number, b: number]>;
+    };
+    texture: {
+        type: import("vue").PropType<string | import("three").Texture>;
+    };
+    scale: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    elements: {
+        type: import("vue").PropType<Partial<LensflareElementProps>[]>;
+        default: undefined;
+    };
+    size: {
+        type: import("vue").PropType<number>;
+    };
+    distance: {
+        type: import("vue").PropType<number>;
+    };
+    seed: {
+        type: import("vue").PropType<number>;
+        default: undefined;
+    };
+    seedProps: {
+        type: import("vue").PropType<SeedProps[]>;
+        default: undefined;
+    };
+}>>, {
+    scale: number;
+    elements: Partial<LensflareElementProps>[];
+    seed: number;
+    seedProps: SeedProps[];
+}, {}>;
+export default _default;

package/dist/core/abstractions/Lensflare/constants.d.ts

@@ -0,0 +1,20 @@
+import type { LensflareElementProps, SeedProps } from '.';
+export declare const TEXTURE_PATH = "https://raw.githubusercontent.com/Tresjs/assets/93976c7d63ac83d4a254a41a10b2362bc17e90c9/textures/lensflare/";
+export declare const circle = "https://raw.githubusercontent.com/Tresjs/assets/93976c7d63ac83d4a254a41a10b2362bc17e90c9/textures/lensflare/circle.png";
+export declare const circleBlur = "https://raw.githubusercontent.com/Tresjs/assets/93976c7d63ac83d4a254a41a10b2362bc17e90c9/textures/lensflare/circleBlur.png";
+export declare const circleRainbow = "https://raw.githubusercontent.com/Tresjs/assets/93976c7d63ac83d4a254a41a10b2362bc17e90c9/textures/lensflare/circleRainbow.png";
+export declare const line = "https://raw.githubusercontent.com/Tresjs/assets/93976c7d63ac83d4a254a41a10b2362bc17e90c9/textures/lensflare/line.png";
+export declare const poly6 = "https://raw.githubusercontent.com/Tresjs/assets/93976c7d63ac83d4a254a41a10b2362bc17e90c9/textures/lensflare/poly6.png";
+export declare const polyStroke6 = "https://raw.githubusercontent.com/Tresjs/assets/93976c7d63ac83d4a254a41a10b2362bc17e90c9/textures/lensflare/polyStroke6.png";
+export declare const rays = "https://raw.githubusercontent.com/Tresjs/assets/93976c7d63ac83d4a254a41a10b2362bc17e90c9/textures/lensflare/rays.png";
+export declare const ring = "https://raw.githubusercontent.com/Tresjs/assets/93976c7d63ac83d4a254a41a10b2362bc17e90c9/textures/lensflare/ring.png";
+export declare const starThin6 = "https://raw.githubusercontent.com/Tresjs/assets/93976c7d63ac83d4a254a41a10b2362bc17e90c9/textures/lensflare/starThin6.png";
+export declare const oversize: SeedProps;
+export declare const bodyRequired0: SeedProps;
+export declare const bodyRequired1: SeedProps;
+export declare const bodyOptional: SeedProps;
+export declare const darkPurple: number, darkBlue: number;
+export declare const front: SeedProps;
+export declare const back: SeedProps;
+export declare const defaultSeedProps: SeedProps[];
+export declare const defaultLensflareElementProps: LensflareElementProps;

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

@@ -0,0 +1,36 @@
+import type { Texture } from 'three';
+import type { TresColor } from '@tresjs/core';
+import Lensflare from './component.vue';
+export { Lensflare };
+export interface SeedProps {
+    texture: string[];
+    color: TresColor[];
+    distance: [number, number];
+    size: [number, number];
+    length: [number, number];
+    seed?: number;
+}
+/**
+ * To make creating a complex lensflare simpler, the component can generate some or all `LensflareElement` properties.
+ * The precendence in creating the final elements' props is as follows:
+ *
+ * 1. `elements`
+ * 2. `userDefaultElement` - `color`, `distance`, `size`, `texture` from component
+ * 3. seeded random props - if `seed` and/or `seedProps` is not `undefined`
+ * 4. system default
+ *
+ * @param elements - `undefined` or an array of (potentially) incomplete element props
+ * @param userDefaultElement - values to "fill in" missing partial elements fields – or overwrite seeded props
+ * @param seed - `undefined` or a number to seed random prop generation
+ * @param seedProps - `undefined` or an array of SeedProps for generating random seeded properties
+ * @param systemDefaultElement - default values to "fill in" any remaining missing props
+ * @returns LensflareElementProps[] - An array of complete props
+ **/
+export declare const partialLensflarePropsArrayToLensflarePropsArray: (elements: Partial<LensflareElementProps>[] | undefined, userDefaultElement: Partial<LensflareElementProps>, seed?: number | undefined, seedProps?: SeedProps[] | undefined, systemDefaultElement?: LensflareElementProps) => LensflareElementProps[];
+export interface LensflareElementProps {
+    texture: Texture | string;
+    size: number;
+    distance: number;
+    color: TresColor;
+}
+export declare function filterLensflareElementProps(props: Partial<LensflareElementProps>): Partial<LensflareElementProps>;

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

@@ -0,0 +1,52 @@
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    speed: {
+        type: import("vue").PropType<number>;
+        required: true;
+        default: number;
+    };
+    rotationFactor: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    floatFactor: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    range: {
+        type: import("vue").PropType<[number, number]>;
+        default: () => number[];
+    };
+}, {
+    value: import("vue").ShallowRef<any>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    speed: {
+        type: import("vue").PropType<number>;
+        required: true;
+        default: number;
+    };
+    rotationFactor: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    floatFactor: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    range: {
+        type: import("vue").PropType<[number, number]>;
+        default: () => number[];
+    };
+}>>, {
+    speed: number;
+    rotationFactor: number;
+    floatFactor: number;
+    range: [number, number];
+}, {}>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,58 @@
+export interface MouseParallaxProps {
+    /**
+     * Whether to disable the mouse controls.
+     * @type {boolean}
+     * @default false
+     * @memberof MouseParallaxProps
+     *
+     */
+    disabled?: boolean;
+    /**
+     * The factor to multiply the mouse movement by.
+     * @type {number}
+     * @default 2.5
+     * @memberof MouseParallaxProps
+     *
+     **/
+    factor?: number;
+    /**
+     * The factor to multiply the mouse movement by.
+     * @type {number}
+     * @default 2.5
+     * @memberof MouseParallaxProps
+     *
+     **/
+    ease?: number;
+}
+declare const _default: import("vue").DefineComponent<{
+    disabled: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    factor: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    ease: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    disabled: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    factor: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    ease: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+}>>, {
+    disabled: boolean;
+    factor: number;
+    ease: number;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,234 @@
+export interface Glyph {
+    _cachedOutline: string[];
+    ha: number;
+    o: string;
+}
+export interface FontData {
+    boundingBox: {
+        yMax: number;
+        yMin: number;
+    };
+    familyName: string;
+    glyphs: {
+        [k: string]: Glyph;
+    };
+    resolution: number;
+    underlineThickness: number;
+}
+export interface Text3DProps {
+    /**
+     *
+     *  The JSON font to use for the text.
+     *  Text3D requires fonts in JSON format generated through [typeface.json](http://gero3.github.io/facetype.js)
+     *
+     * @type {(FontData | string)}
+     * @memberof Text3DProps
+     * @see https://threejs.org/docs/index.html?q=TEXT#examples/en/geometries/TextGeometry
+     */
+    font: FontData | string;
+    /**
+     * The text to display.
+     *
+     * @type {string}
+     * @memberof Text3DProps
+     */
+    text?: string;
+    /**
+     * The size of the text.
+     *
+     * @type {number}
+     * @memberof Text3DProps
+     * @default 0.5
+     */
+    size?: number;
+    /**
+     * The height of the text.
+     *
+     * @type {number}
+     * @memberof Text3DProps
+     * @default 0.2
+     */
+    height?: number;
+    /**
+     * The curve segments of the text.
+     *
+     * @type {number}
+     * @memberof Text3DProps
+     * @default 5
+     */
+    curveSegments?: number;
+    /**
+     * Turn on bevel
+     *
+     * @type {boolean}
+     * @memberof Text3DProps
+     * @default true
+     */
+    bevelEnabled?: boolean;
+    /**
+     * How deep into text bevel goes.
+     *
+     * @type {number}
+     * @memberof Text3DProps
+     * @default 0.05
+     */
+    bevelThickness?: number;
+    /**
+     * How far from text outline is bevel.
+     *
+     * @type {number}
+     * @memberof Text3DProps
+     * @default 0.02
+     */
+    bevelSize?: number;
+    /**
+     * How far from text outline is bevel.
+     *
+     * @type {number}
+     * @memberof Text3DProps
+     * @default 0
+     */
+    bevelOffset?: number;
+    /**
+     * How many bevel segments.
+     *
+     * @type {number}
+     * @memberof Text3DProps
+     * @default 4
+     */
+    bevelSegments?: number;
+    /**
+     * Whether to center the text.
+     *
+     * @type {boolean}
+     * @memberof Text3DProps
+     * @default false
+     */
+    center?: boolean;
+    /**
+     * Whether to update the text.
+     *
+     * @type {boolean}
+     * @memberof Text3DProps
+     * @default false
+     */
+    needUpdates?: boolean;
+}
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    height: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    font: {
+        type: import("vue").PropType<string | FontData>;
+        required: true;
+    };
+    text: {
+        type: import("vue").PropType<string>;
+    };
+    size: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    curveSegments: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    bevelEnabled: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    bevelThickness: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    bevelSize: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    bevelOffset: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    bevelSegments: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    center: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    needUpdates: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+}, {
+    value: import("vue").ShallowRef<any>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    height: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    font: {
+        type: import("vue").PropType<string | FontData>;
+        required: true;
+    };
+    text: {
+        type: import("vue").PropType<string>;
+    };
+    size: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    curveSegments: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    bevelEnabled: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    bevelThickness: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    bevelSize: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    bevelOffset: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    bevelSegments: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    center: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    needUpdates: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+}>>, {
+    height: number;
+    size: number;
+    curveSegments: number;
+    bevelEnabled: boolean;
+    bevelThickness: number;
+    bevelSize: number;
+    bevelOffset: number;
+    bevelSegments: number;
+    center: boolean;
+    needUpdates: boolean;
+}, {}>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,10 @@
+import Text3D from './Text3D.vue';
+import { useAnimations } from './useAnimations';
+import Levioso from './Levioso.vue';
+import MouseParallax from './MouseParallax.vue';
+import { GlobalAudio } from './GlobalAudio';
+import Lensflare from './Lensflare/component.vue';
+import Fbo from './useFBO/component.vue';
+export * from './useFBO/';
+export * from '../staging/useEnvironment';
+export { Text3D, useAnimations, MouseParallax, Levioso, Lensflare, GlobalAudio, Fbo, };

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

@@ -0,0 +1,18 @@
+import type { AnimationAction, AnimationClip, Object3D, Scene } from 'three';
+import { AnimationMixer } from 'three';
+import type { Ref } from 'vue';
+/**
+ * Creates an AnimationMixer and returns it.
+ *
+ * @export
+ * @template T
+ * @param {T[]} animations
+ * @param {(Scene | Ref<Object3D | undefined | null>)} [modelRef]
+ * @return {*}
+ */
+export declare function useAnimations<T extends AnimationClip>(animations: T[], modelRef?: Scene | Ref<Object3D | undefined | null>): {
+    actions: import("vue").ShallowReactive<{
+        [key: string]: AnimationAction;
+    }>;
+    mixer: AnimationMixer;
+};

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

@@ -0,0 +1,37 @@
+declare const _default: import("vue").DefineComponent<{
+    width: {
+        type: import("vue").PropType<number>;
+    };
+    height: {
+        type: import("vue").PropType<number>;
+    };
+    settings: {
+        type: import("vue").PropType<import("three").WebGLRenderTargetOptions>;
+        default: undefined;
+    };
+    depth: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+}, {
+    value: import("vue").Ref<import("three").WebGLRenderTarget<import("three").Texture> | null>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    width: {
+        type: import("vue").PropType<number>;
+    };
+    height: {
+        type: import("vue").PropType<number>;
+    };
+    settings: {
+        type: import("vue").PropType<import("three").WebGLRenderTargetOptions>;
+        default: undefined;
+    };
+    depth: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+}>>, {
+    settings: import("three").WebGLRenderTargetOptions;
+    depth: boolean;
+}, {}>;
+export default _default;

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

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