@omnidotdev/rdk 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. package/build/engine/XRCanvas.d.ts +14 -0
  2. package/build/engine/XRCanvas.d.ts.map +1 -0
  3. package/build/engine/XRSessionProvider.d.ts +18 -0
  4. package/build/engine/XRSessionProvider.d.ts.map +1 -0
  5. package/build/engine/index.d.ts +2 -0
  6. package/build/engine/index.d.ts.map +1 -0
  7. package/build/fiducial/FiducialAnchor.d.ts +21 -0
  8. package/build/fiducial/FiducialAnchor.d.ts.map +1 -0
  9. package/build/fiducial/fiducialBackend.d.ts +19 -0
  10. package/build/fiducial/fiducialBackend.d.ts.map +1 -0
  11. package/build/fiducial/index.d.ts +3 -0
  12. package/build/fiducial/index.d.ts.map +1 -0
  13. package/build/index.cjs +51 -0
  14. package/build/index.d.ts +4 -0
  15. package/build/index.d.ts.map +1 -0
  16. package/build/index.js +5412 -0
  17. package/build/lib/types/xr/XRBackend.interface.d.ts +28 -0
  18. package/build/lib/types/xr/XRBackend.interface.d.ts.map +1 -0
  19. package/build/lib/types/xr/XRBackendInitArgs.interface.d.ts +14 -0
  20. package/build/lib/types/xr/XRBackendInitArgs.interface.d.ts.map +1 -0
  21. package/build/lib/types/xr/XRContextValue.interface.d.ts +15 -0
  22. package/build/lib/types/xr/XRContextValue.interface.d.ts.map +1 -0
  23. package/build/lib/types/xr/XRMode.type.d.ts +5 -0
  24. package/build/lib/types/xr/XRMode.type.d.ts.map +1 -0
  25. package/build/lib/types/xr/XRSessionOptions.type.d.ts +14 -0
  26. package/build/lib/types/xr/XRSessionOptions.type.d.ts.map +1 -0
  27. package/build/lib/types/xr/XRUtils.type.d.ts +62 -0
  28. package/build/lib/types/xr/XRUtils.type.d.ts.map +1 -0
  29. package/build/lib/types/xr/index.d.ts +6 -0
  30. package/build/lib/types/xr/index.d.ts.map +1 -0
  31. package/package.json +74 -0
