@tresjs/cientos 3.4.0 → 3.5.0

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

@@ -0,0 +1,167 @@
+export interface KeyboardControlsProps {
+    /**
+     * Keys to go forward.
+     * @type {string[]}
+     * @default '[w, W]'
+     * @memberof KeyboardControlsProps
+     *
+     **/
+    forward?: string[] | string;
+    /**
+     * Keys to go back.
+     * @type {string[]}
+     * @default '[s, S]'
+     * @memberof KeyboardControlsProps
+     *
+     **/
+    back?: string[] | string;
+    /**
+     * Keys to go left.
+     * @type {string[]}
+     * @default '[a, A]'
+     * @memberof KeyboardControlsProps
+     *
+     **/
+    left?: string[] | string;
+    /**
+     * Keys to go right.
+     * @type {string[]}
+     * @default '[d, D]'
+     * @memberof KeyboardControlsProps
+     *
+     **/
+    right?: string[] | string;
+    /**
+     * Key to jump (only with PointerLockControls).
+     * @type {string[]}
+     * @default 'space'
+     * @memberof KeyboardControlsProps
+     *
+     **/
+    jump?: string[] | string;
+    /**
+     * Default gravity number for jump.
+     * @type {number}
+     * @default 9.8
+     * @memberof KeyboardControlsProps
+     *
+     **/
+    gravity?: number;
+    /**
+     * Speed movement.
+     * @type {number}
+     * @default 0.1
+     * @memberof KeyboardControlsProps
+     *
+     **/
+    moveSpeed?: number;
+    /**
+     * Activate/deactivate headBobbing effect (only with PointerLockControls).
+     * @type {boolean}
+     * @default false
+     * @memberof KeyboardControlsProps
+     *
+     **/
+    headBobbing?: boolean;
+    /**
+     * Indicates if the forward movement is in the Z axis or Y axis.
+     * @type {boolean}
+     * @default false
+     * @memberof KeyboardControlsProps
+     *
+     **/
+    is2D?: boolean;
+}
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    forward: {
+        type: import("vue").PropType<string | string[]>;
+        default: () => string[];
+    };
+    back: {
+        type: import("vue").PropType<string | string[]>;
+        default: () => string[];
+    };
+    left: {
+        type: import("vue").PropType<string | string[]>;
+        default: () => string[];
+    };
+    right: {
+        type: import("vue").PropType<string | string[]>;
+        default: () => string[];
+    };
+    jump: {
+        type: import("vue").PropType<string | string[]>;
+        default: () => string[];
+    };
+    gravity: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    moveSpeed: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    headBobbing: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    is2D: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    forward: {
+        type: import("vue").PropType<string | string[]>;
+        default: () => string[];
+    };
+    back: {
+        type: import("vue").PropType<string | string[]>;
+        default: () => string[];
+    };
+    left: {
+        type: import("vue").PropType<string | string[]>;
+        default: () => string[];
+    };
+    right: {
+        type: import("vue").PropType<string | string[]>;
+        default: () => string[];
+    };
+    jump: {
+        type: import("vue").PropType<string | string[]>;
+        default: () => string[];
+    };
+    gravity: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    moveSpeed: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    headBobbing: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    is2D: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+}>>, {
+    forward: string | string[];
+    back: string | string[];
+    left: string | string[];
+    right: string | string[];
+    jump: string | string[];
+    gravity: number;
+    moveSpeed: number;
+    headBobbing: boolean;
+    is2D: boolean;
+}, {}>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,54 @@
+import type { Camera } from 'three';
+export interface MapControlsProps {
+    /**
+     * Whether to make this the default controls.
+     *
+     * @default false
+     * @type {boolean}
+     * @memberof MapControlsProps
+     * @see https://threejs.org/docs/#examples/en/controls/MapControls
+     */
+    makeDefault?: boolean;
+    /**
+     * The camera to control.
+     *
+     * @type {Camera}
+     * @memberof MapControlsProps
+     * @see https://threejs.org/docs/#examples/en/controls/MapControls
+     */
+    camera?: Camera;
+    /**
+     * The dom element to listen to.
+     *
+     * @type {HTMLElement}
+     * @memberof MapControlsProps
+     * @see https://threejs.org/docs/#examples/en/controls/MapControls
+     */
+    domElement?: HTMLElement;
+}
+declare const _default: import("vue").DefineComponent<{
+    camera: {
+        type: import("vue").PropType<Camera>;
+    };
+    makeDefault: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    domElement: {
+        type: import("vue").PropType<HTMLElement>;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    camera: {
+        type: import("vue").PropType<Camera>;
+    };
+    makeDefault: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    domElement: {
+        type: import("vue").PropType<HTMLElement>;
+    };
+}>>, {
+    makeDefault: boolean;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,456 @@
+import type { Camera } from 'three';
+import { TOUCH } from 'three';
+import type { TresVector3 } from '@tresjs/core';
+export interface OrbitControlsProps {
+    /**
+     * Whether to make this the default controls.
+     *
+     * @default false
+     * @type {boolean}
+     * @memberof OrbitControlsProps
+     */
+    makeDefault?: boolean;
+    /**
+     * The camera to control.
+     *
+     * @type {Camera}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.camera
+     */
+    camera?: Camera;
+    /**
+     * The dom element to listen to.
+     *
+     * @type {HTMLElement}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.domElement
+     */
+    domElement?: HTMLElement;
+    /**
+     * The target to orbit around.
+     *
+     * @type {TresVector3}
+     * @memberof OrbitControlsProps
+     * @see https://threejs.org/docs/#examples/en/controls/OrbitControls.target
+     */
+    target?: TresVector3;
+    /**
+     * Whether to enable damping (inertia)
+     *
+     * @default false
+     * @type {boolean}
+     * @memberof OrbitControlsProps
+     * @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 | undefined;
+        TWO?: number | undefined;
+    };
+    /**
+     * 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 _default: import("vue").DefineComponent<{
+    keys: {
+        type: import("vue").PropType<Record<string, string>>;
+    };
+    camera: {
+        type: import("vue").PropType<Camera>;
+    };
+    target: {
+        type: import("vue").PropType<number | import("three").Vector3 | import("@tresjs/core").VectorCoordinates | [x: number, y: number, z: number]>;
+        default: () => number[];
+    };
+    makeDefault: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    domElement: {
+        type: import("vue").PropType<HTMLElement>;
+    };
+    minPolarAngle: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    maxPolarAngle: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    minAzimuthAngle: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    maxAzimuthAngle: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    minDistance: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    maxDistance: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    minZoom: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    maxZoom: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    touches: {
+        type: import("vue").PropType<{
+            ONE?: number | undefined;
+            TWO?: number | undefined;
+        }>;
+        default: () => {
+            ONE: TOUCH;
+            TWO: TOUCH;
+        };
+    };
+    dampingFactor: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    enableDamping: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    enableZoom: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    zoomSpeed: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    enableRotate: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    rotateSpeed: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    enablePan: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    keyPanSpeed: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    autoRotate: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    autoRotateSpeed: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+}, {}, 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<{
+    keys: {
+        type: import("vue").PropType<Record<string, string>>;
+    };
+    camera: {
+        type: import("vue").PropType<Camera>;
+    };
+    target: {
+        type: import("vue").PropType<number | import("three").Vector3 | import("@tresjs/core").VectorCoordinates | [x: number, y: number, z: number]>;
+        default: () => number[];
+    };
+    makeDefault: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    domElement: {
+        type: import("vue").PropType<HTMLElement>;
+    };
+    minPolarAngle: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    maxPolarAngle: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    minAzimuthAngle: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    maxAzimuthAngle: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    minDistance: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    maxDistance: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    minZoom: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    maxZoom: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    touches: {
+        type: import("vue").PropType<{
+            ONE?: number | undefined;
+            TWO?: number | undefined;
+        }>;
+        default: () => {
+            ONE: TOUCH;
+            TWO: TOUCH;
+        };
+    };
+    dampingFactor: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    enableDamping: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    enableZoom: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    zoomSpeed: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    enableRotate: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    rotateSpeed: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    enablePan: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    keyPanSpeed: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+    autoRotate: {
+        type: import("vue").PropType<boolean>;
+        default: boolean;
+    };
+    autoRotateSpeed: {
+        type: import("vue").PropType<number>;
+        default: number;
+    };
+}>> & {
+    onChange?: ((...args: any[]) => any) | undefined;
+    onStart?: ((...args: any[]) => any) | undefined;
+    onEnd?: ((...args: any[]) => any) | undefined;
+}, {
+    target: number | import("three").Vector3 | import("@tresjs/core").VectorCoordinates | [x: number, y: number, z: number];
+    makeDefault: boolean;
+    minPolarAngle: number;
+    maxPolarAngle: number;
+    minAzimuthAngle: number;
+    maxAzimuthAngle: number;
+    minDistance: number;
+    maxDistance: number;
+    minZoom: number;
+    maxZoom: number;
+    touches: {
+        ONE?: number | undefined;
+        TWO?: number | undefined;
+    };
+    dampingFactor: number;
+    enableDamping: boolean;
+    enableZoom: boolean;
+    zoomSpeed: number;
+    enableRotate: boolean;
+    rotateSpeed: number;
+    enablePan: boolean;
+    keyPanSpeed: number;
+    autoRotate: boolean;
+    autoRotateSpeed: number;
+}, {}>;
+export default _default;