@tresjs/cientos 1.7.0 → 1.8.0

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/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,9 @@
+/**
+ * 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;

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

@@ -1,10 +1,41 @@
 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: {

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

@@ -1,3 +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,7 +1,19 @@
 import { GLTFLoader } from 'three-stdlib';
 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 {
@@ -10,4 +22,15 @@ export interface GLTFResult {
     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/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';
@@ -22,4 +23,5 @@ import { Environment } from './core/useEnvironment/component';
 export * from './core/useGLTF';
 export * from './core/useFBX';
 export * from './core/useEnvironment';
-export { OrbitControls, TransformControls, useTweakPane, GLTFModel, FBXModel, Text3D, Plane, Box, Sphere, Torus, TorusKnot, Circle, Cone, Tube, Ring, Tetrahedron, Icosahedron, Octahedron, Dodecahedron, useAnimations, Environment, };
+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, };