A ViroSceneNavigator component is the entry point for VR applications. Please see our Scene Navigation Guide for more information on how to properly navigate between scenes.
Example use:
var MyStartScene = require('./MyStartScene');
import { AppRegistry, ViroScene, ViroSceneNavigator, } from 'react-viro';
var ViroSceneNav = React.createClass({
render: function () {
return (
<ViroSceneNavigator
initialScene={{ scene: MyStartScene }}
/>
);
}
})
Props
initialScene (* required)
Type
Description
PropTypes.shape( {scene: PropTypes.func.isRequired} ),The initial scene to display for your application on application start.
debug
Type
Description
PropTypes.boolUsed to enable dev menu on Android Nougat device with Cardboard.
onExitViro
Type
Description
PropTypes.funcCalled if the user presses the "X" button to exit.
viroAppProps
Type
Description
PropTypes.objectA javascript object containing properties for this viro app. One use would be to pass in properties from native if you're using a hybrid applications.
vrModeEnabled
Type
Description
PropTypes.boolCalling vrModeEnabled allows switching to and from VR mode. When set to false, it transitions back to pre-VR (mono) mode. When set to true, we set thie view into a full VR mode. This is set to true by default.
rotation
Type
Description
PropTypes.arrayOf(PropTypes.number)Put the PropType Description here.
style
Type
Description
stylePropType
text
Type
Description
PropTypes.stringPut the PropType Description here.
transformBehaviors
Type
Description
PropTypes.arrayOf(PropTypes.string)Put the PropType Description here.
width
Type
Description
PropTypes.numberPut the PropType Description here.
visible
Type
Description
PropTypes.boolPut the PropType Description here.
Methods
These are the functions available on the ViroSceneNavigator component, you can get the handle to the ViroSceneNavigator in 2 ways:
using the built-in React Native ref property to grab a reference
from your ViroScene which has been added to the ViroSceneNavigator, it will be given the reference to the ViroSceneNavigator in this variable: this.props.sceneNavigator.
push(scene: ViroScene)
Push the given scene onto scene stack, displaying the scene to the user.|Parameters | Description | | ------------- |:------------- ||scene | Scene that will be pushed onto the stack and displayed to the user |
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: ViroScene)
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 | Description | | ------------- |:------------- ||scene | Scene that will be moved or pushed to the top of the stack and displayed to the user |
replace(scene: ViroScene)
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 | Description | | ------------- |:------------- ||scene | Scene that will replace the scene at the top of stack and be displayed to the user |
recenterTracking()
Reorients the virtual world such that directly forward of the user is [0, 0, -1] by rotating the scene by the user's y-rotation.
