@tresjs/cientos 1.6.0 → 1.8.0

package/dist/core/Torus.vue.d.ts

@@ -1,29 +1,31 @@
+import type { PropType as __PropType } from 'vue';
+import { TresColor } from '@tresjs/core/dist/types';
 declare const _sfc_main: import("vue").DefineComponent<{
     args: {
-        type: ArrayConstructor;
+        type: __PropType<number[] | undefined>;
         required: false;
         default: () => number[];
     };
     color: {
-        type: null;
+        type: __PropType<TresColor | undefined>;
         required: false;
         default: string;
     };
 }, {
-    torusRef: import("vue").ShallowRef<any>;
+    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<{
     args: {
-        type: ArrayConstructor;
+        type: __PropType<number[] | undefined>;
         required: false;
         default: () => number[];
     };
     color: {
-        type: null;
+        type: __PropType<TresColor | undefined>;
         required: false;
         default: string;
     };
 }>>, {
-    args: unknown[];
-    color: any;
+    args: number[] | undefined;
+    color: TresColor | undefined;
 }>;
 export default _sfc_main;

package/dist/core/TorusKnot.vue.d.ts

@@ -1,29 +1,31 @@
+import type { PropType as __PropType } from 'vue';
+import { TresColor } from '@tresjs/core/dist/types';
 declare const _sfc_main: import("vue").DefineComponent<{
     args: {
-        type: ArrayConstructor;
+        type: __PropType<number[] | undefined>;
         required: false;
         default: () => number[];
     };
     color: {
-        type: null;
+        type: __PropType<TresColor | undefined>;
         required: false;
         default: string;
     };
 }, {
-    torusKnotRef: import("vue").ShallowRef<any>;
+    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<{
     args: {
-        type: ArrayConstructor;
+        type: __PropType<number[] | undefined>;
         required: false;
         default: () => number[];
     };
     color: {
-        type: null;
+        type: __PropType<TresColor | undefined>;
         required: false;
         default: string;
     };
 }>>, {
-    args: unknown[];
-    color: any;
+    args: number[] | undefined;
+    color: TresColor | undefined;
 }>;
 export default _sfc_main;

package/dist/core/TransformControls.vue.d.ts

@@ -1,132 +1,103 @@
-import { Camera, Object3D, Scene, WebGLRenderer, type Event } from 'three';
-import { TransformControls as TransformControlsImp } from 'three-stdlib';
-import { type Ref, ShallowRef } from 'vue';
+import type { PropType as __PropType } from 'vue';
+import { Object3D, type Event } from 'three';
 declare const _sfc_main: import("vue").DefineComponent<{
     object: {
-        type: null;
+        type: __PropType<Object3D<Event>>;
         required: true;
     };
     mode: {
-        type: StringConstructor;
+        type: __PropType<string | undefined>;
         required: false;
     };
     enabled: {
-        type: BooleanConstructor;
+        type: __PropType<boolean | undefined>;
         required: false;
         default: boolean;
     };
     axis: {
-        type: StringConstructor;
+        type: __PropType<"X" | "Y" | "Z" | "XY" | "YZ" | "XZ" | "XYZ" | undefined>;
         required: false;
     };
     translationSnap: {
-        type: NumberConstructor;
+        type: __PropType<number | undefined>;
         required: false;
     };
     rotationSnap: {
-        type: NumberConstructor;
+        type: __PropType<number | undefined>;
         required: false;
     };
     scaleSnap: {
-        type: NumberConstructor;
+        type: __PropType<number | undefined>;
         required: false;
     };
     space: {
-        type: StringConstructor;
+        type: __PropType<"local" | "world" | undefined>;
         required: false;
     };
     size: {
-        type: NumberConstructor;
+        type: __PropType<number | undefined>;
         required: false;
     };
     showX: {
-        type: BooleanConstructor;
+        type: __PropType<boolean | undefined>;
         required: false;
     };
     showY: {
-        type: BooleanConstructor;
+        type: __PropType<boolean | undefined>;
         required: false;
     };
     showZ: {
-        type: BooleanConstructor;
+        type: __PropType<boolean | undefined>;
         required: false;
     };
-}, {
-    props: any;
-    emit: (event: "dragging" | "change" | "mouseDown" | "mouseUp" | "objectChange", ...args: any[]) => void;
-    controls: ShallowRef<TransformControlsImp<Camera> | undefined>;
-    camera: Ref<Camera> | undefined;
-    renderer: Ref<WebGLRenderer> | undefined;
-    scene: Ref<Scene> | undefined;
-    transformProps: import("vue").ComputedRef<Pick<{
-        object: Object3D;
-        mode?: string | undefined;
-        enabled: boolean;
-        axis?: "X" | "Y" | "Z" | "XY" | "YZ" | "XZ" | "XYZ" | undefined;
-        translationSnap?: number | undefined;
-        rotationSnap?: number | undefined;
-        scaleSnap?: number | undefined;
-        space?: "local" | "world" | undefined;
-        size?: number | undefined;
-        showX?: boolean | undefined;
-        showY?: boolean | undefined;
-        showZ?: boolean | undefined;
-    }, "mode" | "enabled" | "axis" | "translationSnap" | "rotationSnap" | "scaleSnap" | "space" | "size" | "showX" | "showY" | "showZ">>;
-    state: import("@tresjs/core").TresState;
-    onChange: () => void;
-    onMouseDown: () => void;
-    onMouseUp: () => void;
-    onObjectChange: () => void;
-    onDragingChange: (e: Event) => void;
-    addEventListeners: (controls: TransformControlsImp) => void;
-}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("dragging" | "change" | "mouseDown" | "mouseUp" | "objectChange")[], "dragging" | "change" | "mouseDown" | "mouseUp" | "objectChange", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("dragging" | "change" | "mouseDown" | "mouseUp" | "objectChange")[], "dragging" | "change" | "mouseDown" | "mouseUp" | "objectChange", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     object: {
-        type: null;
+        type: __PropType<Object3D<Event>>;
         required: true;
     };
     mode: {
-        type: StringConstructor;
+        type: __PropType<string | undefined>;
         required: false;
     };
     enabled: {
-        type: BooleanConstructor;
+        type: __PropType<boolean | undefined>;
         required: false;
         default: boolean;
     };
     axis: {
-        type: StringConstructor;
+        type: __PropType<"X" | "Y" | "Z" | "XY" | "YZ" | "XZ" | "XYZ" | undefined>;
         required: false;
     };
     translationSnap: {
-        type: NumberConstructor;
+        type: __PropType<number | undefined>;
         required: false;
     };
     rotationSnap: {
-        type: NumberConstructor;
+        type: __PropType<number | undefined>;
         required: false;
     };
     scaleSnap: {
-        type: NumberConstructor;
+        type: __PropType<number | undefined>;
         required: false;
     };
     space: {
-        type: StringConstructor;
+        type: __PropType<"local" | "world" | undefined>;
         required: false;
     };
     size: {
-        type: NumberConstructor;
+        type: __PropType<number | undefined>;
         required: false;
     };
     showX: {
-        type: BooleanConstructor;
+        type: __PropType<boolean | undefined>;
         required: false;
     };
     showY: {
-        type: BooleanConstructor;
+        type: __PropType<boolean | undefined>;
         required: false;
     };
     showZ: {
-        type: BooleanConstructor;
+        type: __PropType<boolean | undefined>;
         required: false;
     };
 }>> & {
@@ -136,9 +107,6 @@ declare const _sfc_main: import("vue").DefineComponent<{
     onMouseUp?: ((...args: any[]) => any) | undefined;
     onObjectChange?: ((...args: any[]) => any) | undefined;
 }, {
-    enabled: boolean;
-    showX: boolean;
-    showY: boolean;
-    showZ: boolean;
+    enabled: boolean | undefined;
 }>;
 export default _sfc_main;

package/dist/core/Tube.vue.d.ts

@@ -1,30 +1,34 @@
-import { QuadraticBezierCurve3 } from 'three';
+import type { PropType as __PropType } from 'vue';
+import { TresColor } from '@tresjs/core/dist/types';
+import { CatmullRomCurve3, CubicBezierCurve3, LineCurve3, QuadraticBezierCurve3 } from 'three';
+type CurveType = QuadraticBezierCurve3 | CubicBezierCurve3 | CatmullRomCurve3 | LineCurve3;
+type TubeGeometryParams = [CurveType, number, number, number, boolean];
 declare const _sfc_main: import("vue").DefineComponent<{
     args: {
-        type: ArrayConstructor;
+        type: __PropType<TubeGeometryParams | undefined>;
         required: false;
         default: () => (number | boolean | QuadraticBezierCurve3)[];
     };
     color: {
-        type: null;
+        type: __PropType<TresColor | undefined>;
         required: false;
         default: string;
     };
 }, {
-    tubeRef: import("vue").ShallowRef<any>;
+    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<{
     args: {
-        type: ArrayConstructor;
+        type: __PropType<TubeGeometryParams | undefined>;
         required: false;
         default: () => (number | boolean | QuadraticBezierCurve3)[];
     };
     color: {
-        type: null;
+        type: __PropType<TresColor | undefined>;
         required: false;
         default: string;
     };
 }>>, {
-    args: unknown[];
-    color: any;
+    args: TubeGeometryParams | undefined;
+    color: TresColor | undefined;
 }>;
 export default _sfc_main;

package/dist/core/useAnimations.d.ts

@@ -1,5 +1,14 @@
 import { AnimationAction, AnimationClip, AnimationMixer, Object3D, Scene } from 'three';
 import { 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;

package/dist/core/useCientos.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Allows to use and extend the state of the core package.
+ *
+ * @export
+ * @return {*}
+ */
 export declare function useCientos(): {
+    state: import("@tresjs/core").TresState;
+    setState: (key: string, value: any) => void;
     extend: (objects: any) => void;
 };

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

@@ -0,0 +1,36 @@
+import { TextureEncoding } from 'three';
+import { PropType } from 'vue';
+export declare const Environment: import("vue").DefineComponent<{
+    background: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    blur: {
+        type: NumberConstructor;
+        default: number;
+    };
+    files: {
+        type: (StringConstructor | ArrayConstructor)[];
+    };
+    encoding: PropType<TextureEncoding>;
+    path: StringConstructor;
+    preset: PropType<"sunset">;
+}, () => void, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    background: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    blur: {
+        type: NumberConstructor;
+        default: number;
+    };
+    files: {
+        type: (StringConstructor | ArrayConstructor)[];
+    };
+    encoding: PropType<TextureEncoding>;
+    path: StringConstructor;
+    preset: PropType<"sunset">;
+}>>, {
+    background: boolean;
+    blur: number;
+}>;

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

@@ -0,0 +1,44 @@
+import { TextureEncoding } from 'three';
+export type EnvironmentOptions = {
+    /**
+     * If true, the environment will be set as the scene's background.
+     *
+     * @type {boolean}
+     */
+    background?: boolean;
+    /**
+     * The blur radius of the environment.
+     *
+     * @type {number}
+     */
+    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}
+     */
+    path?: string;
+    /**
+     * The preset to use. If provided, the files and path props will be ignored.
+     *
+     * @type {EnvironmentPresetsType}
+     */
+    preset?: EnvironmentPresetsType;
+    /**
+     * The encoding of the environment.
+     *
+     * @type {TextureEncoding}
+     */
+    encoding?: TextureEncoding;
+};
+export declare const environmentPresets: {
+    sunset: string;
+};
+export type EnvironmentPresetsType = keyof typeof environmentPresets;

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

@@ -0,0 +1,17 @@
+import { CubeTexture, Texture } from 'three';
+import { EnvironmentOptions } from './const';
+/**
+ * Component that loads an environment map and sets it as the scene's background and environment.
+ *
+ * @export
+ * @param {Partial<EnvironmentOptions>} {
+ *   files = ['/px.png', '/nx.png', '/py.png', '/ny.png', '/pz.png', '/nz.png'],
+ *   blur = 0,
+ *   background = false,
+ *   path = undefined,
+ *   preset = undefined,
+ *   encoding = undefined,
+ * }
+ * @return {*}  {(Promise<Texture | CubeTexture>)}
+ */
+export declare function useEnvironment({ files, blur, background, path, preset, encoding, }: Partial<EnvironmentOptions>): Promise<Texture | CubeTexture>;

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

@@ -1,2 +1,9 @@
 import { Object3D } from 'three';
+/**
+ * Loads an FBX file and returns a THREE.Object3D.
+ *
+ * @export
+ * @param {(string | string[])} path
+ * @return {*}  {Promise<Object3D>}
+ */
 export declare function useFBX(path: string | string[]): Promise<Object3D>;

package/dist/core/useGLTF/component.d.ts

@@ -1,10 +1,34 @@
 export declare const GLTFModel: import("vue").DefineComponent<{
+    /**
+     * The path to the GLTF file.
+     *
+     */
     path: StringConstructor;
+    /**
+     * Whether to use Draco compression.
+     *
+     */
     draco: BooleanConstructor;
+    /**
+     * The path to the Draco decoder.
+     *
+     */
     decoderPath: StringConstructor;
 }, () => void, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The path to the GLTF file.
+     *
+     */
     path: StringConstructor;
+    /**
+     * Whether to use Draco compression.
+     *
+     */
     draco: BooleanConstructor;
+    /**
+     * The path to the Draco decoder.
+     *
+     */
     decoderPath: StringConstructor;
 }>>, {
     draco: boolean;

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

@@ -1,13 +1,36 @@
 import { GLTFLoader } from 'three-stdlib';
-import { TresObject } from '../../types';
+import { Object3D } from 'three';
 export interface GLTFLoaderOptions {
+    /**
+     * Whether to use Draco compression.
+     *
+     * @type {boolean}
+     * @memberof GLTFLoaderOptions
+     */
     draco?: boolean;
+    /**
+     * The path to the Draco decoder.
+     *
+     * @type {string}
+     * @memberof GLTFLoaderOptions
+     */
     decoderPath?: string;
 }
 export interface GLTFResult {
     animations: Array<THREE.AnimationClip>;
-    nodes: Array<TresObject>;
+    nodes: Array<Object3D>;
     materials: Array<THREE.Material>;
     scene: THREE.Scene;
 }
+/**
+ * Loads a GLTF file and returns a THREE.Object3D.
+ *
+ * @export
+ * @param {(string | string[])} path
+ * @param {GLTFLoaderOptions} [options={
+ *     draco: false,
+ *   }]
+ * @param {(loader: GLTFLoader) => void} [extendLoader]
+ * @return {*}  {Promise<GLTFResult>}
+ */
 export declare function useGLTF(path: string | string[], options?: GLTFLoaderOptions, extendLoader?: (loader: GLTFLoader) => void): Promise<GLTFResult>;

package/dist/core/usePamCameraMouse/component.d.ts

@@ -0,0 +1,26 @@
+export declare const PamCameraMouse: import("vue").DefineComponent<{
+    disabled: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    factor: {
+        type: NumberConstructor;
+        required: false;
+        default: number;
+    };
+}, () => void, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    disabled: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    factor: {
+        type: NumberConstructor;
+        required: false;
+        default: number;
+    };
+}>>, {
+    disabled: boolean;
+    factor: number;
+}>;

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

@@ -0,0 +1,2 @@
+import { Camera } from 'three';
+export declare function usePamCameraMouse(disabled: boolean | undefined, factor: number | undefined, camera: Camera | undefined): void;

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

@@ -1,5 +1,5 @@
 import { Pane } from 'tweakpane';
-declare type TweakPane = Pane & {
+type TweakPane = Pane & {
     addBlade(blade: any): void;
 };
 export declare const useTweakPane: (selector?: string) => {

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import OrbitControls from './core/OrbitControls.vue';
 import TransformControls from './core/TransformControls.vue';
+import { PamCameraMouse } from './core/usePamCameraMouse/component';
 import { useTweakPane } from './core/useTweakPane';
 import { useAnimations } from './core/useAnimations';
 import { GLTFModel } from './core/useGLTF/component';
@@ -18,7 +19,9 @@ import Tetrahedron from './core/Tetrahedron.vue';
 import Icosahedron from './core/Icosahedron.vue';
 import Octahedron from './core/Octahedron.vue';
 import Dodecahedron from './core/Dodecahedron.vue';
+import { Environment } from './core/useEnvironment/component';
 export * from './core/useGLTF';
 export * from './core/useFBX';
-export * from './types';
-export { OrbitControls, TransformControls, useTweakPane, GLTFModel, FBXModel, Text3D, Plane, Box, Sphere, Torus, TorusKnot, Circle, Cone, Tube, Ring, Tetrahedron, Icosahedron, Octahedron, Dodecahedron, useAnimations, };
+export * from './core/useEnvironment';
+export * from './core/usePamCameraMouse';
+export { OrbitControls, TransformControls, useTweakPane, GLTFModel, FBXModel, Text3D, Plane, Box, Sphere, Torus, TorusKnot, Circle, Cone, Tube, Ring, Tetrahedron, Icosahedron, Octahedron, Dodecahedron, useAnimations, Environment, PamCameraMouse, };