{"_id":"5b74987b8326970003cfc0f6","category":{"_id":"5b74987b8326970003cfc0a8","version":"5b74987b8326970003cfc12d","project":"578c4badbd223d2000cc1441","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-08-01T23:04:12.838Z","from_sync":false,"order":8,"slug":"api-reference","title":"API Reference"},"project":"578c4badbd223d2000cc1441","parentDoc":null,"user":"57bb7defafc18c0e00529cf1","version":{"_id":"5b74987b8326970003cfc12d","project":"578c4badbd223d2000cc1441","__v":0,"forked_from":"5b6890bfd389ff000384fac1","createdAt":"2018-04-23T20:03:35.726Z","releaseDate":"2018-04-23T20:03:35.726Z","categories":["5b74987b8326970003cfc0a3","5b74987b8326970003cfc0a4","5b74987b8326970003cfc0a5","5b74987b8326970003cfc0a6","5b74987b8326970003cfc0a7","5b74987b8326970003cfc0a8","5b74987b8326970003cfc0a9","5b74987b8326970003cfc0aa","5b74987b8326970003cfc0ab"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.9.1","version":"2.9.1"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-18T03:51:21.138Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":25,"body":"A camera component that allows the user to orbit around a specified focal point. See our [Camera Guide](http://viro.readme.io/docs/camera) for more information on using cameras. \n\n######Example use:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<ViroOrbitCamera\\n    position={[0, 0, 0]}\\n    focalPoint={[0,0,-1]}\\n    active={true}\\n />\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Props\"\n}\n[/block]\n##Required Props\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**active**\",\n    \"0-1\": \"**PropTypes.bool.isRequired**\\n\\nIf true, sets the corresponding camera as the active one from which we render the world. Setting more than one active camera within a scene will result in undefined behavior.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n##Optional Props \n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**fieldOfView**\",\n    \"3-0\": \"**text**\",\n    \"4-0\": \"**transformBehaviors**\",\n    \"6-0\": \"**visible**\",\n    \"5-0\": \"**width**\",\n    \"h-0\": \"PropKey\",\n    \"h-1\": \"PropType\",\n    \"0-1\": \"**PropTypes.number**\\n\\nSet the field of view for this camera, along the major (larger) axis. Field of view is an angle that determines how wide or narrow the camera lens is when rendering the scene.\\n\\nThis value sets the field of view, in degrees, for the major axis. The major axis is the axis with the larger dimension: the X axis in landscape mode, or the Y axis in portrait mode. By specifying the field of view in terms of the major axis, Viro can keep the field of view consistent upon orientation changes, when the major/minor axes swap. The minor axis field of view is automatically computed from the major axis field of view and the viewport.\\n\\nThis value is ignored on VR and AR platforms, where the FOV is fixed by the VR headset or the AR camera. Else, in non-VR (360 mode) the FOV defaults to 90.\",\n    \"3-1\": \"PropTypes.string\\n\\nPut the PropType Description here.\",\n    \"4-1\": \"PropTypes.arrayOf(PropTypes.string)\\n\\nPut the PropType Description here.\",\n    \"5-1\": \"PropTypes.number\\n\\nPut the PropType Description here.\",\n    \"6-1\": \"PropTypes.bool\\n\\nPut the PropType Description here.\",\n    \"2-0\": \"*position*\",\n    \"2-1\": \"**PropTypes.number**\\n\\nThe desired fov for this camera. Default fov is 90.\",\n    \"1-0\": \"**focalPoint**\",\n    \"1-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nCartesian position in 3D world space where the camera focuses on and orbits around. Default position is [0,0,0].\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Methods\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"setNativeProps(nativeProps: object)\",\n    \"0-0\": \"A wrapper function around the native component's setNativeProps which allow users to set values on the native component without changing state/setting props and re-rendering. Refer to the React Native documentation on [Direct Manipulation](https://facebook.github.io/react-native/docs/direct-manipulation.html) for more information.\\n\\n|Parameter|Description|\\n|---|---|\\n|nativeProps | an object where the keys are the properties to set and the values are the values to set  |\\n\\nFor example, setting position natively would look like this:\\n\\n```\\ncomponentRef.setNativeProps({\\n    position : [0, 0, -1]\\n});\\n```\"\n  },\n  \"cols\": 1,\n  \"rows\": 1\n}\n[/block]","excerpt":"","slug":"viroorbitcamera","type":"basic","title":"ViroOrbitCamera"}
A camera component that allows the user to orbit around a specified focal point. See our [Camera Guide](http://viro.readme.io/docs/camera) for more information on using cameras. ######Example use: [block:code] { "codes": [ { "code": "<ViroOrbitCamera\n position={[0, 0, 0]}\n focalPoint={[0,0,-1]}\n active={true}\n />", "language": "javascript" } ] } [/block] [block:api-header] { "type": "basic", "title": "Props" } [/block] ##Required Props [block:parameters] { "data": { "0-0": "**active**", "0-1": "**PropTypes.bool.isRequired**\n\nIf true, sets the corresponding camera as the active one from which we render the world. Setting more than one active camera within a scene will result in undefined behavior." }, "cols": 2, "rows": 1 } [/block] ##Optional Props [block:parameters] { "data": { "0-0": "**fieldOfView**", "3-0": "**text**", "4-0": "**transformBehaviors**", "6-0": "**visible**", "5-0": "**width**", "h-0": "PropKey", "h-1": "PropType", "0-1": "**PropTypes.number**\n\nSet the field of view for this camera, along the major (larger) axis. Field of view is an angle that determines how wide or narrow the camera lens is when rendering the scene.\n\nThis value sets the field of view, in degrees, for the major axis. The major axis is the axis with the larger dimension: the X axis in landscape mode, or the Y axis in portrait mode. By specifying the field of view in terms of the major axis, Viro can keep the field of view consistent upon orientation changes, when the major/minor axes swap. The minor axis field of view is automatically computed from the major axis field of view and the viewport.\n\nThis value is ignored on VR and AR platforms, where the FOV is fixed by the VR headset or the AR camera. Else, in non-VR (360 mode) the FOV defaults to 90.", "3-1": "PropTypes.string\n\nPut the PropType Description here.", "4-1": "PropTypes.arrayOf(PropTypes.string)\n\nPut the PropType Description here.", "5-1": "PropTypes.number\n\nPut the PropType Description here.", "6-1": "PropTypes.bool\n\nPut the PropType Description here.", "2-0": "*position*", "2-1": "**PropTypes.number**\n\nThe desired fov for this camera. Default fov is 90.", "1-0": "**focalPoint**", "1-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nCartesian position in 3D world space where the camera focuses on and orbits around. Default position is [0,0,0]." }, "cols": 2, "rows": 3 } [/block] [block:api-header] { "title": "Methods" } [/block] [block:parameters] { "data": { "h-0": "setNativeProps(nativeProps: object)", "0-0": "A wrapper function around the native component's setNativeProps which allow users to set values on the native component without changing state/setting props and re-rendering. Refer to the React Native documentation on [Direct Manipulation](https://facebook.github.io/react-native/docs/direct-manipulation.html) for more information.\n\n|Parameter|Description|\n|---|---|\n|nativeProps | an object where the keys are the properties to set and the values are the values to set |\n\nFor example, setting position natively would look like this:\n\n```\ncomponentRef.setNativeProps({\n position : [0, 0, -1]\n});\n```" }, "cols": 1, "rows": 1 } [/block]