@tresjs/cientos 2.0.0-rc.3 → 2.1.0

package/README.md

@@ -1,7 +1,7 @@
 ![repository-banner.png](/public/repo-banner.png)
 
 <p align="center">
-  <a href="https://www.npmjs.com/package/@tresjs/cientos"><img src="https://img.shields.io/npm/v/@tresjs/cientos/next?color=%2382DBCA" alt="npm package"></a>
+  <a href="https://www.npmjs.com/package/@tresjs/cientos"><img src="https://img.shields.io/npm/v/@tresjs/cientos/latest?color=%2382DBCA" alt="npm package"></a>
   <a href="https://discord.gg/UCr96AQmWn"><img src="https://img.shields.io/badge/chat-discord-purple?style=flat&logo=discord" alt="discord chat"></a>
 </p>
 <br/>

package/core.d.ts

@@ -0,0 +1 @@
+export * from './dist/core/index.js'

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

@@ -0,0 +1,231 @@
+import type { PropType as __PropType } from 'vue';
+import { TresColor } from '@tresjs/core';
+import { ColorRepresentation } from 'three';
+export interface ContactShadowsProps {
+    /**
+     *
+     * The opacity of the shadows.
+     *
+     * @default 1
+     * @type {number}
+     * @memberof ContactShadowsProps
+     *
+     */
+    opacity?: number;
+    /**
+     * The width of the shadows.
+     *
+     * @default 1
+     * @type {number}
+     * @memberof ContactShadowsProps
+     *
+     */
+    width?: number;
+    /**
+     * The height of the shadows.
+     *
+     * @default 1
+     * @type {number}
+     * @memberof ContactShadowsProps
+     *
+     */
+    height?: number;
+    /**
+     * The blur of the shadows.
+     *
+     * @default 1
+     * @type {number}
+     * @memberof ContactShadowsProps
+     *
+     */
+    blur?: number;
+    /**
+     * How far the OrthographicCamera should be to capture the shadows.
+     *
+     * @default 10
+     * @type {number}
+     * @memberof ContactShadowsProps
+     *
+     */
+    far?: number;
+    /**
+     * Whether the shadows should be smooth or not.
+     *
+     * @default true
+     * @type {boolean}
+     * @memberof ContactShadowsProps
+     *
+     */
+    smooth?: boolean;
+    /**
+     * The resolution of the shadows.
+     *
+     * @default 512
+     * @type {number}
+     * @memberof ContactShadowsProps
+     *
+     */
+    resolution?: number;
+    /**
+     * The number of frames to render the shadows.
+     *
+     * @default Infinity
+     * @type {number}
+     * @memberof ContactShadowsProps
+     *
+     */
+    frames?: number;
+    /**
+     * The scale of the shadows.
+     *
+     * @default 10
+     * @type {(number | [x: number, y: number])}
+     * @memberof ContactShadowsProps
+     *
+     */
+    scale?: number | [x: number, y: number];
+    /**
+     * The color of the shadows.
+     *
+     * @default '#000000'
+     * @type {TresColor}
+     * @memberof ContactShadowsProps
+     *
+     */
+    color?: TresColor;
+    /**
+     * Whether the shadows should write to the depth buffer or not.
+     *
+     * @default false
+     * @type {boolean}
+     * @memberof ContactShadowsProps
+     *
+     */
+    depthWrite?: boolean;
+}
+declare const _sfc_main: import("vue").DefineComponent<{
+    opacity: {
+        type: __PropType<number | undefined>;
+        required: false;
+        default: number;
+    };
+    width: {
+        type: __PropType<number | undefined>;
+        required: false;
+        default: number;
+    };
+    height: {
+        type: __PropType<number | undefined>;
+        required: false;
+        default: number;
+    };
+    blur: {
+        type: __PropType<number | undefined>;
+        required: false;
+        default: number;
+    };
+    far: {
+        type: __PropType<number | undefined>;
+        required: false;
+        default: number;
+    };
+    smooth: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+        default: boolean;
+    };
+    resolution: {
+        type: __PropType<number | undefined>;
+        required: false;
+        default: number;
+    };
+    frames: {
+        type: __PropType<number | undefined>;
+        required: false;
+        default: number;
+    };
+    scale: {
+        type: __PropType<number | [x: number, y: number] | undefined>;
+        required: false;
+        default: number;
+    };
+    color: {
+        type: __PropType<[r: number, g: number, b: number] | ColorRepresentation | undefined>;
+        required: false;
+        default: string;
+    };
+    depthWrite: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+        default: boolean;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    opacity: {
+        type: __PropType<number | undefined>;
+        required: false;
+        default: number;
+    };
+    width: {
+        type: __PropType<number | undefined>;
+        required: false;
+        default: number;
+    };
+    height: {
+        type: __PropType<number | undefined>;
+        required: false;
+        default: number;
+    };
+    blur: {
+        type: __PropType<number | undefined>;
+        required: false;
+        default: number;
+    };
+    far: {
+        type: __PropType<number | undefined>;
+        required: false;
+        default: number;
+    };
+    smooth: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+        default: boolean;
+    };
+    resolution: {
+        type: __PropType<number | undefined>;
+        required: false;
+        default: number;
+    };
+    frames: {
+        type: __PropType<number | undefined>;
+        required: false;
+        default: number;
+    };
+    scale: {
+        type: __PropType<number | [x: number, y: number] | undefined>;
+        required: false;
+        default: number;
+    };
+    color: {
+        type: __PropType<[r: number, g: number, b: number] | ColorRepresentation | undefined>;
+        required: false;
+        default: string;
+    };
+    depthWrite: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+        default: boolean;
+    };
+}>>, {
+    opacity: number | undefined;
+    width: number | undefined;
+    height: number | undefined;
+    blur: number | undefined;
+    far: number | undefined;
+    smooth: boolean | undefined;
+    resolution: number | undefined;
+    frames: number | undefined;
+    scale: number | [x: number, y: number] | undefined;
+    color: [r: number, g: number, b: number] | ColorRepresentation | undefined;
+    depthWrite: boolean | undefined;
+}, {}>;
+export default _sfc_main;

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

