@onirix/ar-engine-sdk 1.8.0 → 1.8.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v1.8.1 (2024-07-24)
+
+### Fixed
+
+- Fallback to Onirix world tracking whenever WebXR initialization fails for any reason.
+
 ## v1.8.0 (2024-07-01)
 
 ### Changed

package/README.md

@@ -7,6 +7,7 @@ It internally uses advanced web standards like WebGL or WebAssembly combined wit
 Onirix AR Engine SDK is compatible with the following Onirix **tracking modes**:
 
 * **Image**: Will load the image classifier generated for your Onirix project and perform detection and tracking of any of its images.
+* **Curved**: Will load the image classifier generated for your Onirix project and perform detection and tracking of any of its images, taking into account that those images will be wrapping a cylinder.
 * **QR Code**: Will detect any QR code in the camera feed, return its decoded content and perform tracking.
 * **Surface**: Will use device camera and motion sensors to track an object fixed over any place or surface. This mode has 2 different sub-modes:
    * **World-Tracking** (Default): Allows to place objects fixed at a surface, so you can walk around and see them from different perspectives. Internally uses WebXR device API if the device is compatible (Android with ARCore support for now), and fallbacks to a custom implementation if not, or when using the config option `disableWebXR = true`.
@@ -29,7 +30,7 @@ Onirix AR Engine SDK is agnostic (not tied) to any rendering engine, so you can
 
 First of all, you'll need to access [Onirix Studio](https://studio.onirix.com?target=_blank) and create a Project. 
 
-If you plan to use Image-Tracking mode, then you'll also need to **create an image scene for every marker image** you want to be detected so Onirix can generate the required image classifier. For Spatial-Tracking, you'll also need to create an scene by scanning your environment with Onirix Constructor App. If none of these modes are used, then there is no need to create any scene as, when using the SDK, you can provide your own assets and interaction through your hosting and code.
+If you plan to use Image-Tracking or Curved-Tracking mode, then you'll also need to **create an image scene for every marker image** you want to be detected so Onirix can generate the required image classifier. For Spatial-Tracking, you'll also need to create an scene by scanning your environment with Onirix Constructor App. If none of these modes are used, then there is no need to create any scene as, when using the SDK, you can provide your own assets and interaction through your hosting and code.
 
 Finally, you will have to **publish** your project and **copy the Web SDK token** from the "share" and "settings" top-menu options respectively.
 
@@ -73,6 +74,7 @@ Whenever you want to launch the AR experience, **create a new OnirixSDK instance
 The **mode** can be one of following depending on the tracking type you want to use for your experience:
 
 * OnirixSDK.TrackingMode.Image
+* OnirixSDK.TrackingMode.Curved
 * OnirixSDK.TrackingMode.QRCode
 * OnirixSDK.TrackingMode.Surface
 * OnirixSDK.TrackingMode.Spatial
@@ -213,6 +215,10 @@ While in image mode, positive Y is orthogonal coming out from marker image, X go
 
 ![](https://docs.onirix.com/user/pages/05.onirix-sdk/08.web-ar/image-axes.jpg)
 
+#### Curved mode
+
+While in curved mode, -Z is orthogonal coming out from marker image, X goes right and Y down.
+
 #### Spatial mode
 
 While in Spatial mode, the coordinate system aligns with the scanned environment. This means that, similar to Surface mode, the -Z axis points towards the horizon, the Y axis points upward, aligned with gravity, and the X axis is perpendicular to both, forming the cross vector. However, in Spatial mode, these axes are rotated in such a way that they match the orientation and position of the previously scanned space, ensuring that virtual objects are accurately placed within the real-world context.