{"__v":0,"_id":"58f7a4c8cbd001190056cc0f","category":{"version":"58f7a4c8cbd001190056cbf8","project":"578c4badbd223d2000cc1441","_id":"58f7a4c8cbd001190056cbfe","__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"},"parentDoc":null,"project":"578c4badbd223d2000cc1441","user":"57bb7defafc18c0e00529cf1","version":{"__v":1,"_id":"58f7a4c8cbd001190056cbf8","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-18T04:25:28.759Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"A component that displays a 2D Button that is positioned in 3D world space. The button will animate onTap and switch the button look based on its state.\n\n######Example use:\n```\n<ViroButton\n    source={require(\"./res/button_base.jpg\")}\n    gazeSource={require(\"./res/button_on_gazing.jpg\")}\n    tapSource={require(\"./res/button_on_tap_pressed.jpg\")}\n    position={[1, 3, -5]}\n    height={2}\n    width={3}\n    onTap={this._onButtonTap}\n    onGaze={this._onButtonGaze />\n    \n.....\n//outside of render method\n  _onButtonGaze() {\n      this.setState({\n          buttonStateTag: \"onGaze\"\n      });\n  },\n  _onButtonTap() {\n      this.setState({\n          buttonStateTag: \"onTap\"\n      });\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    \"h-0\": \"PropKey\",\n    \"h-1\": \"PropType\",\n    \"0-0\": \"**source**\",\n    \"0-1\": \"**PropTypes.oneOfType( [PropTypes.shape( {uri:  PropTypes.string} ), PropTypes.number] )**\\n\\nThe button image source, a remote URL or a local file resource. PNG and JPG images accepted.\\n\\nTo invoke with remote url: \\n```\\n{uri:\\\"http://example.org/buttonImage.png\\\"}\\n```\\nTo invoke with local source:\\n```\\nrequire('./buttonImage.png');\\n```\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n##Optional Props\n[block:parameters]\n{\n  \"data\": {\n    \"1-0\": \"**height**\",\n    \"7-0\": \"**onHover**\",\n    \"12-0\": \"**position**\",\n    \"13-0\": \"**rotation**\",\n    \"14-0\": \"**scale**\",\n    \"17-0\": \"**transformBehaviors**\",\n    \"18-0\": \"**visible**\",\n    \"h-0\": \"PropKey\",\n    \"h-1\": \"PropType\",\n    \"1-1\": \"**PropTypes.number**\\n\\nThe height of the button in 3D space. Default value is 1.\",\n    \"7-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    \"12-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nCartesian position of the button in 3D world space, specified as [x, y, z].\",\n    \"13-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nThe rotation of the button around it's local axis specified as Euler angles [x, y, z]. Units for each angle are specified in degrees.\",\n    \"14-1\": \"**PropTypes.arrayOf(PropTypes.number)**\\n\\nThe scale of the button in 3D space, specified as [x,y,z]. A scale of 1 represents the current size of the button. A scale value of < 1 will make the box proportionally smaller while a value >1 will make the button proportionally bigger along the specified axis.\",\n    \"17-1\": \"**PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string),PropTypes.string])**\\n\\nAn array of transform constraints that affect the transform of the button. For example, putting the value \\\"billboard\\\" will ensure the button is facing the user as the user rotates their head on any axis. This is useful for having the button always face the user on a particular axis.\\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    \"18-1\": \"**PropTypes.bool**\\n\\nFalse if the button should be hidden. By default the button is visible and this value is true.\",\n    \"16-0\": \"**tapSource**\",\n    \"16-1\": \"**PropTypes.oneOfType( [PropTypes.shape( {uri:  PropTypes.string} ), PropTypes.number] )**\\n\\nThe image to display when on the button when the user taps the button.\\n\\n Accepts a remote URL or a local file resource. PNG and JPG images accepted.\\n\\nTo invoke with remote url: {uri:\\\"http://example.org/myimage.png\\\"}\\n\\nTo invoke with local source:\\nrequire('./image.png');\",\n    \"19-0\": \"**width**\",\n    \"19-1\": \"**PropTypes.number**\\n\\nThe width of the button in 3D space. Default value is 1.\",\n    \"0-0\": \"**gazeSource**\",\n    \"0-1\": \"**PropTypes.oneOfType([ PropTypes.shape({ uri: PropTypes.string,})**\\n    \\nThe image to display when on the button when the user is gazing over it.\\n\\n Accepts a remote URL or a local file resource. PNG and JPG images accepted.\\n\\nTo invoke with remote url: \\n```\\n{uri:\\\"http://example.org/myimage.png\\\"}\\n```\\nTo invoke with local source:\\n```\\nrequire('./image.png');\\n```\",\n    \"8-0\": \"**onScroll**\",\n    \"8-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    \"15-0\": \"**style**\",\n    \"15-1\": \"**stylePropType**\\n\\nRefers to style property that is only used if the ViroButton is within a ViroFlexView. Style properties determine the position and scale of the button within a ViroFlexView. Please see our guide on styles for my information.\",\n    \"2-0\": \"**materials**\",\n    \"2-1\": \"**PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string),PropTypes.string])**\\n\\nAn array of strings that each represent a material that was created via ViroMaterials.createMaterials(). \\n\\nViroButton takes 1 material, where the material's properties, except the diffuseTexture, are applied to the source, gaze and tap images provided to this button.\",\n    \"3-0\": \"**onClick**\",\n    \"3-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    \"4-0\": \"**onClickState**\",\n    \"4-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    \"9-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    \"10-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    \"9-0\": \"**onSwipe**\",\n    \"10-0\": \"**onTouch**\",\n    \"5-0\": \"**onDrag**\",\n    \"5-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    \"11-0\": \"**opacity**\",\n    \"11-1\": \"**PropTypes.number**\\n\\nA number from 0 to 1 that specifies the opacity of the button. A value of 1 translates into a fully opaque button while 0 represents full transparency.\",\n    \"6-0\": \"**onFuse**\",\n    \"6-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  },\n  \"cols\": 2,\n  \"rows\": 20\n}\n[/block]","excerpt":"","slug":"virobutton","type":"basic","title":"ViroButton"}
A component that displays a 2D Button that is positioned in 3D world space. The button will animate onTap and switch the button look based on its state. ######Example use: ``` <ViroButton source={require("./res/button_base.jpg")} gazeSource={require("./res/button_on_gazing.jpg")} tapSource={require("./res/button_on_tap_pressed.jpg")} position={[1, 3, -5]} height={2} width={3} onTap={this._onButtonTap} onGaze={this._onButtonGaze /> ..... //outside of render method _onButtonGaze() { this.setState({ buttonStateTag: "onGaze" }); }, _onButtonTap() { this.setState({ buttonStateTag: "onTap" }); } ``` [block:api-header] { "type": "basic", "title": "Props" } [/block] ##Required Props [block:parameters] { "data": { "h-0": "PropKey", "h-1": "PropType", "0-0": "**source**", "0-1": "**PropTypes.oneOfType( [PropTypes.shape( {uri: PropTypes.string} ), PropTypes.number] )**\n\nThe button image source, a remote URL or a local file resource. PNG and JPG images accepted.\n\nTo invoke with remote url: \n```\n{uri:\"http://example.org/buttonImage.png\"}\n```\nTo invoke with local source:\n```\nrequire('./buttonImage.png');\n```" }, "cols": 2, "rows": 1 } [/block] ##Optional Props [block:parameters] { "data": { "1-0": "**height**", "7-0": "**onHover**", "12-0": "**position**", "13-0": "**rotation**", "14-0": "**scale**", "17-0": "**transformBehaviors**", "18-0": "**visible**", "h-0": "PropKey", "h-1": "PropType", "1-1": "**PropTypes.number**\n\nThe height of the button in 3D space. Default value is 1.", "7-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.", "12-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nCartesian position of the button in 3D world space, specified as [x, y, z].", "13-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nThe rotation of the button around it's local axis specified as Euler angles [x, y, z]. Units for each angle are specified in degrees.", "14-1": "**PropTypes.arrayOf(PropTypes.number)**\n\nThe scale of the button in 3D space, specified as [x,y,z]. A scale of 1 represents the current size of the button. A scale value of < 1 will make the box proportionally smaller while a value >1 will make the button proportionally bigger along the specified axis.", "17-1": "**PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string),PropTypes.string])**\n\nAn array of transform constraints that affect the transform of the button. For example, putting the value \"billboard\" will ensure the button is facing the user as the user rotates their head on any axis. This is useful for having the button always face the user on a particular axis.\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|", "18-1": "**PropTypes.bool**\n\nFalse if the button should be hidden. By default the button is visible and this value is true.", "16-0": "**tapSource**", "16-1": "**PropTypes.oneOfType( [PropTypes.shape( {uri: PropTypes.string} ), PropTypes.number] )**\n\nThe image to display when on the button when the user taps the button.\n\n Accepts a remote URL or a local file resource. PNG and JPG images accepted.\n\nTo invoke with remote url: {uri:\"http://example.org/myimage.png\"}\n\nTo invoke with local source:\nrequire('./image.png');", "19-0": "**width**", "19-1": "**PropTypes.number**\n\nThe width of the button in 3D space. Default value is 1.", "0-0": "**gazeSource**", "0-1": "**PropTypes.oneOfType([ PropTypes.shape({ uri: PropTypes.string,})**\n \nThe image to display when on the button when the user is gazing over it.\n\n Accepts a remote URL or a local file resource. PNG and JPG images accepted.\n\nTo invoke with remote url: \n```\n{uri:\"http://example.org/myimage.png\"}\n```\nTo invoke with local source:\n```\nrequire('./image.png');\n```", "8-0": "**onScroll**", "8-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)", "15-0": "**style**", "15-1": "**stylePropType**\n\nRefers to style property that is only used if the ViroButton is within a ViroFlexView. Style properties determine the position and scale of the button within a ViroFlexView. Please see our guide on styles for my information.", "2-0": "**materials**", "2-1": "**PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string),PropTypes.string])**\n\nAn array of strings that each represent a material that was created via ViroMaterials.createMaterials(). \n\nViroButton takes 1 material, where the material's properties, except the diffuseTexture, are applied to the source, gaze and tap images provided to this button.", "3-0": "**onClick**", "3-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```", "4-0": "**onClickState**", "4-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.", "9-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)", "10-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).", "9-0": "**onSwipe**", "10-0": "**onTouch**", "5-0": "**onDrag**", "5-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", "11-0": "**opacity**", "11-1": "**PropTypes.number**\n\nA number from 0 to 1 that specifies the opacity of the button. A value of 1 translates into a fully opaque button while 0 represents full transparency.", "6-0": "**onFuse**", "6-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." }, "cols": 2, "rows": 20 } [/block]