{"_id":"58f7a4c8cbd001190056cc0e","project":"578c4badbd223d2000cc1441","category":{"_id":"58f7a4c8cbd001190056cbfe","__v":0,"version":"58f7a4c8cbd001190056cbf8","project":"578c4badbd223d2000cc1441","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-08-01T23:04:12.838Z","from_sync":false,"order":5,"slug":"api-reference","title":"API Reference"},"user":"57bb7defafc18c0e00529cf1","parentDoc":null,"version":{"_id":"58f7a4c8cbd001190056cbf8","__v":1,"project":"578c4badbd223d2000cc1441","createdAt":"2017-04-19T17:56:24.172Z","releaseDate":"2017-04-19T17:56:24.172Z","categories":["58f7a4c8cbd001190056cbf9","58f7a4c8cbd001190056cbfa","58f7a4c8cbd001190056cbfb","58f7a4c8cbd001190056cbfc","58f7a4c8cbd001190056cbfd","58f7a4c8cbd001190056cbfe"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1.0"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-18T04:36:23.365Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"A simple 3D box that is defined by width, height and length.\n\n######Example use:\n```\n<ViroBox\n    height={2}\n    length={2}\n    width={2}\n    materials={[\"boxside\"]} />\n```\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Props\"\n}\n[/block]\n##Optional Props\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**height**\",\n    \"3-0\": \"**materials**\",\n    \"13-0\": \"**position**\",\n    \"14-0\": \"**rotation**\",\n    \"15-0\": \"**scale**\",\n    \"16-0\": \"**transformBehaviors**\",\n    \"17-0\": \"**visible**\",\n    \"h-0\": \"PropKey\",\n    \"h-1\": \"PropType\",\n    \"0-1\": \"**PropTypes.number**\\n\\nThe height of the box in 3D space. Default value is 1.\",\n    \"3-1\": \"**PropTypes.arrayOf(PropTypes.string)**\\n\\nAn array of strings that each represent a material that was created via ViroMaterials.createMaterials(). A ViroBox can accept one material, which is used for all sides.\",\n    \"13-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nCartesian position of the box in 3D world space, specified as [x, y, z].\",\n    \"14-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nThe rotation of the box around it's local axis specified as Euler angles [x, y, z]. Units for each angle are specified in degrees.\",\n    \"15-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nThe scale of the box in 3D space, specified as [x,y,z]. A scale of 1 represents the current size of the box. A scale value of < 1 will make the box proportionally smaller while a value >1 will make the box proportionally bigger along the specified axis.\",\n    \"16-1\": \"**PropTypes.arrayOf(PropTypes.string)**\\n\\nAn array of transform constraints that affect the transform of the object. For example, putting the value \\\"billboard\\\" will ensure the box is facing the user as the user rotates their head on any axis. This is useful for icons or text where you'd like the box to always face the user at a particular rotation.\\n\\nAllowed values(values are case sensitive):\\n\\n|Value|Description|\\n|:------|:----------:|\\n|billboard| Billboard object on x,y,z axis |\\n|billboardX| Billboard object on the x axis|\\n|billboardY| Billboard object on the y axis|\",\n    \"17-1\": \"**PropTypes.bool**\\n\\nFalse if the box should be hidden. By default the box is visible and this value is true.\",\n    \"2-0\": \"**length**\",\n    \"2-1\": \"**PropTypes.number**\\n\\nThe length of the box in 3D space. Default value is 1.0.\",\n    \"18-0\": \"**width**\",\n    \"18-1\": \"**PropTypes.number**\\n\\nThe width of the box in 3D space. Default value is 1.\",\n    \"4-0\": \"**onClick**\",\n    \"4-1\": \"**React.PropTypes.func**\\n\\nCalled when an objeect has been clicked.\\n\\nExample code:\\n```  \\n_onClick(source)  {\\n    // user has clicked the object\\n}\\n```\",\n    \"5-0\": \"**onClickState**\",\n    \"5-1\": \"**React.PropTypes.func**\\n\\nCalled for each click state an object goes through as it is clicked. Supported click states and their values are the following:\\n\\n|State Value|Description|\\n|:------|:----------:|\\n|1| Click Down: Triggered when the user has performed a click down action while hovering on this control.|\\n|2| Click Up: Triggered when the user has performed a click up action while hovering on this control.|\\n|3| Clicked: Triggered when the user has performed both a click down and click up action on this control sequentially, thereby having \\\"Clicked\\\" the object.|\\n\\nExample code:\\n```  \\n_onClickState(stateValue, source)  {\\n    if(stateValue == 1) {\\n        // Click Down\\n    } else if(stateValue == 2) {\\n        // Click Up\\n    } else if(stateValue == 3) { \\n        // Clicked\\n    }\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\",\n    \"8-0\": \"**onHover**\",\n    \"8-1\": \"**React.PropTypes.func**\\n\\nCalled when the user hovers on or off the control.\\n\\nFor example:\\n```  \\n_onHover(isHovering, source)  {\\n    if(isHovering) {\\n        // user is hovering over the box\\n    } else {\\n        // user is no longer hovering over the box\\n    }\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\",\n    \"9-0\": \"**onScroll**\",\n    \"9-1\": \"**React.PropTypes.func**\\n\\nCalled when the user performs a scroll action, while hovering on the control.\\n\\nFor example:\\n```  \\n_onScroll(scrollPos, source)  {\\n    // scrollPos[0]: x scroll position from 0.0 to 1.0. \\n    // scrollPos[1]: y scroll position from 0.0 to 1.0.\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\\n\\nUnsupported VR Platforms: Cardboard(Android and iOS)\",\n    \"10-0\": \"**onSwipe**\",\n    \"10-1\": \"**React.PropTypes.func**\\n\\nCalled when the user performs a swipe gesture on the physical controller, while hovering on this control. \\n\\nFor example:\\n```  \\n_onSwipe(state, source)  {\\n    if(state == 1) {\\n        // Swiped up\\n    } else if(state == 2) {\\n        // Swiped down\\n    } else if(state == 3) { \\n       // Swiped left\\n    } else if(state == 4) { \\n       // Swiped right\\n    }\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\\n\\nUnsupported VR Platforms: Cardboard(Android and iOS)\",\n    \"11-0\": \"**onTouch**\",\n    \"11-1\": \"**React.PropTypes.func**\\n\\nCalled when the user performs a touch action, while hovering on the control. Provides the touch state type, and the x/y coordinate at which this touch event has occurred.\\n\\n|State Value|Description|\\n|:------|:----------:|\\n|1| Touch Down: Triggered when the user  makes physical contact with the touch pad on the controller. |\\n|2| Touch Down Move: Called when the user moves around the touch pad immediately after having performed a Touch Down action. |\\n|3| Touch Up: Triggered after the user is no longer in physical contact with the touch pad after a Touch Down action. |\\n\\nFor example:\\n```  \\n_onTouch(state, touchPos, source)  {\\n   var touchX = touchPos[0];\\n   var touchY = touchPos[1];\\n    if(state == 1) {\\n        // Touch Down\\n    } else if(state == 2) {\\n        // Touch Down Move\\n    } else if(state == 3) { \\n        // Touch Up\\n    }\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\\n\\nUnsupported VR Platforms: Cardboard(Android and iOS).\",\n    \"6-0\": \"**onDrag**\",\n    \"6-1\": \"**React.PropTypes.func**\\n\\nCalled when the view is currently being dragged. The dragToPos parameter provides the current 3D location of the dragged object. \\n\\nExample code:\\n```  \\n_onDrag(dragToPos, source)  {\\n    // dragtoPos[0]: x position\\n    // dragtoPos[1]: y position\\n    // dragtoPos[2]: z position\\n}\\n``` \\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section. \\n\\nUnsupported VR Platforms: Cardboard iOS\",\n    \"1-1\": \"**PropTypes.bool**\\n\\nTrue if onHover events should use the geometry of the object to determine if the user is hovering over this object. If false, the object's axis-aligned bounding box will be used instead. High accuracy gazing is more accurate but takes more processing power, so it is set to false by default.\",\n    \"1-0\": \"**highAccuracyGaze**\",\n    \"12-0\": \"**opacity**\",\n    \"12-1\": \"**PropTypes.number**\\n\\nA number from 0 to 1 that specifies the opacity of the object. A value of 1 translates into a fully opaque object while 0 represents full transparency.\",\n    \"7-1\": \"**PropTypes.oneOfType**\\n```  \\nPropTypes.oneOfType([\\n      React.PropTypes.shape({\\n        callback: React.PropTypes.func.isRequired,\\n        timeToFuse: PropTypes.number\\n      }),\\n      React.PropTypes.func,\\n])\\n```  \\nAs shown above, onFuse takes one of the types - either a callback, or a dictionary with a callback and duration. \\n\\nIt is called after the user hovers onto and remains hovered on the control for a certain duration of time, as indicated in timeToFuse that represents the duration of time in milliseconds. \\n\\nWhile hovering, the reticle will display a count down animation while fusing towards timeToFuse.\\n\\nNote that timeToFuse defaults to 2000ms.\\n\\nFor example:\\n```  \\n_onFuse(source){\\n   // User has hovered over object for timeToFuse milliseconds\\n}\\n```\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\",\n    \"7-0\": \"**onFuse**\"\n  },\n  \"cols\": 2,\n  \"rows\": 19\n}\n[/block]","excerpt":"","slug":"virobox","type":"basic","title":"ViroBox"}
A simple 3D box that is defined by width, height and length. ######Example use: ``` <ViroBox height={2} length={2} width={2} materials={["boxside"]} /> ``` [block:api-header] { "type": "basic", "title": "Props" } [/block] ##Optional Props [block:parameters] { "data": { "0-0": "**height**", "3-0": "**materials**", "13-0": "**position**", "14-0": "**rotation**", "15-0": "**scale**", "16-0": "**transformBehaviors**", "17-0": "**visible**", "h-0": "PropKey", "h-1": "PropType", "0-1": "**PropTypes.number**\n\nThe height of the box in 3D space. Default value is 1.", "3-1": "**PropTypes.arrayOf(PropTypes.string)**\n\nAn array of strings that each represent a material that was created via ViroMaterials.createMaterials(). A ViroBox can accept one material, which is used for all sides.", "13-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nCartesian position of the box in 3D world space, specified as [x, y, z].", "14-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nThe rotation of the box around it's local axis specified as Euler angles [x, y, z]. Units for each angle are specified in degrees.", "15-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nThe scale of the box in 3D space, specified as [x,y,z]. A scale of 1 represents the current size of the box. A scale value of < 1 will make the box proportionally smaller while a value >1 will make the box proportionally bigger along the specified axis.", "16-1": "**PropTypes.arrayOf(PropTypes.string)**\n\nAn array of transform constraints that affect the transform of the object. For example, putting the value \"billboard\" will ensure the box is facing the user as the user rotates their head on any axis. This is useful for icons or text where you'd like the box to always face the user at a particular rotation.\n\nAllowed values(values are case sensitive):\n\n|Value|Description|\n|:------|:----------:|\n|billboard| Billboard object on x,y,z axis |\n|billboardX| Billboard object on the x axis|\n|billboardY| Billboard object on the y axis|", "17-1": "**PropTypes.bool**\n\nFalse if the box should be hidden. By default the box is visible and this value is true.", "2-0": "**length**", "2-1": "**PropTypes.number**\n\nThe length of the box in 3D space. Default value is 1.0.", "18-0": "**width**", "18-1": "**PropTypes.number**\n\nThe width of the box in 3D space. Default value is 1.", "4-0": "**onClick**", "4-1": "**React.PropTypes.func**\n\nCalled when an objeect has been clicked.\n\nExample code:\n``` \n_onClick(source) {\n // user has clicked the object\n}\n```", "5-0": "**onClickState**", "5-1": "**React.PropTypes.func**\n\nCalled for each click state an object goes through as it is clicked. Supported click states and their values are the following:\n\n|State Value|Description|\n|:------|:----------:|\n|1| Click Down: Triggered when the user has performed a click down action while hovering on this control.|\n|2| Click Up: Triggered when the user has performed a click up action while hovering on this control.|\n|3| Clicked: Triggered when the user has performed both a click down and click up action on this control sequentially, thereby having \"Clicked\" the object.|\n\nExample code:\n``` \n_onClickState(stateValue, source) {\n if(stateValue == 1) {\n // Click Down\n } else if(stateValue == 2) {\n // Click Up\n } else if(stateValue == 3) { \n // Clicked\n }\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.", "8-0": "**onHover**", "8-1": "**React.PropTypes.func**\n\nCalled when the user hovers on or off the control.\n\nFor example:\n``` \n_onHover(isHovering, source) {\n if(isHovering) {\n // user is hovering over the box\n } else {\n // user is no longer hovering over the box\n }\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.", "9-0": "**onScroll**", "9-1": "**React.PropTypes.func**\n\nCalled when the user performs a scroll action, while hovering on the control.\n\nFor example:\n``` \n_onScroll(scrollPos, source) {\n // scrollPos[0]: x scroll position from 0.0 to 1.0. \n // scrollPos[1]: y scroll position from 0.0 to 1.0.\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\n\nUnsupported VR Platforms: Cardboard(Android and iOS)", "10-0": "**onSwipe**", "10-1": "**React.PropTypes.func**\n\nCalled when the user performs a swipe gesture on the physical controller, while hovering on this control. \n\nFor example:\n``` \n_onSwipe(state, source) {\n if(state == 1) {\n // Swiped up\n } else if(state == 2) {\n // Swiped down\n } else if(state == 3) { \n // Swiped left\n } else if(state == 4) { \n // Swiped right\n }\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\n\nUnsupported VR Platforms: Cardboard(Android and iOS)", "11-0": "**onTouch**", "11-1": "**React.PropTypes.func**\n\nCalled when the user performs a touch action, while hovering on the control. Provides the touch state type, and the x/y coordinate at which this touch event has occurred.\n\n|State Value|Description|\n|:------|:----------:|\n|1| Touch Down: Triggered when the user makes physical contact with the touch pad on the controller. |\n|2| Touch Down Move: Called when the user moves around the touch pad immediately after having performed a Touch Down action. |\n|3| Touch Up: Triggered after the user is no longer in physical contact with the touch pad after a Touch Down action. |\n\nFor example:\n``` \n_onTouch(state, touchPos, source) {\n var touchX = touchPos[0];\n var touchY = touchPos[1];\n if(state == 1) {\n // Touch Down\n } else if(state == 2) {\n // Touch Down Move\n } else if(state == 3) { \n // Touch Up\n }\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\n\nUnsupported VR Platforms: Cardboard(Android and iOS).", "6-0": "**onDrag**", "6-1": "**React.PropTypes.func**\n\nCalled when the view is currently being dragged. The dragToPos parameter provides the current 3D location of the dragged object. \n\nExample code:\n``` \n_onDrag(dragToPos, source) {\n // dragtoPos[0]: x position\n // dragtoPos[1]: y position\n // dragtoPos[2]: z position\n}\n``` \nFor the mapping of sources to controller inputs, see the [Events](doc:events) section. \n\nUnsupported VR Platforms: Cardboard iOS", "1-1": "**PropTypes.bool**\n\nTrue if onHover events should use the geometry of the object to determine if the user is hovering over this object. If false, the object's axis-aligned bounding box will be used instead. High accuracy gazing is more accurate but takes more processing power, so it is set to false by default.", "1-0": "**highAccuracyGaze**", "12-0": "**opacity**", "12-1": "**PropTypes.number**\n\nA number from 0 to 1 that specifies the opacity of the object. A value of 1 translates into a fully opaque object while 0 represents full transparency.", "7-1": "**PropTypes.oneOfType**\n``` \nPropTypes.oneOfType([\n React.PropTypes.shape({\n callback: React.PropTypes.func.isRequired,\n timeToFuse: PropTypes.number\n }),\n React.PropTypes.func,\n])\n``` \nAs shown above, onFuse takes one of the types - either a callback, or a dictionary with a callback and duration. \n\nIt is called after the user hovers onto and remains hovered on the control for a certain duration of time, as indicated in timeToFuse that represents the duration of time in milliseconds. \n\nWhile hovering, the reticle will display a count down animation while fusing towards timeToFuse.\n\nNote that timeToFuse defaults to 2000ms.\n\nFor example:\n``` \n_onFuse(source){\n // User has hovered over object for timeToFuse milliseconds\n}\n```\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.", "7-0": "**onFuse**" }, "cols": 2, "rows": 19 } [/block]