@@ -20,9 +20,7 @@ declare const _sfc_main: import("vue").DefineComponent<{
         required: false;
         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<{
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     speed: {
         type: __PropType<number>;
         required: true;
@@ -48,5 +46,5 @@ declare const _sfc_main: import("vue").DefineComponent<{
     rotationFactor: number | undefined;
     floatFactor: number | undefined;
     range: [number, number] | undefined;
-}>;
+}, {}>;
 export default _sfc_main;

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

@@ -0,0 +1,219 @@
+import type { PropType as __PropType } from 'vue';
+import { TresColor } from '@tresjs/core';
+export type 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?: null;
+    /**
+     * 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?: 0.8;
+    /**
+     * number of drops.
+     *
+     * @type {number}
+     * @memberof StarsProps
+     * @default 5000
+     */
+    count?: 5000;
+    /**
+     * Speed of drops.
+     *
+     * @type {number}
+     * @memberof StarsProps
+     * @default 5000
+     */
+    speed?: 0.1;
+    /**
+     * 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 _sfc_main: import("vue").DefineComponent<{
+    size: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    area: {
+        type: __PropType<[number, number, number] | undefined>;
+        required: false;
+    };
+    color: {
+        type: __PropType<[r: number, g: number, b: number] | import("three").ColorRepresentation | undefined>;
+        required: false;
+    };
+    map: {
+        type: __PropType<null | undefined>;
+        required: false;
+    };
+    alphaMap: {
+        type: __PropType<null | undefined>;
+        required: false;
+    };
+    alphaTest: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    opacity: {
+        type: __PropType<0.8 | undefined>;
+        required: false;
+    };
+    count: {
+        type: __PropType<5000 | undefined>;
+        required: false;
+    };
+    speed: {
+        type: __PropType<0.1 | undefined>;
+        required: false;
+    };
+    randomness: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    depthWrite: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    transparent: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    sizeAttenuation: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    size: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    area: {
+        type: __PropType<[number, number, number] | undefined>;
+        required: false;
+    };
+    color: {
+        type: __PropType<[r: number, g: number, b: number] | import("three").ColorRepresentation | undefined>;
+        required: false;
+    };
+    map: {
+        type: __PropType<null | undefined>;
+        required: false;
+    };
+    alphaMap: {
+        type: __PropType<null | undefined>;
+        required: false;
+    };
+    alphaTest: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    opacity: {
+        type: __PropType<0.8 | undefined>;
+        required: false;
+    };
+    count: {
+        type: __PropType<5000 | undefined>;
+        required: false;
+    };
+    speed: {
+        type: __PropType<0.1 | undefined>;
+        required: false;
+    };
+    randomness: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    depthWrite: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    transparent: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    sizeAttenuation: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+}>>, {}, {}>;
+export default _sfc_main;

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

@@ -1,6 +1,6 @@
 import type { PropType as __PropType } from 'vue';
-import { TresColor, TresObject } from '@tresjs/core';
-export interface SmokeProps extends TresObject {
+import { TresColor } from '@tresjs/core';
+export type SmokeProps = {
     /**
      * The color of the smoke.
      * @default 0xffffff
@@ -59,105 +59,78 @@ export interface SmokeProps extends TresObject {
     texture?: string;
     /**
      * The depthTest.
-     * @default 10
+     * @default true
      * @type {boolean}
      * @memberof SmokeProps
      * @see https://threejs.org/docs/#api/en/materials/MeshStandardMaterial
      */
     depthTest?: boolean;
-}
+};
 declare const _sfc_main: import("vue").DefineComponent<{
     color: {
-        type: __PropType<TresColor | undefined>;
+        type: __PropType<[r: number, g: number, b: number] | import("three").ColorRepresentation | undefined>;
         required: false;
-        default: string;
     };
     opacity: {
         type: __PropType<number | undefined>;
         required: false;
-        default: number;
     };
     speed: {
         type: __PropType<number | undefined>;
         required: false;
-        default: number;
     };
     width: {
         type: __PropType<number | undefined>;
         required: false;
-        default: number;
     };
     depth: {
         type: __PropType<number | undefined>;
         required: false;
-        default: number;
     };
     segments: {
         type: __PropType<number | undefined>;
         required: false;
-        default: number;
     };
     texture: {
         type: __PropType<string | undefined>;
         required: false;
-        default: string;
     };
     depthTest: {
         type: __PropType<boolean | undefined>;
         required: false;
-        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<{
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     color: {
-        type: __PropType<TresColor | undefined>;
+        type: __PropType<[r: number, g: number, b: number] | import("three").ColorRepresentation | undefined>;
         required: false;
-        default: string;
     };
     opacity: {
         type: __PropType<number | undefined>;
         required: false;
-        default: number;
     };
     speed: {
         type: __PropType<number | undefined>;
         required: false;
-        default: number;
     };
     width: {
         type: __PropType<number | undefined>;
         required: false;
-        default: number;
     };
     depth: {
         type: __PropType<number | undefined>;
         required: false;
-        default: number;
     };
     segments: {
         type: __PropType<number | undefined>;
         required: false;
-        default: number;
     };
     texture: {
         type: __PropType<string | undefined>;
         required: false;
-        default: string;
     };
     depthTest: {
         type: __PropType<boolean | undefined>;
         required: false;
-        default: boolean;
-    };
-}>>, {
-    depth: number | undefined;
-    color: TresColor | undefined;
-    opacity: number | undefined;
-    speed: number | undefined;
-    width: number | undefined;
-    segments: number | undefined;
-    texture: string | undefined;
-    depthTest: boolean | undefined;
-}>;
+    };
+}>>, {}, {}>;
 export default _sfc_main;

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

