@tresjs/cientos 2.0.0-rc.3 → 2.1.0

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

@@ -0,0 +1,27 @@
+export interface MouseParallaxProps {
+    /**
+     * Whether to disable the mouse controls.
+     * @type {boolean}
+     * @default false
+     * @memberof MouseParallaxProps
+     *
+     */
+    disabled?: boolean;
+    /**
+     * The factor to multiply the mouse movement by.
+     * @type {number}
+     * @default 2.5
+     * @memberof MouseParallaxProps
+     *
+     **/
+    factor?: number;
+    /**
+     * The factor to multiply the mouse movement by.
+     * @type {boolean}
+     * @default true
+     * @memberof MouseParallaxProps
+     *
+     **/
+    ease?: boolean;
+}
+export declare const MouseParallax: import("vue").DefineComponent<MouseParallaxProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<MouseParallaxProps>, {}, {}>;

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

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

package/dist/core/controls/MapControls.vue.d.ts

@@ -57,5 +57,5 @@ declare const _sfc_main: import("vue").DefineComponent<{
     };
 }>>, {
     makeDefault: boolean | undefined;
-}>;
+}, {}>;
 export default _sfc_main;

package/dist/core/controls/OrbitControls.vue.d.ts

@@ -1,6 +1,6 @@
 import type { PropType as __PropType } from 'vue';
