Merge pull request #129 from HippoAR/error-handling-and-bugfixing

Error handling and bugfixing

Author: macrozone

ARKit.js

@@ -71,8 +71,10 @@ class ARKit extends Component {
           onTapOnPlaneUsingExtent={this.callback('onTapOnPlaneUsingExtent')}
           onTapOnPlaneNoExtent={this.callback('onTapOnPlaneNoExtent')}
           onPlaneDetected={this.callback('onPlaneDetected')}
+          onPlaneRemoved={this.callback('onPlaneRemoved')}
           onPlaneUpdate={this.callback('onPlaneUpdate')}
           onTrackingState={this.callback('onTrackingState')}
+          onARKitError={this.callback('onARKitError')}
           onEvent={this._onEvent}
         />
         {state}
@@ -183,7 +185,9 @@ ARKit.propTypes = {
   lightEstimationEnabled: PropTypes.bool,
   autoenablesDefaultLighting: PropTypes.bool,
   worldAlignment: PropTypes.number,
+  onARKitError: PropTypes.func,
   onPlaneDetected: PropTypes.func,
+  onPlaneRemoved: PropTypes.func,
   onFeaturesDetected: PropTypes.func,
   // onLightEstimation is called rapidly, better poll with
   // ARKit.getCurrentLightEstimation()

CHANGELOG.md

@@ -0,0 +1,8 @@
+
+
+### 2017-12-21
+
+- added `onPlaneRemoved`
+- added `eulerAngles` to detected planes
+- added `onARKitError` to ARKit
+- added `origin` property to ARKit

README.md

@@ -69,6 +69,7 @@ export default class ReactNativeARKit extends Component {
           onLightEstimation={e => console.log(e.nativeEvent)}
           onPlaneDetected={console.log} // event listener for plane detection
           onPlaneUpdate={console.log} // event listener for plane update
+          onPlaneRemoved={console.log} // arkit sometimes removes detected planes
         >
           <ARKit.Box
             position={{ x: 0, y: 0, z: 0 }}
@@ -176,15 +177,31 @@ AppRegistry.registerComponent('ReactNativeARKit', () => ReactNativeARKit);
 | `planeDetection` | `Boolean` | `false` | ARKit plane detection.
 | `lightEstimationEnabled` | `Boolean` | `false` | ARKit light estimation.
 | `worldAlignment` | `Enumeration` <br /> One of: `ARKit.ARWorldAlignment.Gravity`, `ARKit.ARWorldAlignment.GravityAndHeading`, `ARKit.ARWorldAlignment.Camera` (documentation [here](https://developer.apple.com/documentation/arkit/arworldalignment)) | `ARKit.ARWorldAlignment.Gravity` | **ARWorldAlignmentGravity** <br /> The coordinate system's y-axis is parallel to gravity, and its origin is the initial position of the device. **ARWorldAlignmentGravityAndHeading** <br /> The coordinate system's y-axis is parallel to gravity, its x- and z-axes are oriented to compass heading, and its origin is the initial position of the device. **ARWorldAlignmentCamera** <br /> The scene coordinate system is locked to match the orientation of the camera.|
+| `origin` | `{position, transition}` | Usually `{0,0,0}` is where you launched the app. If you want to have a different origin, you can set it here. E.g. if you set `origin={{position: {0,-1, 0}, transition: {duration: 1}}}` the new origin will be one meter below. If you have any objects already placed, they will get moved down using the given transition. All hit-test functions or similar will report coordinates relative to that new origin as `position`. You can get the original coordinates with `positionAbsolute` in these functions |  
 
 ##### Events
 
 | Event Name | Returns | Notes
 |---|---|---|
-| `onPlaneDetected` | `{ id, center, extent }` | When a plane is first detected.
+| `onARKitError` | `ARKiterror` | will report whether an error occured while initializing ARKit. A common error is when the user has not allowed camera access. Another error is, if you use `worldAlignment=GravityAndHeading` and location service is turned off |
 | `onLightEstimation` | `{ ambientColorTemperature, ambientIntensity }` | Light estimation on every frame. Called rapidly, better use polling. See `ARKit.getCurrentLightEstimation()`
 | `onFeaturesDetected` | `{ featurePoints}` | Detected Features on every frame (currently also not throttled). Usefull to display custom dots for detected features. You can also poll this information with `ARKit.getCurrentDetectedFeaturePoints()`
-| `onPlaneUpdate` | `{ id, center, extent }` | When a detected plane is updated
+| `onPlaneDetected` | `Plane` | When a plane is first detected.
+| `onPlaneUpdate` | `Plane` | When a detected plane is updated
+| `onPlaneRemoved` | `Plane` | When a detected plane is updated
+
+The `Plane` object has the following properties:
+
+| Property | Description
+|---|---|
+| `id` | a unique id identifying the plane |
+| `position` | the position of the plane (relative to the origin) |
+| `positionAbsolute` | the absolute position of the plane |
+| `extent` | the extent of the plane | 
+| `eulerAngles` | the rotation of the plane |
+
+
+
 
 ##### Static methods
 
@@ -253,7 +270,7 @@ Most objects take a material property with these sub-props:
 | `doubleSided` | boolean | render both sides, default is `true` |
 | `litPerPixel` | boolean | calculate lighting per-pixel or vertex [litPerPixel](https://developer.apple.com/documentation/scenekit/scnmaterial/1462580-litperpixel) |
 | `lightingModel` | `ARKit.LightingModel.*` | [LightingModel](https://developer.apple.com/documentation/scenekit/scnmaterial.lightingmodel) |
-| `blendMode` | `ARKit.BlendMode.*` | [BlendMode](https://developer.apple.com/documentation/scenekit/scnmaterial/1462585-blendmode) | 
+| `blendMode` | `ARKit.BlendMode.*` | [BlendMode](https://developer.apple.com/documentation/scenekit/scnmaterial/1462585-blendmode) |
 | `fillMode` | `ARKit.FillMode.*` | [FillMode](https://developer.apple.com/documentation/scenekit/scnmaterial/2867442-fillmode)
 | `shaders` | Object with keys from `ARKit.ShaderModifierEntryPoint.*` and shader strings as values | [Shader modifiers](https://developer.apple.com/documentation/scenekit/scnshadable) |
 | `colorBufferWriteMask` | `ARKit.ColorMask.*` | [color mask](https://developer.apple.com/documentation/scenekit/scncolormask). Set to ARKit.ColorMask.None so that an object is transparent, but receives deferred shadows. |

components/lib/createArComponent.js

@@ -88,6 +88,7 @@ export default (mountConfig, propTypes = {}, nonUpdateablePropKeys = []) => {
       : mountConfig.mount;
 
   const mount = (id, props) => {
+    if (DEBUG) console.log(`[${id}] [${new Date().getTime()}] mount`, props);
     mountFunc(
       getNonNodeProps(props),
       {
@@ -98,6 +99,16 @@ export default (mountConfig, propTypes = {}, nonUpdateablePropKeys = []) => {
     );
   };
 
+  const update = (id, props) => {
+    if (DEBUG) console.log(`[${id}] [${new Date().getTime()}] update`, props);
+    ARGeosManager.updateNode(id, props);
+  };
+
+  const unmount = id => {
+    if (DEBUG) console.log(`[${id}] [${new Date().getTime()}] unmount`);
+    ARGeosManager.unmount(id);
+  };
+
   const ARComponent = class extends Component {
     identifier = null;
     componentDidMount() {
@@ -108,7 +119,7 @@ export default (mountConfig, propTypes = {}, nonUpdateablePropKeys = []) => {
         const {
           transition: transitionOnMount = { duration: 0 },
         } = fullPropsOnMount;
-        if (DEBUG) console.log('mount', fullPropsOnMount);
+
         this.doPendingTimers();
         mount(this.identifier, fullPropsOnMount);
 
@@ -137,13 +148,20 @@ export default (mountConfig, propTypes = {}, nonUpdateablePropKeys = []) => {
         );
         if (nonAllowedUpdates.length > 0) {
           throw new Error(
-            `prop can't be updated: '${nonAllowedUpdates.join(', ')}'`,
+            `[${this
+              .identifier}] prop can't be updated: '${nonAllowedUpdates.join(
+              ', ',
+            )}'`,
           );
         }
       }
 
       if (some(changedKeys, k => nonUpdateablePropKeys.includes(k))) {
-        if (DEBUG) console.log('need to remount node because of ', changedKeys);
+        if (DEBUG)
+          console.log(
+            `[${this.identifier}] need to remount node because of `,
+            changedKeys,
+          );
         mount(this.identifier, { ...this.props, ...props });
       } else {
         // every property is updateable
@@ -158,8 +176,7 @@ export default (mountConfig, propTypes = {}, nonUpdateablePropKeys = []) => {
           ...parseMaterials(pick(props, changedKeys)),
         };
 
-        if (DEBUG) console.log('update node', propsToupdate);
-        ARGeosManager.updateNode(this.identifier, propsToupdate);
+        update(this.identifier, propsToupdate);
       }
     }
 
@@ -171,11 +188,11 @@ export default (mountConfig, propTypes = {}, nonUpdateablePropKeys = []) => {
 
         this.componentWillUpdate(fullProps);
         this.delayed(() => {
-          ARGeosManager.unmount(this.identifier);
+          unmount(this.identifier);
         }, duration * 1000);
       } else {
         this.doPendingTimers();
-        ARGeosManager.unmount(this.identifier);
+        unmount(this.identifier);
       }
     }
     /**

ios/RCTARKit.h

@@ -41,13 +41,15 @@ typedef void (^RCTARKitReject)(NSString *code, NSString *message, NSError *error
 @property (nonatomic, assign) ARWorldAlignment worldAlignment;
 
 @property (nonatomic, copy) RCTBubblingEventBlock onPlaneDetected;
+@property (nonatomic, copy) RCTBubblingEventBlock onPlaneRemoved;
 @property (nonatomic, copy) RCTBubblingEventBlock onFeaturesDetected;
 @property (nonatomic, copy) RCTBubblingEventBlock onLightEstimation;
 @property (nonatomic, copy) RCTBubblingEventBlock onPlaneUpdate;
 @property (nonatomic, copy) RCTBubblingEventBlock onTrackingState;
 @property (nonatomic, copy) RCTBubblingEventBlock onTapOnPlaneUsingExtent;
 @property (nonatomic, copy) RCTBubblingEventBlock onTapOnPlaneNoExtent;
 @property (nonatomic, copy) RCTBubblingEventBlock onEvent;
+@property (nonatomic, copy) RCTBubblingEventBlock onARKitError;
 
 
 @property NSMutableDictionary *planes; // plane detected

ios/RCTARKit.m

@@ -87,6 +87,7 @@ - (instancetype)initWithARView:(ARSCNView *)arView {
 
 - (void)layoutSubviews {
     [super layoutSubviews];
+    //NSLog(@"setting view bounds %@", NSStringFromCGRect(self.bounds));
     self.arView.frame = self.bounds;
 }
 
@@ -98,6 +99,15 @@ - (void)resume {
     [self.session runWithConfiguration:self.configuration];
 }
 
+- (void)session:(ARSession *)session didFailWithError:(NSError *)error {
+    if(self.onARKitError) {
+        self.onARKitError(RCTJSErrorFromNSError(error));
+    } else {
+        NSLog(@"Initializing ARKIT failed with Error: %@ %@", error, [error userInfo]);
+        
+    }
+   
+}
 - (void)reset {
     if (ARWorldTrackingConfiguration.isSupported) {
         [self.session runWithConfiguration:self.configuration options:ARSessionRunOptionRemoveExistingAnchors | ARSessionRunOptionResetTracking];
@@ -471,12 +481,13 @@ - (NSDictionary *)makePlaneDetectionResult:(SCNNode *)node planeAnchor:(ARPlaneA
     return @{
              @"id": planeAnchor.identifier.UUIDString,
              @"alignment": @(planeAnchor.alignment),
+             @"eulerAngles":vectorToJson(node.eulerAngles),
              @"position": vectorToJson([self.nodeManager getRelativePositionToOrigin:node.position]),
              @"positionAbsolute": vectorToJson(node.position),
-             // node is deprecated
-             @"node": vectorToJson(node.position),
              @"center": vector_float3ToJson(planeAnchor.center),
-             @"extent": vector_float3ToJson(planeAnchor.extent)
+             @"extent": vector_float3ToJson(planeAnchor.extent),
+             // node is deprecated
+             @"node": vectorToJson(node.position)
              };
 }
 
@@ -505,6 +516,13 @@ - (void)renderer:(id <SCNSceneRenderer>)renderer didUpdateNode:(SCNNode *)node f
 
 }
 
+- (void)renderer:(id<SCNSceneRenderer>)renderer didRemoveNode:(SCNNode *)node forAnchor:(ARAnchor *)anchor {
+     ARPlaneAnchor *planeAnchor = (ARPlaneAnchor *)anchor;
+    if (self.onPlaneRemoved) {
+        self.onPlaneRemoved([self makePlaneDetectionResult:node planeAnchor:planeAnchor]);
+    }
+}
+
 
 
 

ios/RCTARKitManager.m

@@ -17,6 +17,8 @@ @implementation RCTARKitManager
 
 RCT_EXPORT_MODULE()
 
+
+
 - (UIView *)view {
     return [ARKit sharedInstance];
 }
@@ -102,12 +104,14 @@ - (NSDictionary *)constantsToExport
 
 RCT_EXPORT_VIEW_PROPERTY(onPlaneDetected, RCTBubblingEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onPlaneUpdate, RCTBubblingEventBlock)
+RCT_EXPORT_VIEW_PROPERTY(onPlaneRemoved, RCTBubblingEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onTrackingState, RCTBubblingEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onFeaturesDetected, RCTBubblingEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onLightEstimation, RCTBubblingEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onTapOnPlaneUsingExtent, RCTBubblingEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onTapOnPlaneNoExtent, RCTBubblingEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onEvent, RCTBubblingEventBlock)
+RCT_EXPORT_VIEW_PROPERTY(onARKitError, RCTBubblingEventBlock)
 
 RCT_EXPORT_METHOD(pause:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject) {
     [[ARKit sharedInstance] pause];

ios/RCTARKitNodes.m

@@ -61,7 +61,7 @@ - (instancetype)init {
 }
 
 - (void)setArView:(ARSCNView *)arView {
-    NSLog(@"setArView");
+    //NSLog(@"setArView");
     _arView = arView;
     self.rootNode = arView.scene.rootNode;
 
@@ -78,6 +78,7 @@ - (void)setArView:(ARSCNView *)arView {
  add a node to scene in a reference frame
  */
 - (void)addNodeToScene:(SCNNode *)node inReferenceFrame:(NSString *)referenceFrame {
+    [self registerNode:node forKey:node.name];
     if (!referenceFrame) {
         referenceFrame = @"Local"; // default to Local frame
     }
@@ -108,24 +109,23 @@ - (void)clear {
 - (void)addNodeToLocalFrame:(SCNNode *)node {
     node.referenceFrame = RFReferenceFrameLocal;
 
+    [self.localOrigin addChildNode:node];
     //NSLog(@"[RCTARKitNodes] Add node %@ to Local frame at (%.2f, %.2f, %.2f)", node.name, node.position.x, node.position.y, node.position.z);
 
-    [self registerNode:node forKey:node.name];
-    [self.localOrigin addChildNode:node];
 }
 
 - (void)addNodeToCameraFrame:(SCNNode *)node {
     node.referenceFrame = RFReferenceFrameCamera;
     //NSLog(@"[RCTARKitNodes] Add node %@ to Camera frame at (%.2f, %.2f, %.2f)", node.name, node.position.x, node.position.y, node.position.z);
-    [self registerNode:node forKey:node.name];
+
     [self.cameraOrigin addChildNode:node];
 }
 
 - (void)addNodeToFrontOfCameraFrame:(SCNNode *)node {
     node.referenceFrame = RFReferenceFrameFrontOfCamera;
 
     //NSLog(@"[RCTARKitNodes] Add node %@ to FrontOfCamera frame at (%.2f, %.2f, %.2f)", node.name, node.position.x, node.position.y, node.position.z);
-    [self registerNode:node forKey:node.name];
+
     [self.frontOfCamera addChildNode:node];
 }
 
@@ -287,7 +287,7 @@ - (SCNNode *)nodeForKey:(NSString *)key {
 }
 
 - (void)removeNodeForKey:(NSString *)key {
-    
+    //NSLog(@"removing node: %@ ", key);
     SCNNode *node = [self.nodes objectForKey:key];
     if (node) {
         [self.nodes removeObjectForKey:key];
@@ -303,6 +303,7 @@ - (void)removeNodeForKey:(NSString *)key {
 
 - (void)updateNode:(NSString *)nodeId properties:(NSDictionary *) properties {
     SCNNode *node = [self.nodes objectForKey:nodeId];
+    //NSLog(@"updating node %@ :%@", nodeId, properties);
     if(node) {
         [RCTConvert setNodeProperties:node properties:properties];
         if(node.geometry && properties[@"shape"]) {
@@ -318,6 +319,8 @@ - (void)updateNode:(NSString *)nodeId properties:(NSDictionary *) properties {
         }
 
 
+    } else {
+        NSLog(@"WARNING: node does not exists: %@. This means that the node has not been mounted yet, so native calls got out of order", nodeId);
     }
 
 }

ios/RCTConvert+ARKit.m

@@ -413,6 +413,7 @@ + (void)setNodeProperties:(SCNNode *)node properties:(id)json {
     }
 
     if (json[@"scale"]) {
+       
         CGFloat scale = [json[@"scale"] floatValue];
         node.scale = SCNVector3Make(scale, scale, scale);
 

ios/color-grabber/color-grabber.m

@@ -95,7 +95,7 @@ - (NSArray *)getColorsFromImage:(UIImage *)image options:(NSDictionary *)options
             int red = CLAMP([reds[r] intValue], 0, 255);
             int green = CLAMP([greens[g] intValue], 0, 255);
             int blue = CLAMP([blues[b] intValue], 0, 255);
-            NSLog([NSString stringWithFormat:@"r: %d, g: %d, b: %d",red,green,blue]);
+            //NSLog([NSString stringWithFormat:@"r: %d, g: %d, b: %d",red,green,blue]);
 
             NSString * rgbString = [NSString stringWithFormat:@"%i,%i,%i",red,green,blue];
             [flexibleColours addObject:rgbString];
@@ -167,7 +167,7 @@ - (NSArray *)getColorsFromImage:(UIImage *)image options:(NSDictionary *)options
     for (NSString * key in temp){
         float count = [temp[key] floatValue];
         float percentage = count/totalCount;
-        NSLog(@"%f",percentage);
+        //NSLog(@"%f",percentage);
         NSArray * rgb = [key componentsSeparatedByString:@","];
         float r = [rgb[0] floatValue];
         float g = [rgb[1] floatValue];