@@ -0,0 +1,14 @@
1
+ import { CanvasProps } from '@react-three/fiber';
2
+ import { XRMode, XRSessionOptions } from 'lib/types/xr';
3
+ export interface XRCanvasProps<TMode extends XRMode = "fiducial"> extends CanvasProps {
4
+ /** Mode of extended reality. */
5
+ mode?: TMode;
6
+ /** Session options, forwarded to the corresponding backend. */
7
+ sessionOptions?: XRSessionOptions<TMode>;
8
+ }
9
+ /**
10
+ * Main extended reality canvas that initializes the context. This behaves as a scene root for end users.
11
+ */
12
+ declare const XRCanvas: <TMode extends XRMode = "fiducial">({ mode, sessionOptions, children, ...rest }: XRCanvasProps<TMode>) => import("react/jsx-runtime").JSX.Element;
13
+ export default XRCanvas;
14
+ //# sourceMappingURL=XRCanvas.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"XRCanvas.d.ts","sourceRoot":"","sources":["../../src/engine/XRCanvas.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAE7D,MAAM,WAAW,aAAa,CAAC,KAAK,SAAS,MAAM,GAAG,UAAU,CAC/D,SAAQ,WAAW;IACnB,gCAAgC;IAChC,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,+DAA+D;IAC/D,cAAc,CAAC,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;CACzC;AAED;;GAEG;AACH,QAAA,MAAM,QAAQ,GAAI,KAAK,SAAS,MAAM,GAAG,UAAU,EAAE,6CAKlD,aAAa,CAAC,KAAK,CAAC,4CAMtB,CAAC;AAEF,eAAe,QAAQ,CAAC"}
@@ -0,0 +1,18 @@
1
+ import { PropsWithChildren } from 'react';
2
+ import { XRContextValue, XRMode, XRSessionOptions } from 'lib/types/xr';
3
+ /**
4
+ * Use `XRSessionProvider` context.
5
+ */
6
+ export declare const useXR: () => XRContextValue;
7
+ interface XRSessionProviderProps<TMode extends XRMode = XRMode> extends PropsWithChildren {
8
+ /** Mode of extended reality. */
9
+ mode: TMode;
10
+ /** Session options, forwarded to the corresponding backend. */
11
+ options?: XRSessionOptions<TMode>;
12
+ }
13
+ /**
14
+ * Core RDK engine. This owns the "XR session state" (e.g. running, paused, tracking quality), owns the camera feed/pose source, handles ticks per frame, applies transforms, and provides a React context for children to consume.
15
+ */
16
+ declare const XRSessionProvider: <TMode extends XRMode = XRMode>({ mode, options, children, }: XRSessionProviderProps<TMode>) => import("react/jsx-runtime").JSX.Element;
17
+ export default XRSessionProvider;
18
+ //# sourceMappingURL=XRSessionProvider.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"XRSessionProvider.d.ts","sourceRoot":"","sources":["../../src/engine/XRSessionProvider.tsx"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAC/C,OAAO,EAEN,cAAc,EACd,MAAM,EACN,gBAAgB,EAChB,MAAM,cAAc,CAAC;AAItB;;GAEG;AACH,eAAO,MAAM,KAAK,QAAO,cAOxB,CAAC;AAEF,UAAU,sBAAsB,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,CAC7D,SAAQ,iBAAiB;IACzB,gCAAgC;IAChC,IAAI,EAAE,KAAK,CAAC;IACZ,+DAA+D;IAC/D,OAAO,CAAC,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,QAAA,MAAM,iBAAiB,GAAI,KAAK,SAAS,MAAM,GAAG,MAAM,EAAE,8BAIvD,sBAAsB,CAAC,KAAK,CAAC,4CAuD/B,CAAC;AAEF,eAAe,iBAAiB,CAAC"}
@@ -0,0 +1,2 @@
1
+ export { default as XRCanvas } from './XRCanvas';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/engine/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC"}
@@ -0,0 +1,21 @@
1
+ import { PropsWithChildren } from 'react';
2
+ export interface FiducialAnchorProps extends PropsWithChildren {
3
+ /** Pattern URL. */
4
+ patternUrl?: string;
5
+ /** Barcode value. */
6
+ barcodeValue?: number;
7
+ /** Additional parameters. */
8
+ params?: Record<string, unknown>;
9
+ /** Callback triggered when marker is found. */
10
+ onMarkerFound?: () => void;
11
+ /** Callback triggered when marker is lost. */
12
+ onMarkerLost?: () => void;
13
+ }
14
+ /**
15
+ * Fiducial anchor that attaches its child group to a real-world fiducial marker.
16
+ *
17
+ * Must be used inside `<XRCanvas mode="fiducial" />`.
18
+ */
19
+ declare const FiducialAnchor: ({ patternUrl, barcodeValue, params, onMarkerFound, onMarkerLost, children, }: FiducialAnchorProps) => import("react/jsx-runtime").JSX.Element;
20
+ export default FiducialAnchor;
21
+ //# sourceMappingURL=FiducialAnchor.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"FiducialAnchor.d.ts","sourceRoot":"","sources":["../../src/fiducial/FiducialAnchor.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAqB,MAAM,OAAO,CAAC;AAK7D,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC7D,mBAAmB;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qBAAqB;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,6BAA6B;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,+CAA+C;IAC/C,aAAa,CAAC,EAAE,MAAM,IAAI,CAAC;IAC3B,8CAA8C;IAC9C,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CAC1B;AAED;;;;GAIG;AACH,QAAA,MAAM,cAAc,GAAI,8EAOrB,mBAAmB,4CAgHrB,CAAC;AAEF,eAAe,cAAc,CAAC"}
@@ -0,0 +1,19 @@
1
+ import { XRBackend } from 'lib/types/xr';
2
+ export interface FiducialSessionOptions {
3
+ /** Input source type. */
4
+ sourceType?: "webcam" | "image" | "video";
5
+ /** Camera parameters URL. */
6
+ cameraParametersUrl?: string;
7
+ /** Detection mode. */
8
+ detectionMode?: "color" | "color_and_matrix" | "mono" | "mono_and_matrix";
9
+ /** Pattern ratio. */
10
+ patternRatio?: number;
11
+ /** Matrix code type. */
12
+ matrixCodeType?: "3x3" | "3x3_HAMMING63" | "3x3_PARITY65" | "4x4" | "4x4_BCH_13_9_3" | "4x4_BCH_13_5_5";
13
+ }
14
+ /**
15
+ * Create a fiducial marker-based XR backend.
16
+ */
17
+ declare const createFiducialBackend: (options: unknown) => XRBackend;
18
+ export default createFiducialBackend;
19
+ //# sourceMappingURL=fiducialBackend.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fiducialBackend.d.ts","sourceRoot":"","sources":["../../src/fiducial/fiducialBackend.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAqB,MAAM,cAAc,CAAC;AAOjE,MAAM,WAAW,sBAAsB;IACtC,yBAAyB;IACzB,UAAU,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC;IAC1C,6BAA6B;IAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,sBAAsB;IACtB,aAAa,CAAC,EAAE,OAAO,GAAG,kBAAkB,GAAG,MAAM,GAAG,iBAAiB,CAAC;IAC1E,qBAAqB;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,wBAAwB;IACxB,cAAc,CAAC,EACZ,KAAK,GACL,eAAe,GACf,cAAc,GACd,KAAK,GACL,gBAAgB,GAChB,gBAAgB,CAAC;CACpB;AAED;;GAEG;AACH,QAAA,MAAM,qBAAqB,GAAI,SAAS,OAAO,KAAG,SA0JjD,CAAC;AAEF,eAAe,qBAAqB,CAAC"}
@@ -0,0 +1,3 @@
1
+ export { default as FiducialAnchor } from './FiducialAnchor';
2
+ export type { FiducialSessionOptions } from './fiducialBackend';
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fiducial/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC7D,YAAY,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC"}