{"_id":"5a06037134873d0010b39226","category":{"_id":"5a06037134873d0010b39204","version":"5a06037134873d0010b391fe","project":"578c4badbd223d2000cc1441","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-08-01T23:04:12.838Z","from_sync":false,"order":5,"slug":"api-reference","title":"API Reference"},"project":"578c4badbd223d2000cc1441","parentDoc":null,"user":"57bb7defafc18c0e00529cf1","version":{"_id":"5a06037134873d0010b391fe","project":"578c4badbd223d2000cc1441","__v":1,"createdAt":"2017-11-10T19:52:17.163Z","releaseDate":"2017-11-10T19:52:17.163Z","categories":["5a06037134873d0010b391ff","5a06037134873d0010b39200","5a06037134873d0010b39201","5a06037134873d0010b39202","5a06037134873d0010b39203","5a06037134873d0010b39204"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.1.0","version":"2.1.0"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-18T03:51:21.138Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":21,"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```\n<ViroOrbitCamera\n    position={[0, 0, 0]}\n    focalPoint={[0,0,-1]}\n    active={true}\n />\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\": \"**focalPoint**\",\n    \"2-0\": \"**rotation**\",\n    \"3-0\": \"**style**\",\n    \"4-0\": \"**text**\",\n    \"5-0\": \"**transformBehaviors**\",\n    \"7-0\": \"**visible**\",\n    \"6-0\": \"**width**\",\n    \"h-0\": \"PropKey\",\n    \"h-1\": \"PropType\",\n    \"0-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    \"2-1\": \"PropTypes.arrayOf(PropTypes.number)\\n\\nPut the PropType Description here.\",\n    \"3-1\": \"stylePropType\",\n    \"4-1\": \"PropTypes.string\\n\\nPut the PropType Description here.\",\n    \"5-1\": \"PropTypes.arrayOf(PropTypes.string)\\n\\nPut the PropType Description here.\",\n    \"6-1\": \"PropTypes.number\\n\\nPut the PropType Description here.\",\n    \"7-1\": \"PropTypes.bool\\n\\nPut the PropType Description here.\",\n    \"1-0\": \"**position**\",\n    \"1-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nCartesian position of the camera in 3D world space, specified as [x, y, z]. Default position is [0,0,0].\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\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: ``` <ViroOrbitCamera position={[0, 0, 0]} focalPoint={[0,0,-1]} active={true} /> ``` [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": "**focalPoint**", "2-0": "**rotation**", "3-0": "**style**", "4-0": "**text**", "5-0": "**transformBehaviors**", "7-0": "**visible**", "6-0": "**width**", "h-0": "PropKey", "h-1": "PropType", "0-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].", "2-1": "PropTypes.arrayOf(PropTypes.number)\n\nPut the PropType Description here.", "3-1": "stylePropType", "4-1": "PropTypes.string\n\nPut the PropType Description here.", "5-1": "PropTypes.arrayOf(PropTypes.string)\n\nPut the PropType Description here.", "6-1": "PropTypes.number\n\nPut the PropType Description here.", "7-1": "PropTypes.bool\n\nPut the PropType Description here.", "1-0": "**position**", "1-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nCartesian position of the camera in 3D world space, specified as [x, y, z]. Default position is [0,0,0]." }, "cols": 2, "rows": 2 } [/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]