@tresjs/cientos 3.6.0 → 3.8.0

package/README.md

@@ -1,7 +1,8 @@
 ![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/latest?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=FBB03B" alt="npm package"></a>
+  <a href="https://www.npmjs.com/package/@tresjs/cientos"><img src="https://img.shields.io/npm/dm/@tresjs/cientos?color=FBB03B" alt="npm downloads"></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/>
@@ -12,12 +13,12 @@
 
 - 💡 Build a 3D scene working only with Vue components.
 - ⚡️ Powered by Vite
-- 🥰 It brings all the updated features of ThreeJS right awayregardless the version
+- 🥰 It brings all the updated features of ThreeJS right away regardless the version
 - 🦾 Fully Typed
 
-Cientos (Spanish word for "hundreds", pronounced /θjentos/ ) is is a collection of useful ready-to-go helpers and components that are not part of the core package. The name uses the word uses in spanish to multiply by 100, to refer to the potential reach of the package to hold a amazing abstractions.
+Cientos (the Spanish word for "hundreds", pronounced /θjentos/ ) is a collection of useful ready-to-go helpers and components that are not part of the core package. The name uses the word used in Spanish to multiply by 100, to refer to the potential reach of the package to hold an amazing abstraction.
 
-The cientos package uses three-stdlib module under the hood instead of the three/examples/jsm module. This means that you don't need to extend the catalogue of components using the extend method from the `core`, cientos does it for you.
+The cientos package uses `three-stdlib` module under the hood instead of the three/examples/jsm module. This means that you don't need to extend the catalog of components using the extend method from the `core`, cientos does it for you.
 
 It just works. 💯
 
@@ -49,9 +50,9 @@ pnpm run build
 
 ### Playground
 
-To run the playground run, its a great way to test the components and helpers locally:
+To run the playground run, is a great way to test the components and helpers locally:
 
-First install dependencies
+First, install dependencies
 
 ```
 pnpm i

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

@@ -47,4 +47,4 @@ export interface AudioProps {
      */
     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>, {}, {}>;
+export declare const GlobalAudio: import("vue").DefineComponent<AudioProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<AudioProps>, {}, {}>;

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

@@ -1,32 +1,70 @@
 import { Lensflare } from 'three/examples/jsm/objects/Lensflare';
+import type { Texture } from 'three';
+import type { TresColor } from '@tresjs/core';
 import type { LensflareElementProps, SeedProps } from '.';
-declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Partial<LensflareElementProps> & {
-    elements?: Partial<LensflareElementProps>[] | undefined;
-    scale?: number | undefined;
-    seed?: number | undefined;
-    seedProps?: SeedProps[] | undefined;
-}>, {
-    elements: undefined;
+export interface LensflareProps {
+    /**
+     * scale of the lensflare
+     */
+    scale?: number;
+    /**
+     * array of lensflare element properties
+     */
+    elements?: Partial<LensflareElementProps>[];
+    /**
+       * random seed for generating random seeded elements
+       */
+    seed?: number;
+    /**
+     * specifications for generating random seeded elements
+     */
+    seedProps?: SeedProps[];
+    /**
+     * default color of lensflare elements
+     */
+    color?: TresColor;
+    /**
+     *  default distance of lensflare elements from flare center
+     */
+    distance?: number;
+    /**
+     *  default size of lensflare elements
+     */
+    size?: number;
+    /**
+     * default texture of lensflare elements
+     */
+    texture?: Texture | string[];
+}
+declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<LensflareProps>, {
     scale: number;
+    elements: undefined;
     seed: undefined;
     seedProps: undefined;
+    color: undefined;
+    distance: undefined;
+    size: undefined;
+    texture: 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<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Partial<LensflareElementProps> & {
-    elements?: Partial<LensflareElementProps>[] | undefined;
-    scale?: number | undefined;
-    seed?: number | undefined;
-    seedProps?: SeedProps[] | undefined;
-}>, {
-    elements: 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;
     seed: undefined;
     seedProps: undefined;
+    color: undefined;
+    distance: undefined;
+    size: undefined;
+    texture: undefined;
 }>>>, {
+    color: import("three").ColorRepresentation | [r: number, g: number, b: number];
+    texture: string[] | Texture;
     scale: number;
     elements: Partial<LensflareElementProps>[];
+    size: number;
     seed: number;
     seedProps: SeedProps[];
+    distance: number;
 }, {}>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;

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

@@ -10,7 +10,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
     range: () => 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<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
     speed: number;
     rotationFactor?: number | undefined;
     floatFactor?: number | undefined;

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

@@ -28,7 +28,7 @@ declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_T
     disabled: boolean;
     factor: number;
     ease: number;
-}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<MouseParallaxProps>, {
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<MouseParallaxProps>, {
     disabled: boolean;
     factor: number;
     ease: number;

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

@@ -0,0 +1,107 @@
+import type { TresColor } from '@tresjs/core';
+import { Reflector } from 'three/examples/jsm/objects/Reflector.js';
+export interface ReflectorProps {
+    /**
+     * The color of the reflector.
+     *
+     * @default '#333'
+     * @type {TresColor}
+     * @memberof ReflectorProps
+     *
+     */
+    color?: TresColor;
+    /**
+     * The textureWidth of the internal WebGLRenderTarget.
+     *
+     * @default window.innerWidth
+     * @type {number}
+     * @memberof ReflectorProps
+     *
+     */
+    textureWidth?: number;
+    /**
+     * The textureHeight of the internal WebGLRenderTarget.
+     *
+     * @default window.innerHeight
+     * @type {number}
+     * @memberof ReflectorProps
+     *
+     */
+    textureHeight?: number;
+    /**
+     * The clipBias.
+     *
+     * @default 0
+     * @type {number}
+     * @memberof ReflectorProps
+     *
+     */
+    clipBias?: number;
+    /**
+     * The multisample.
+     *
+     * @default 4
+     * @type {number}
+     * @memberof ReflectorProps
+     *
+     */
+    multisample?: number;
+    /**
+     * Custom shader.
+     *
+     * @default Reflector.ReflectorShader
+     * @type {object}
+     * @memberof ReflectorProps
+     *
+     */
+    shader?: object;
+}
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<ReflectorProps>, {
+    color: string;
+    textureWidth: number;
+    textureHeight: number;
+    clipBias: number;
+    multisample: number;
+    shader: any;
+}>, {
+    reflectorRef: 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;
+    textureHeight: number;
+    clipBias: number;
+    multisample: number;
+    shader: any;
+}>>>, {
+    color: import("three").ColorRepresentation | [r: number, g: number, b: number];
+    textureWidth: number;
+    textureHeight: number;
+    clipBias: number;
+    multisample: number;
+    shader: object;
+}, {}>, {
+    default?(_: {}): any;
+}>;
+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/Text3D.vue.d.ts

@@ -127,7 +127,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
     needUpdates: 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<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Text3DProps>, {
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Text3DProps>, {
     size: number;
     height: number;
     curveSegments: number;
@@ -140,6 +140,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
     needUpdates: boolean;
 }>>>, {
     height: number;
+    center: boolean;
     size: number;
     curveSegments: number;
     bevelEnabled: boolean;
@@ -147,7 +148,6 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
     bevelSize: number;
     bevelOffset: number;
     bevelSegments: number;
-    center: boolean;
     needUpdates: boolean;
 }, {}>, {
     default?(_: {}): any;

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

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

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

@@ -4,7 +4,7 @@ declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_T
     settings: undefined;
 }>, {
     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<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FboOptions>, {
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<FboOptions>, {
     depth: boolean;
     settings: undefined;
 }>>>, {

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

@@ -0,0 +1,21 @@
+import type { 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>>>, {}, {}>, {
+    default?(_: {}): any;
+}>;
+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_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};