ViroARSceneNavigator

ViroARSceneNavigator is the entry point for AR applications with Viro. For more information about developing in AR, see our Develop page for Augmented Reality (AR).

Props

initialScene (* required)

autofocus

bloomEnabled

hdrEnabled

numberOfTrackedImages

pbrEnabled

shadowsEnabled

videoQuality

viroAppProps

worldAlignment

Methods

The following functions are available on the ViroARSceneNavigator component. You can get the handle to the ViroARSceneNavigator, from your ViroScene. Each ViroScene added to a ViroARSceneNavigator provides its parent navigator in the variable: this.props.sceneNavigator.

push({ scene: ViroARScene, passProps: Object })

Push the given scene onto scene stack, displaying the scene to the user.

Parameters

scene - Scene that will be pushed onto the stack and displayed to the user
passProps - Props to pass to the rendered scene

pop()

Pop the top most scene of the stack, effectively going back to the previous scene.

pop(n: number)

Go back n scenes at once. If n is equal to 1 this is equivalent to calling pop().

jump({ scene: ViroARScene, passProps: Object })

Move to the given scene in the stack, removing it from its current position in the stack and placing it on top, thereby displaying it to the user. If the scene is not already on the stack, this method pushes the scene to the top of the stack, displaying it to the user. This is best used in applications where the user jumps between a set of scenes frequently.

Parameters

scene - Scene that will be moved or pushed to the top of the stack and displayed to the user
passProps - Props to pass to the rendered scene

replace({ scene: ViroARScene, passProps: Object })

Replace the currently displayed scene (the scene at the top of the stack) with the given scene, displaying it to the user. This leaves the remainder of the stack unchanged.

Parameters

scene - Scene that will replace the scene at the top of stack and be displayed to the user
passProps - Props to pass to the rendered scene

resetARSession(resetTracking: boolean, removeAnchors:boolean)

iOS Only

Call this function to reset the ARSession with a combination of the two flags:resetTracking - if true, the scene will realign with the camera's position and orientation.removeAnchors - if true, the anchors will all be removed (onAnchorRemoved will be called on the ViroARScene). It's recommended to also set removeAnchor to true if resetTracking is also set to true.

setWorldOrigin(offset:Object)

iOS 11.3+/ARKit 1.5+ Only!This function transforms the world origin by the given offset. Multiple calls to this function are additive, translating the worldOrigin by the given position/rotation.

The offset Object can contain a position and/or a rotation key w/ corresponding values, ie:

this.arSceneNavigator.setWorldOrigin({ position : [x, y, z], rotation : [x, y, z],})

startVideoRecording(fileName: string, saveToCameraRoll: bool, onError: func)

Starts a recording of the ViroARSceneNavigator capturing only Viro-rendered components and external audio (microphone and camera permissions required).

Parameters

fileName - name of the file saved to app's temporary files. If the name matches an existing file at the location, it will be overridden. A file extension will automatically be added.
saveToCameraRoll - Whether or not the file should also be saved to the user's Photos at the end of recording. (Requires photo/video saving permissions)
onError - a function invoked w/ an errorCode if recording encounters an issue. Possible error codes here.

async stopVideoRecording()

Async function called to stop video recording.

Returns

object with keys:

success - true/false if stopping was successful
url - path to the file in the application's temporary files.
errorCode - a number representing an error while stopping recording. Possible error codes here.

async takeScreenshot(fileName: string, saveToCameraRoll: bool)

Async function called to take a screenshot of the ViroARSceneNavigator capturing only Viro-rendered components.

Parameters

fileName - name of the file saved to app's temporary files. If the name matches an existing file at the location, it will be overridden. A file extension will automatically be added.
saveToCameraRoll - Whether or not the file should also be saved to the user's Photos at the end of recording. (Requires photo/video saving permissions)

Returns

object with keys:

success - true/false if stopping was successful
url - path to the file in the application's temporary files.
errorCode - a number representing an error while stopping recording. Possible error codes here.

async project(point:array)

Async function called that takes a 3d vector representing a 3d world position and returns a vector representing a x,y screen position.

Parameters

point - A 3d vector that represents a 3d world position. For example, a value of [-1, 4, -5] would represent the point (x:-1, y:4, z:-5) in world space.

Returns

an object with the keys:

screenPosition - A 2d vector that represents the projected screen position of the passed in point parameter. screenPosition[0] will represent the x screen position. screenPosition[1] will store the y screen position.

Example use:

this.props.arSceneNavigator.project(projectPoint).then((returnPos)=> {      
  this.setState({          
    screenX: returnPos["screenPosition"][0],          
    screenY: returnPos["screenPosition"][1],      
  });    
}); 

async unproject(point:array)

Async function called that takes a 3d vector representing a 2d screen position plus a value from 0 to 1 representing a interpolation from the near clipping plane and far clipping plane, and returns a vector representing a x,y,z world space position of the given screen position.

Parameters

point - A 3d vector. point[0] represents the screen x position. point[1] represents the screen y position. point[2] is a value from 0 to 1. 0 will unproject the point on the near clipping plane. A value of 1 will unproject the point on the far clipping plane. A value between 0 and 1 will interpolate between the two planes and unproject the point at that interpolated distance. For example, a value of [100, 400, 0] would inform the method to unproject the screen position(x:100, y:400) onto the near clipping plane.

Returns

an object with the keys:

position - A 3d vector that represents the unprojected world position. position[0] will represent the x position. position[1] will store the y position. position[2] will store the z position.

Example use:

this.props.arSceneNavigator.unproject(unprojectPoint).then((returnDict)=> {
  this.setState({ unprojectedPoint: returnDict["position"] });
});