@webspatial/react-sdk 1.2.0 → 1.3.0

package/dist/default/index.d.ts

@@ -1,4 +1,5 @@
-import { SpatialSceneCreationOptions, SpatialSceneType, SpatialTapEvent as SpatialTapEvent$1, SpatialDragStartEvent as SpatialDragStartEvent$1, SpatialDragEvent as SpatialDragEvent$1, SpatialDragEndEvent as SpatialDragEndEvent$1, SpatialRotateEvent as SpatialRotateEvent$1, SpatialRotateEndEvent as SpatialRotateEndEvent$1, SpatialMagnifyEvent as SpatialMagnifyEvent$1, SpatialMagnifyEndEvent as SpatialMagnifyEndEvent$1, SpatializedElement, Point3D, SpatialObject, SpatialSession, SpatializedDynamic3DElement, Vec3, SpatialEntity, SpatialBoxGeometryOptions, SpatialUnlitMaterialOptions, SpatialSphereGeometryOptions, SpatialConeGeometryOptions, SpatialCylinderGeometryOptions, SpatialPlaneGeometryOptions } from '@webspatial/core-sdk';
+import * as _webspatial_core_sdk from '@webspatial/core-sdk';
+import { SpatialSceneCreationOptions, SpatialSceneType, SpatialTapEvent as SpatialTapEvent$1, SpatialDragStartEvent as SpatialDragStartEvent$1, SpatialDragEvent as SpatialDragEvent$1, SpatialDragEndEvent as SpatialDragEndEvent$1, SpatialRotateEvent as SpatialRotateEvent$1, SpatialRotateEndEvent as SpatialRotateEndEvent$1, SpatialMagnifyEvent as SpatialMagnifyEvent$1, SpatialMagnifyEndEvent as SpatialMagnifyEndEvent$1, SpatializedElement, Point3D, SpatialObject, SpatialSession, SpatializedDynamic3DElement, Vec3, SpatialEntity, Quaternion, SpatialBoxGeometryOptions, SpatialUnlitMaterialOptions, SpatialSphereGeometryOptions, SpatialConeGeometryOptions, SpatialCylinderGeometryOptions, SpatialPlaneGeometryOptions } from '@webspatial/core-sdk';
 export { Point3D, Vec3 } from '@webspatial/core-sdk';
 import * as React$1 from 'react';
 import React__default, { ElementType, ForwardedRef } from 'react';
@@ -70,17 +71,31 @@ type SpatialTapEvent<T extends SpatializedElementRef = SpatializedElementRef> =
     readonly offsetX: number;
     readonly offsetY: number;
     readonly offsetZ: number;
+    readonly clientX: number;
+    readonly clientY: number;
+    readonly clientZ: number;
 };
 type SpatialDragStartEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialDragStartEvent$1 & CurrentTarget<T> & {
     readonly offsetX: number;
     readonly offsetY: number;
     readonly offsetZ: number;
+    readonly clientX: number;
+    readonly clientY: number;
+    readonly clientZ: number;
+};
+type SpatialDragEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialDragEvent$1 & CurrentTarget<T> & {
+    readonly translationX: number;
+    readonly translationY: number;
+    readonly translationZ: number;
 };
-type SpatialDragEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialDragEvent$1 & CurrentTarget<T>;
 type SpatialDragEndEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialDragEndEvent$1 & CurrentTarget<T>;
-type SpatialRotateEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialRotateEvent$1 & CurrentTarget<T>;
+type SpatialRotateEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialRotateEvent$1 & CurrentTarget<T> & {
+    readonly quaternion: _webspatial_core_sdk.Quaternion;
+};
 type SpatialRotateEndEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialRotateEndEvent$1 & CurrentTarget<T>;
-type SpatialMagnifyEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialMagnifyEvent$1 & CurrentTarget<T>;
+type SpatialMagnifyEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialMagnifyEvent$1 & CurrentTarget<T> & {
+    readonly magnification: number;
+};
 type SpatialMagnifyEndEvent<T extends SpatializedElementRef = SpatializedElementRef> = SpatialMagnifyEndEvent$1 & CurrentTarget<T>;
 type ModelSpatialTapEvent = SpatialTapEvent<SpatializedStatic3DElementRef>;
 type ModelSpatialDragStartEvent = SpatialDragStartEvent<SpatializedStatic3DElementRef>;
@@ -140,10 +155,23 @@ declare class ResourceRegistry {
     destroy(): void;
 }
 
+type ContainersChangeCallback = (containers: HTMLElement[]) => void;
+declare class AttachmentRegistry {
+    private containers;
+    private listeners;
+    addContainer(name: string, instanceId: string, container: HTMLElement): void;
+    removeContainer(name: string, instanceId: string): void;
+    getContainers(name: string): HTMLElement[];
+    onContainersChange(name: string, cb: ContainersChangeCallback): () => void;
+    private notifyListeners;
+    destroy(): void;
+}
+
 type RealityContextValue = {
     session: SpatialSession;
     reality: SpatializedDynamic3DElement;
     resourceRegistry: ResourceRegistry;
+    attachmentRegistry: AttachmentRegistry;
 } | null;
 
 interface EntityRefShape {
@@ -184,17 +212,31 @@ type SpatialTapEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialT
     readonly offsetX: number;
     readonly offsetY: number;
     readonly offsetZ: number;
+    readonly clientX: number;
+    readonly clientY: number;
+    readonly clientZ: number;
 };
 type SpatialDragStartEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialDragStartEvent$1 & allTarget<T> & {
     readonly offsetX: number;
     readonly offsetY: number;
     readonly offsetZ: number;
+    readonly clientX: number;
+    readonly clientY: number;
+    readonly clientZ: number;
+};
+type SpatialDragEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialDragEvent$1 & allTarget<T> & {
+    readonly translationX: number;
+    readonly translationY: number;
+    readonly translationZ: number;
 };
