@tresjs/cientos 3.4.0 → 3.5.0

package/dist/core/staging/Precipitation.vue.d.ts

@@ -0,0 +1,226 @@
+import type { TresColor } from '@tresjs/core';
+export interface PrecipitationProps {
+    /**
+     * The size of the drops.
+     *
+     * @type {number}
+     * @memberof PrecipitationProps
+     * @default 0.1
+     */
+    size?: number;
+    /**
+     * The size of the precipitation area.
+     *
+     * @type {[number, number, number]}
+     * @memberof PrecipitationProps
+     * @default "[10, 10, 20]"
+     */
+    area?: [number, number, number];
+    /**
+     * The color of the shadows.
+     *
+     * @default '0xffffff'
+     * @type {TresColor}
+     * @memberof PrecipitationProps
+     *
+     */
+    color?: TresColor;
+    /**
+     * Color texture of the drops.
+     *
+     * @type {string}
+     * @memberof StarsProps
+     * @default null
+     */
+    map?: null;
+    /**
+     * texture of the alphaMap Drops.
+     *
+     * @type {string}
+     * @memberof StarsProps
+     * @default null
+     */
+    alphaMap?: string;
+    /**
+     * enables the WebGL to know when not to render the pixel.
+     *
+     * @type {number}
+     * @memberof StarsProps
+     * @default 0.01
+     */
+    alphaTest?: number;
+    /**
+     * Set the opacity of the drops.
+     *
+     * @type {number}
+     * @memberof StarsProps
+     * @default 0.8
+     */
+    opacity?: number;
+    /**
+     * number of drops.
+     *
+     * @type {number}
+     * @memberof StarsProps
+     * @default 5000
+     */
+    count?: number;
+    /**
+     * Speed of drops.
+     *
+     * @type {number}
+     * @memberof StarsProps
+     * @default 5000
+     */
+    speed?: number;
+    /**
+     * Add randomness to the drops.
+     *
+     * @default 0.5
+     * @type {number}
+     * @memberof ContactShadowsProps
+     *
+     */
+    randomness?: number;
+    /**
+     * Whether the shadows should write to the depth buffer or not.
+     *
+     * @default false
+     * @type {boolean}
+     * @memberof ContactShadowsProps
+     *
+     */
+    depthWrite?: boolean;
+    /**
+     * show transparency on the drops texture.
+     *
+     * @type {boolean}
+     * @memberof StarsProps
+     * @default true
+     */
+    transparent?: boolean;
+    /**
+     * keep the same size regardless distance.
+     *
+     * @type {boolean}
+     * @memberof StarsProps
+     * @default true
+     */
+    sizeAttenuation?: boolean;
+}
+declare const _default: import("vue").DefineComponent<{
+    speed: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    map: {
+        type: import("vue").PropType<null>;
+    };
+    color: {
+        type: import("vue").PropType<import("three").ColorRepresentation | [r: number, g: number, b: number]>;
+        default: number;
+    };
+    alphaTest: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    depthWrite: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    opacity: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    transparent: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    size: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    area: {
+        type: import("vue").PropType<[number, number, number]>;
+        default: () => number[];
+    };
+    alphaMap: {
+        type: import("vue").PropType<string>;
+    };
+    count: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    randomness: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    sizeAttenuation: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+}, {}, 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>;
+        default: number;
+    };
+    map: {
+        type: import("vue").PropType<null>;
+    };
+    color: {
+        type: import("vue").PropType<import("three").ColorRepresentation | [r: number, g: number, b: number]>;
+        default: number;
+    };
+    alphaTest: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    depthWrite: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    opacity: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    transparent: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    size: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    area: {
+        type: import("vue").PropType<[number, number, number]>;
+        default: () => number[];
+    };
+    alphaMap: {
+        type: import("vue").PropType<string>;
+    };
+    count: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    randomness: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    sizeAttenuation: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+}>>, {
+    speed: number;
+    color: import("three").ColorRepresentation | [r: number, g: number, b: number];
+    alphaTest: number;
+    depthWrite: boolean;
+    opacity: number;
+    transparent: boolean;
+    size: number;
+    area: [number, number, number];
+    count: number;
+    randomness: number;
+    sizeAttenuation: boolean;
+}, {}>;
+export default _default;