@@ -67,7 +67,7 @@ export interface StarsProps {
     /**
      * texture of the stars.
      *
-     * @type {number}
+     * @type {string}
      * @memberof StarsProps
      * @default null
      */
@@ -119,9 +119,7 @@ declare const _sfc_main: import("vue").DefineComponent<{
         required: false;
         default: null;
     };
-}, {
-    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<{
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     size: {
         type: __PropType<number | undefined>;
         required: false;
@@ -168,6 +166,7 @@ declare const _sfc_main: import("vue").DefineComponent<{
         default: null;
     };
 }>>, {
+    alphaMap: null | undefined;
     size: number | undefined;
     factor: 4 | undefined;
     sizeAttenuation: boolean | undefined;
@@ -176,6 +175,5 @@ declare const _sfc_main: import("vue").DefineComponent<{
     count: 5000 | undefined;
     depth: 50 | undefined;
     radius: 100 | undefined;
-    alphaMap: null | undefined;
-}>;
+}, {}>;
 export default _sfc_main;

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

@@ -174,9 +174,7 @@ declare const _sfc_main: import("vue").DefineComponent<{
         required: false;
         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<{
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     font: {
         type: __PropType<string | FontData>;
         required: true;
@@ -236,8 +234,8 @@ declare const _sfc_main: import("vue").DefineComponent<{
         default: boolean;
     };
 }>>, {
-    size: number | undefined;
     height: number | undefined;
+    size: number | undefined;
     curveSegments: number | undefined;
     bevelEnabled: boolean | undefined;
     bevelThickness: number | undefined;
@@ -246,5 +244,5 @@ declare const _sfc_main: import("vue").DefineComponent<{
     bevelSegments: number | undefined;
     center: boolean | undefined;
     needUpdates: boolean | undefined;
-}>;
+}, {}>;
 export default _sfc_main;

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

@@ -1,10 +1,12 @@
 import Text3D from './Text3D.vue';
 import { useAnimations } from './useAnimations';
 import { Environment } from './useEnvironment/component';
-import { PamCameraMouse } from './usePamCameraMouse/component';
+import { MouseParallax } from './useParallax/component';
 import Stars from './Stars.vue';
+import Precipitation from './Precipitation.vue';
 import Smoke from './Smoke.vue';
 import Levioso from './Levioso.vue';
-export * from './usePamCameraMouse';
+import ContactShadows from './ContactShadows.vue';
+export * from './useParallax';
 export * from './useEnvironment';
-export { Text3D, useAnimations, Environment, PamCameraMouse, Stars, Smoke, Levioso };
+export { Text3D, useAnimations, Environment, MouseParallax, Stars, Smoke, Levioso, ContactShadows, Precipitation };

package/dist/core/abstractions/useEnvironment/component.d.ts

@@ -1,2 +1,2 @@
 import { EnvironmentOptions } from './const';
-export declare const Environment: import("vue").DefineComponent<EnvironmentOptions, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<EnvironmentOptions>, {}>;
+export declare const Environment: import("vue").DefineComponent<EnvironmentOptions, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<EnvironmentOptions>, {}, {}>;

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

@@ -14,4 +14,4 @@ import { EnvironmentOptions } from './const';
  * }
  * @return {*}  {(Promise<Texture | CubeTexture>)}
  */
-export declare function useEnvironment({ files, blur, background, path, preset, colorSpace, }: Partial<EnvironmentOptions>): Promise<Texture | CubeTexture>;
+export declare function useEnvironment({ files, blur, background, path, preset, }: Partial<EnvironmentOptions>): Promise<Texture | CubeTexture>;