@shopware-ag/dive 1.1.2 → 1.3.0

package/build/dive.d.cts

@@ -1,4 +1,4 @@
-import { ShadowMapType, ToneMapping, WebGLRenderer, Scene, Camera, PerspectiveCamera, Vector3Like, Mesh, ColorRepresentation, Object3D } from 'three';
+import { ShadowMapType, ToneMapping, WebGLRenderer, Scene, Camera, PerspectiveCamera, Vector3Like, Mesh, ColorRepresentation, Object3D, Intersection, Vector2, Raycaster, Vector3 } from 'three';
 import { OrbitControls } from 'three/examples/jsm/Addons.js';
 
 type DIVERendererSettings = {
@@ -272,10 +272,9 @@ interface GET_ALL_OBJECTS {
 
 interface GET_OBJECTS {
     'PAYLOAD': {
-        map: Map<string, COMEntity>;
-        ids?: string[];
+        ids: string[];
     };
-    'RETURN': Map<string, COMEntity>;
+    'RETURN': COMEntity[];
 }
 
 interface ADD_OBJECT {
@@ -363,6 +362,13 @@ interface GET_CAMERA_TRANSFORM {
     };
 }
 
+interface DROP_IT {
+    'PAYLOAD': {
+        id: string;
+    };
+    'RETURN': boolean;
+}
+
 type Actions = {
     GET_ALL_SCENE_DATA: GET_ALL_SCENE_DATA;
     GET_ALL_OBJECTS: GET_ALL_OBJECTS;
@@ -372,6 +378,7 @@ type Actions = {
     DELETE_OBJECT: DELETE_OBJECT;
     SELECT_OBJECT: SELECT_OBJECT;
     SET_BACKGROUND: SET_BACKGROUND;
+    DROP_IT: DROP_IT;
     PLACE_ON_FLOOR: PLACE_ON_FLOOR;
     SET_CAMERA_TRANSFORM: SET_CAMERA_TRANSFORM;
     GET_CAMERA_TRANSFORM: GET_CAMERA_TRANSFORM;
@@ -385,14 +392,62 @@ type Actions = {
     GENERATE_MEDIA: GENERATE_MEDIA;
 };
 
+interface DIVEDraggable {
+    isDraggable: true;
+    onDragStart?: (e: DraggableEvent) => void;
+    onDrag?: (e: DraggableEvent) => void;
+    onDragEnd?: (e: DraggableEvent) => void;
+}
+
+interface DIVEHoverable {
+    isHoverable: true;
+    onPointerEnter?: (i: Intersection) => void;
+    onPointerOver?: (i: Intersection) => void;
+    onPointerLeave?: () => void;
+}
+
+type DraggableEvent = {
+    dragStart: Vector3;
+    dragCurrent: Vector3;
+    dragEnd: Vector3;
+    dragDelta: Vector3;
+};
 declare abstract class DIVEBaseTool {
-    protected name: string;
-    protected constructor();
+    readonly POINTER_DRAG_THRESHOLD: number;
+    name: string;
+    protected _canvas: HTMLElement;
+    protected _scene: DIVEScene;
+    protected _controller: DIVEOrbitControls;
+    protected _pointer: Vector2;
+    protected get _pointerAnyDown(): boolean;
+    protected _pointerPrimaryDown: boolean;
+    protected _pointerMiddleDown: boolean;
+    protected _pointerSecondaryDown: boolean;
+    protected _lastPointerDown: Vector2;
+    protected _lastPointerUp: Vector2;
+    protected _raycaster: Raycaster;
+    protected _intersects: Intersection[];
+    protected _hovered: (Object3D & DIVEHoverable) | null;
+    protected _dragging: boolean;
+    protected _dragStart: Vector3;
+    protected _dragCurrent: Vector3;
+    protected _dragEnd: Vector3;
+    protected _dragDelta: Vector3;
+    protected _draggable: DIVEDraggable | null;
+    protected _dragRaycastOnObjects: Object3D[] | null;
+    protected constructor(scene: DIVEScene, controller: DIVEOrbitControls);
     Activate(): void;
     Deactivate(): void;
     onPointerDown(e: PointerEvent): void;
+    onDragStart(e: PointerEvent): void;
+    onPointerMove(e: PointerEvent): void;
+    onDrag(e: PointerEvent): void;
     onPointerUp(e: PointerEvent): void;
+    onClick(e: PointerEvent): void;
+    onDragEnd(e: PointerEvent): void;
     onWheel(e: WheelEvent): void;
+    protected raycast(objects?: Object3D[]): Intersection[];
+    private pointerWasDragged;
 }
 
 /**
@@ -410,6 +465,7 @@ declare class DIVEToolbox {
     GetActiveTool(): DIVEBaseTool;
     UseTool(tool: string): void;
     SetGizmoMode(mode: 'translate' | 'rotate' | 'scale'): void;
+    onPointerMove(e: PointerEvent): void;
     onPointerDown(e: PointerEvent): void;
     onPointerUp(e: PointerEvent): void;
     onWheel(e: WheelEvent): void;
@@ -473,6 +529,7 @@ declare class DIVECommunication {
     private deleteObject;
     private selectObject;
     private setBackground;
+    private dropIt;
     private placeOnFloor;
     private setCameraTransform;
     private getCameraTransform;
@@ -492,6 +549,15 @@ declare function floorExp(number: number, decimals?: number): number;
 
 declare function roundExponential(number: number, decimals?: number): number;
 
+/**
+ * Calculate the signed angle between two vectors. Only works when the vectors are on the same plane.
+ * @param vecB Start Vector
+ * @param vecA Target Vector
+ * @param planeNormal The vector's plane normal
+ * @returns Signed angle in radians
+ */
+declare function signedAngleTo(vecA: Vector3, vecB: Vector3, planeNormal: Vector3): number;
+
 declare function toFixedExp(number: number, decimals?: number): string;
 
 declare function truncateExp(number: number, decimals?: number): number;
@@ -502,6 +568,7 @@ declare const DIVEMath: {
     roundExp: typeof roundExponential;
     toFixedExp: typeof toFixedExp;
     truncateExp: typeof truncateExp;
+    signedAngleTo: typeof signedAngleTo;
 };
 
 type DIVESettings = {

package/build/dive.d.ts

@@ -1,4 +1,4 @@
-import { ShadowMapType, ToneMapping, WebGLRenderer, Scene, Camera, PerspectiveCamera, Vector3Like, Mesh, ColorRepresentation, Object3D } from 'three';
+import { ShadowMapType, ToneMapping, WebGLRenderer, Scene, Camera, PerspectiveCamera, Vector3Like, Mesh, ColorRepresentation, Object3D, Intersection, Vector2, Raycaster, Vector3 } from 'three';
 import { OrbitControls } from 'three/examples/jsm/Addons.js';
 
 type DIVERendererSettings = {
@@ -272,10 +272,9 @@ interface GET_ALL_OBJECTS {
 
 interface GET_OBJECTS {
     'PAYLOAD': {
-        map: Map<string, COMEntity>;
-        ids?: string[];
+        ids: string[];
     };
-    'RETURN': Map<string, COMEntity>;
+    'RETURN': COMEntity[];
 }
 
 interface ADD_OBJECT {
@@ -363,6 +362,13 @@ interface GET_CAMERA_TRANSFORM {
     };
 }
 
+interface DROP_IT {
+    'PAYLOAD': {
+        id: string;
+    };
+    'RETURN': boolean;
+}
+
 type Actions = {
     GET_ALL_SCENE_DATA: GET_ALL_SCENE_DATA;
     GET_ALL_OBJECTS: GET_ALL_OBJECTS;
@@ -372,6 +378,7 @@ type Actions = {
     DELETE_OBJECT: DELETE_OBJECT;
     SELECT_OBJECT: SELECT_OBJECT;
     SET_BACKGROUND: SET_BACKGROUND;
+    DROP_IT: DROP_IT;
     PLACE_ON_FLOOR: PLACE_ON_FLOOR;
     SET_CAMERA_TRANSFORM: SET_CAMERA_TRANSFORM;
     GET_CAMERA_TRANSFORM: GET_CAMERA_TRANSFORM;
@@ -385,14 +392,62 @@ type Actions = {
     GENERATE_MEDIA: GENERATE_MEDIA;
 };
 
+interface DIVEDraggable {
+    isDraggable: true;
+    onDragStart?: (e: DraggableEvent) => void;
+    onDrag?: (e: DraggableEvent) => void;
+    onDragEnd?: (e: DraggableEvent) => void;
+}
+
+interface DIVEHoverable {
+    isHoverable: true;
+    onPointerEnter?: (i: Intersection) => void;
+    onPointerOver?: (i: Intersection) => void;
+    onPointerLeave?: () => void;
+}
+
+type DraggableEvent = {
+    dragStart: Vector3;
+    dragCurrent: Vector3;
+    dragEnd: Vector3;
+    dragDelta: Vector3;
+};
 declare abstract class DIVEBaseTool {
-    protected name: string;
-    protected constructor();
+    readonly POINTER_DRAG_THRESHOLD: number;
+    name: string;
+    protected _canvas: HTMLElement;
+    protected _scene: DIVEScene;
+    protected _controller: DIVEOrbitControls;
+    protected _pointer: Vector2;
+    protected get _pointerAnyDown(): boolean;
+    protected _pointerPrimaryDown: boolean;
+    protected _pointerMiddleDown: boolean;
+    protected _pointerSecondaryDown: boolean;
+    protected _lastPointerDown: Vector2;
+    protected _lastPointerUp: Vector2;
+    protected _raycaster: Raycaster;
+    protected _intersects: Intersection[];
+    protected _hovered: (Object3D & DIVEHoverable) | null;
+    protected _dragging: boolean;
+    protected _dragStart: Vector3;
+    protected _dragCurrent: Vector3;
+    protected _dragEnd: Vector3;
+    protected _dragDelta: Vector3;
+    protected _draggable: DIVEDraggable | null;
+    protected _dragRaycastOnObjects: Object3D[] | null;
+    protected constructor(scene: DIVEScene, controller: DIVEOrbitControls);
     Activate(): void;
     Deactivate(): void;
     onPointerDown(e: PointerEvent): void;
+    onDragStart(e: PointerEvent): void;
+    onPointerMove(e: PointerEvent): void;
+    onDrag(e: PointerEvent): void;
     onPointerUp(e: PointerEvent): void;
+    onClick(e: PointerEvent): void;
+    onDragEnd(e: PointerEvent): void;
     onWheel(e: WheelEvent): void;
+    protected raycast(objects?: Object3D[]): Intersection[];
+    private pointerWasDragged;
 }
 
 /**
@@ -410,6 +465,7 @@ declare class DIVEToolbox {
     GetActiveTool(): DIVEBaseTool;
     UseTool(tool: string): void;
     SetGizmoMode(mode: 'translate' | 'rotate' | 'scale'): void;
+    onPointerMove(e: PointerEvent): void;
     onPointerDown(e: PointerEvent): void;
     onPointerUp(e: PointerEvent): void;
     onWheel(e: WheelEvent): void;
@@ -473,6 +529,7 @@ declare class DIVECommunication {
     private deleteObject;
     private selectObject;
     private setBackground;
+    private dropIt;
     private placeOnFloor;
     private setCameraTransform;
     private getCameraTransform;
@@ -492,6 +549,15 @@ declare function floorExp(number: number, decimals?: number): number;
 
 declare function roundExponential(number: number, decimals?: number): number;
 
+/**
+ * Calculate the signed angle between two vectors. Only works when the vectors are on the same plane.
+ * @param vecB Start Vector
+ * @param vecA Target Vector
+ * @param planeNormal The vector's plane normal
+ * @returns Signed angle in radians
+ */
+declare function signedAngleTo(vecA: Vector3, vecB: Vector3, planeNormal: Vector3): number;
+
 declare function toFixedExp(number: number, decimals?: number): string;
 
 declare function truncateExp(number: number, decimals?: number): number;
@@ -502,6 +568,7 @@ declare const DIVEMath: {
     roundExp: typeof roundExponential;
     toFixedExp: typeof toFixedExp;
     truncateExp: typeof truncateExp;
+    signedAngleTo: typeof signedAngleTo;
 };
 
 type DIVESettings = {