-type SpatialDragEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialDragEvent$1 & allTarget<T>;
 type SpatialDragEndEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialDragEndEvent$1 & allTarget<T>;
-type SpatialRotateEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialRotateEvent$1 & allTarget<T>;
+type SpatialRotateEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialRotateEvent$1 & allTarget<T> & {
+    readonly quaternion: Quaternion;
+};
 type SpatialRotateEndEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialRotateEndEvent$1 & allTarget<T>;
-type SpatialMagnifyEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialMagnifyEvent$1 & allTarget<T>;
+type SpatialMagnifyEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialMagnifyEvent$1 & allTarget<T> & {
+    readonly magnification: number;
+};
 type SpatialMagnifyEndEntityEvent<T extends EntityRefShape = EntityRefShape> = SpatialMagnifyEndEvent$1 & allTarget<T>;
 type EntityEventHandler = {
     onSpatialTap?: (event: SpatialTapEntityEvent) => void;
@@ -276,6 +318,22 @@ declare const ModelEntity: React__default.ForwardRefExoticComponent<EntityProps
 
 declare const Reality: React__default.ForwardRefExoticComponent<Omit<RealityProps, "ref"> & React__default.RefAttributes<HTMLElement>>;
 
+type AttachmentAssetProps = {
+    name: string;
+    children?: React__default.ReactNode;
+};
+declare const AttachmentAsset: React__default.FC<AttachmentAssetProps>;
+
+interface AttachmentEntityProps {
+    attachment: string;
+    position?: [number, number, number];
+    size: {
+        width: number;
+        height: number;
+    };
+}
+declare const AttachmentEntity: React__default.FC<AttachmentEntityProps>;
+
 type ModelProps = SpatializedStatic3DContainerProps & {
     'enable-xr'?: boolean;
 };
@@ -304,4 +362,4 @@ declare const SSRProvider: ({ isSSR: initialIsSSR, children, }: {
 
 declare const version: string;
 
-export { BoxEntity, ConeEntity, CylinderEntity, Entity, type EntityEventHandler, type EntityProps, EntityRef, Model, ModelAsset, ModelEntity, type ModelLoadEvent, type ModelProps, type ModelRef, type ModelSpatialDragEndEvent, type ModelSpatialDragEvent, type ModelSpatialDragStartEvent, type ModelSpatialMagnifyEndEvent, type ModelSpatialMagnifyEvent, type ModelSpatialRotateEndEvent, type ModelSpatialRotateEvent, type ModelSpatialTapEvent, PlaneEntity, Reality, SSRProvider, SceneGraph, type SpatialDragEndEntityEvent, type SpatialDragEndEvent, type SpatialDragEntityEvent, type SpatialDragEvent, type SpatialDragStartEntityEvent, type SpatialDragStartEvent, type SpatialMagnifyEndEntityEvent, type SpatialMagnifyEndEvent, type SpatialMagnifyEntityEvent, type SpatialMagnifyEvent, SpatialMonitor, type SpatialRotateEndEntityEvent, type SpatialRotateEndEvent, type SpatialRotateEntityEvent, type SpatialRotateEvent, type SpatialTapEntityEvent, type SpatialTapEvent, Spatialized2DElementContainer, type Spatialized2DElementContainerProps, SpatializedContainer, type SpatializedElementRef, type SpatializedStatic3DContainerProps, SpatializedStatic3DElementContainer, type SpatializedStatic3DElementRef, SphereEntity, UnlitMaterial, enableDebugTool, eventMap, initPolyfill, initScene, toLocalSpace, toSceneSpatial, version, withSpatialMonitor, withSpatialized2DElementContainer };
+export { AttachmentAsset, AttachmentEntity, BoxEntity, ConeEntity, CylinderEntity, Entity, type EntityEventHandler, type EntityProps, EntityRef, Model, ModelAsset, ModelEntity, type ModelLoadEvent, type ModelProps, type ModelRef, type ModelSpatialDragEndEvent, type ModelSpatialDragEvent, type ModelSpatialDragStartEvent, type ModelSpatialMagnifyEndEvent, type ModelSpatialMagnifyEvent, type ModelSpatialRotateEndEvent, type ModelSpatialRotateEvent, type ModelSpatialTapEvent, PlaneEntity, Reality, SSRProvider, SceneGraph, type SpatialDragEndEntityEvent, type SpatialDragEndEvent, type SpatialDragEntityEvent, type SpatialDragEvent, type SpatialDragStartEntityEvent, type SpatialDragStartEvent, type SpatialMagnifyEndEntityEvent, type SpatialMagnifyEndEvent, type SpatialMagnifyEntityEvent, type SpatialMagnifyEvent, SpatialMonitor, type SpatialRotateEndEntityEvent, type SpatialRotateEndEvent, type SpatialRotateEntityEvent, type SpatialRotateEvent, type SpatialTapEntityEvent, type SpatialTapEvent, Spatialized2DElementContainer, type Spatialized2DElementContainerProps, SpatializedContainer, type SpatializedElementRef, type SpatializedStatic3DContainerProps, SpatializedStatic3DElementContainer, type SpatializedStatic3DElementRef, SphereEntity, UnlitMaterial, enableDebugTool, eventMap, initPolyfill, initScene, toLocalSpace, toSceneSpatial, version, withSpatialMonitor, withSpatialized2DElementContainer };