package/dist/core/staging/Sky.vue.d.ts

@@ -0,0 +1,77 @@
+export interface SkyProps {
+    turbidity?: number;
+    rayleigh?: number;
+    mieCoefficient?: number;
+    mieDirectionalG?: number;
+    elevation?: number;
+    azimuth?: number;
+    distance?: number;
+}
+declare const _default: import("vue").DefineComponent<{
+    distance: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    turbidity: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    rayleigh: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    mieCoefficient: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    mieDirectionalG: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    elevation: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    azimuth: {
+        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<{
+    distance: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    turbidity: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    rayleigh: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    mieCoefficient: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    mieDirectionalG: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    elevation: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    azimuth: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+}>>, {
+    distance: number;
+    turbidity: number;
+    rayleigh: number;
+    mieCoefficient: number;
+    mieDirectionalG: number;
+    elevation: number;
+    azimuth: number;
+}, {}>;
+export default _default;

package/dist/core/staging/Smoke.vue.d.ts

@@ -0,0 +1,146 @@
+import type { TresColor } from '@tresjs/core';
+export interface SmokeProps {
+    /**
+     * The color of the smoke.
+     * @default 0xffffff
+     * @type {TresColor}
+     * @memberof SmokeProps
+     * @see https://threejs.org/docs/#api/en/materials/MeshStandardMaterial
+     */
+    color?: TresColor;
+    /**
+     * The strength of the opacity.
+     * @default 0.5
+     * @type {number}
+     * @memberof SmokeProps
+     * @see https://threejs.org/docs/#api/en/materials/MeshStandardMaterial
+     */
+    opacity?: number;
+    /**
+     * The rotation speed of the smoke.
+     * @default 0.4
+     * @type {number}
+     * @memberof SmokeProps
+     * @see https://threejs.org/docs/#api/en/materials/MeshStandardMaterial
+     */
+    speed?: number;
+    /**
+     * The base width.
+     * @default 4
+     * @type {number}
+     * @memberof SmokeProps
+     * @see https://threejs.org/docs/#api/en/materials/MeshBasicMaterial
+     */
+    width?: number;
+    /**
+     * The base depth.
+     * @default 10
+     * @type {number}
+     * @memberof SmokeProps
+     * @see https://threejs.org/docs/#api/en/geometries/PlaneGeometry
+     */
+    depth?: number;
+    /**
+     * The number of smoke to render.
+     * @default 10
+     * @type {number}
+     * @memberof SmokeProps
+     * @see https://threejs.org/docs/#api/en/materials/MeshStandardMaterial
+     */
+    segments?: number;
+    /**
+     * The texture of the smoke.
+     * @default 'https://raw.githubusercontent.com/Tresjs/assets/main/textures/clouds/defaultCloud.png'
+     * @type {string}
+     * @memberof SmokeProps
+     * @see https://threejs.org/docs/#api/en/materials/MeshStandardMaterial
+     */
+    texture?: string;
+    /**
+     * The depthTest.
+     * @default true
+     * @type {boolean}
+     * @memberof SmokeProps
+     * @see https://threejs.org/docs/#api/en/materials/MeshStandardMaterial
+     */
+    depthTest?: boolean;
+}
+declare const _default: import("vue").DefineComponent<{
+    speed: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    color: {
+        type: import("vue").PropType<import("three").ColorRepresentation | [r: number, g: number, b: number]>;
+        default: string;
+    };
+    texture: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    depthTest: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    opacity: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    width: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    depth: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    segments: {
+        type: import("vue").PropType<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>;
+        default: number;
+    };
+    color: {
+        type: import("vue").PropType<import("three").ColorRepresentation | [r: number, g: number, b: number]>;
+        default: string;
+    };
+    texture: {
+        type: import("vue").PropType<string>;
+        default: string;
+    };
+    depthTest: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    opacity: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    width: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    depth: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    segments: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+}>>, {
+    speed: number;
+    color: import("three").ColorRepresentation | [r: number, g: number, b: number];
+    texture: string;
+    depthTest: boolean;
+    opacity: number;
+    width: number;
+    depth: number;
+    segments: number;
+}, {}>;
+export default _default;

package/dist/core/staging/Stars.vue.d.ts

@@ -0,0 +1,145 @@
+export interface StarsProps {
+    /**
+     * The size of the stars.
+     *
+     * @type {number}
+     * @memberof StarsProps
+     * @default 0.1
+     */
+    size?: number;
+    /**
+     * keep the same size regardless distance.
+     *
+     * @type {boolean}
+     * @memberof StarsProps
+     * @default true
+     */
+    sizeAttenuation?: boolean;
+    /**
+     * show transparency on the stars texture.
+     *
+     * @type {boolean}
+     * @memberof StarsProps
+     * @default true
+     */
+    transparent?: boolean;
+    /**
+     * enables the WebGL to know when not to render the pixel.
+     *
+     * @type {number}
+     * @memberof StarsProps
+     * @default 0.01
+     */
+    alphaTest?: number;
+    /**
+     * number of stars.
+     *
+     * @type {number}
+     * @memberof StarsProps
+     * @default 5000
+     */
+    count?: number;
+    /**
+     * depth of star's shape.
+     *
+     * @type {number}
+     * @memberof StarsProps
+     * @default 50
+     */
+    depth?: number;
+    /**
+     * Radius of star's shape.
+     *
+     * @type {number}
+     * @memberof StarsProps
+     * @default 100
+     */
+    radius?: number;
+    /**
+     * texture of the stars.
+     *
+     * @type {string}
+     * @memberof StarsProps
+     * @default null
+     */
+    alphaMap?: null;
+}
+declare const _default: import("vue").DefineComponent<{
+    alphaTest: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    transparent: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    size: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    depth: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    alphaMap: {
+        type: import("vue").PropType<null>;
+        default: null;
+    };
+    count: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    radius: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    sizeAttenuation: {
+        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<{
+    alphaTest: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    transparent: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    size: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    depth: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    alphaMap: {
+        type: import("vue").PropType<null>;
+        default: null;
+    };
+    count: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    radius: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    sizeAttenuation: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+}>>, {
+    alphaTest: number;
+    transparent: boolean;
+    size: number;
+    depth: number;
+    alphaMap: null;
+    count: number;
+    radius: number;
+    sizeAttenuation: boolean;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,8 @@
+import Environment from './useEnvironment/component.vue';
+import Backdrop from './Backdrop.vue';
+import ContactShadows from './ContactShadows.vue';
+import Stars from './Stars.vue';
+import Precipitation from './Precipitation.vue';
+import Smoke from './Smoke.vue';
+import Sky from './Sky.vue';
+export { Backdrop, ContactShadows, Stars, Precipitation, Smoke, Environment, Sky, };

package/dist/core/staging/useEnvironment/const.d.ts

@@ -0,0 +1,51 @@
+export interface EnvironmentOptions {
+    /**
+     * If true, the environment will be set as the scene's background.
+     *
+     * @type {boolean}
+     * @default false
+     */
+    background?: boolean | string;
+    /**
+     * The blur radius of the environment.
+     *
+     * @type {number}
+     * @default 0
+     */
+    blur?: number;
+    /**
+     * The files to load. If a string is provided, it will be loaded as an equirectangular texture.
+     * If an array is provided, it will be loaded as a cube texture.
+     *
+     * @type {(string | string[])}
+     */
+    files?: string | string[];
+    /**
+     * The path to the files.
+     *
+     * @type {string}
+     * @default '/'
+     */
+    path?: string;
+    /**
+     * The preset to use. If provided, the files and path props will be ignored.
+     *
+     * @type {EnvironmentPresetsType}
+     */
+    preset?: EnvironmentPresetsType;
+}
+export declare const environmentPresets: {
+    sunset: string;
+    studio: string;
+    city: string;
+    umbrellas: string;
+    night: string;
+    forest: string;
+    snow: string;
+    dawn: string;
+    hangar: string;
+    urban: string;
+    modern: string;
+    shangai: string;
+};
+export type EnvironmentPresetsType = keyof typeof environmentPresets;

package/dist/core/staging/useEnvironment/index.d.ts

@@ -0,0 +1,3 @@
+import type { CubeTexture, Texture } from 'three';
+import type { EnvironmentOptions } from './const';
+export declare function useEnvironment(options: Partial<EnvironmentOptions>): Promise<Texture | CubeTexture>;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './core';
+export * from './utils';