-import { Camera, Vector3 } from 'three';
-import { type Ref } from 'vue';
+import { Camera } from 'three';
+import { TresVector3 } from '@tresjs/core';
 export interface OrbitControlsProps {
     /**
      * Whether to make this the default controls.
@@ -8,7 +8,6 @@ export interface OrbitControlsProps {
      * @default false
      * @type {boolean}
      * @memberof OrbitControlsProps
-     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls
      */
     makeDefault?: boolean;
     /**
@@ -16,7 +15,7 @@ export interface OrbitControlsProps {
      *
      * @type {Camera}
      * @memberof OrbitControlsProps
-     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.camera
      */
     camera?: Camera;
     /**
@@ -24,32 +23,210 @@ export interface OrbitControlsProps {
      *
      * @type {HTMLElement}
      * @memberof OrbitControlsProps
-     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.domElement
      */
     domElement?: HTMLElement;
     /**
      * The target to orbit around.
      *
-     * @type {Ref<Vector3>}
+     * @type {TresVector3}
      * @memberof OrbitControlsProps
-     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.target
      */
-    target?: Ref<Vector3>;
+    target?: TresVector3;
     /**
-     * Whether to enable damping.
+     * Whether to enable damping (inertia)
      *
      * @default false
      * @type {boolean}
      * @memberof OrbitControlsProps
-     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.enableDamping
      */
     enableDamping?: boolean;
+    /**
+     * The damping inertia used if `.enableDamping` is set to true
+     *
+     * @default 0.05
+     * @type {number}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.dampingFactor
+     */
+    dampingFactor?: number;
+    /**
+     * Set to true to automatically rotate around the target.
+     *
+     * @default false
+     * @type {boolean}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.autoRotate
+     */
+    autoRotate?: boolean;
+    /**
+     * How fast to rotate around the target if `.autoRotate` is true.
+     *
+     * @default 2
+     * @type {number}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.autoRotateSpeed
+     */
+    autoRotateSpeed?: number;
+    /**
+     * Whether to enable panning.
+     *
+     * @default true
+     * @type {boolean}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.enablePan
+     */
+    enablePan?: boolean;
+    /**
+     * How fast to pan the camera when the keyboard is used. Default is 7.0 pixels per keypress.
+     *
+     * @default 7.0
+     * @type {number}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.keyPanSpeed
+     */
+    keyPanSpeed?: number;
+    /**
+     * This object contains references to the keycodes for controlling camera panning.
+     * Default is the 4 arrow keys.
+     *
+     * @default `{ LEFT: 'ArrowLeft', UP: 'ArrowUp', RIGHT: 'ArrowRight', BOTTOM: 'ArrowDown' }`
+     * @type Record<string, string>
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.keys
+     */
+    keys?: Record<string, string>;
+    /**
+     * How far you can orbit horizontally, upper limit.
+     * If set, the interval [ min, max ] must be a sub-interval of [ - 2 PI, 2 PI ],
+     * with ( max - min < 2 PI ). Default is Infinity.
+     *
+     * @default Infinity
+     * @type {number}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/index.html?q=orbi#examples/en/controls/OrbitControls.maxAzimuthAngle
+     */
+    maxAzimuthAngle?: number;
+    /**
+     * How far you can orbit horizontally, lower limit.
+     * If set, the interval [ min, max ] must be a sub-interval of [ - 2 PI, 2 PI ],
+     * with ( max - min < 2 PI ).
+     * Default is - Infinity.
+     *
+     * @default -Infinity
+     * @type {number}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/index.html?q=orbi#examples/en/controls/OrbitControls.minAzimuthAngle
+     */
+    minAzimuthAngle?: number;
+    /**
+     * How far you can orbit vertically, upper limit.
+     * Range is 0 to Math.PI radians, and default is Math.PI.
+     *
+     * @default Math.PI
+     * @type {number}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/index.html?q=orbi#examples/en/controls/OrbitControls.maxPolarAngle
+     */
+    maxPolarAngle?: number;
+    /**
+     * How far you can orbit vertically, lower limit.
+     * Range is 0 to Math.PI radians, and default is 0.
+     *
+     * @default 0
+     * @type {number}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/index.html?q=orbi#examples/en/controls/OrbitControls.minPolarAngle
+     */
+    minPolarAngle?: number;
+    /**
+     * The minimum distance of the camera to the target.
+     * Default is 0.
+     *
+     * @default 0
+     * @type {number}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/index.html?q=orbi#examples/en/controls/OrbitControls.minDistance
+     */
+    minDistance?: number;
+    /**
+     * The maximum distance of the camera to the target.
+     * Default is Infinity.
+     *
+     * @default Infinity
+     * @type {number}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/index.html?q=orbi#examples/en/controls/OrbitControls.maxDistance
+     */
+    maxDistance?: number;
+    /**
+     * The minimum field of view angle, in radians.
+     * Default is 0.
+     *
+     * @default 0
+     * @type {number}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/index.html?q=orbi#examples/en/controls/OrbitControls.minZoom
+     */
+    minZoom?: number;
+    /**
+     * The maximum field of view angle, in radians.
+     * ( OrthographicCamera only ).
+     * Default is Infinity.
+     *
+     * @default Infinity
+     * @type {number}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/index.html?q=orbi#examples/en/controls/OrbitControls.maxZoom
+     */
+    maxZoom?: number;
+    touches?: {
+        ONE?: number;
+        TWO?: number;
+    };
+    /**
+     * Whether to enable zooming.
+     *
+     * @default true
+     * @type {boolean}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.enableZoom
+     */
+    enableZoom?: boolean;
+    /**
+     * How fast to zoom in and out. Default is 1.
+     *
+     * @default 1
+     * @type {number}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.zoomSpeed
+     */
+    zoomSpeed?: number;
+    /**
+     * Whether to enable rotating.
+     *
+     * @default true
+     * @type {boolean}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.enableRotate
+     */
+    enableRotate?: boolean;
+    /**
+     * How fast to rotate around the target. Default is 1.
+     *
+     * @default 1
+     * @type {number}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.rotateSpeed
+     */
+    rotateSpeed?: number;
 }
 declare const _sfc_main: import("vue").DefineComponent<{
     makeDefault: {
         type: __PropType<boolean | undefined>;
         required: false;
-        default: boolean;
     };
     camera: {
         type: __PropType<Camera | undefined>;
@@ -60,18 +237,96 @@ declare const _sfc_main: import("vue").DefineComponent<{
         required: false;
     };
     target: {
-        type: __PropType<Ref<Vector3> | undefined>;
+        type: __PropType<number | import("three").Vector3 | import("@tresjs/core").VectorCoordinates | [x: number, y: number, z: number] | undefined>;
         required: false;
     };
     enableDamping: {
         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<{
+    dampingFactor: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    autoRotate: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    autoRotateSpeed: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    enablePan: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    keyPanSpeed: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    keys: {
+        type: __PropType<Record<string, string> | undefined>;
+        required: false;
+    };
+    maxAzimuthAngle: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    minAzimuthAngle: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    maxPolarAngle: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    minPolarAngle: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    minDistance: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    maxDistance: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    minZoom: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    maxZoom: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    touches: {
+        type: __PropType<{
+            ONE?: number | undefined;
+            TWO?: number | undefined;
+        } | undefined>;
+        required: false;
+    };
+    enableZoom: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    zoomSpeed: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    enableRotate: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    rotateSpeed: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("change" | "start" | "end")[], "change" | "start" | "end", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     makeDefault: {
         type: __PropType<boolean | undefined>;
         required: false;
-        default: boolean;
     };
     camera: {
         type: __PropType<Camera | undefined>;
@@ -82,14 +337,95 @@ declare const _sfc_main: import("vue").DefineComponent<{
         required: false;
     };
     target: {
-        type: __PropType<Ref<Vector3> | undefined>;
+        type: __PropType<number | import("three").Vector3 | import("@tresjs/core").VectorCoordinates | [x: number, y: number, z: number] | undefined>;
         required: false;
     };
     enableDamping: {
         type: __PropType<boolean | undefined>;
         required: false;
     };
-}>>, {
-    makeDefault: boolean | undefined;
-}>;
+    dampingFactor: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    autoRotate: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    autoRotateSpeed: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    enablePan: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    keyPanSpeed: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    keys: {
+        type: __PropType<Record<string, string> | undefined>;
+        required: false;
+    };
+    maxAzimuthAngle: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    minAzimuthAngle: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    maxPolarAngle: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    minPolarAngle: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    minDistance: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    maxDistance: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    minZoom: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    maxZoom: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    touches: {
+        type: __PropType<{
+            ONE?: number | undefined;
+            TWO?: number | undefined;
+        } | undefined>;
+        required: false;
+    };
+    enableZoom: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    zoomSpeed: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+    enableRotate: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    rotateSpeed: {
+        type: __PropType<number | undefined>;
+        required: false;
+    };
+}>> & {
+    onChange?: ((...args: any[]) => any) | undefined;
+    onStart?: ((...args: any[]) => any) | undefined;
+    onEnd?: ((...args: any[]) => any) | undefined;
+}, {}, {}>;
 export default _sfc_main;