ViroARPlane

{"_id":"5c12c34fccfacf00f9af2148","category":{"_id":"5c12c34fccfacf00f9af210c","version":"5c12c34fccfacf00f9af2195","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","user":"576c22a3808cf02b00d37419","parentDoc":null,"version":{"_id":"5c12c34fccfacf00f9af2195","project":"578c4badbd223d2000cc1441","__v":0,"forked_from":"5bec8a15287d1b00426efe54","createdAt":"2018-04-23T20:03:35.726Z","releaseDate":"2018-04-23T20:03:35.726Z","categories":["5c12c34fccfacf00f9af2107","5c12c34fccfacf00f9af2108","5c12c34fccfacf00f9af2109","5c12c34fccfacf00f9af210a","5c12c34fccfacf00f9af210b","5c12c34fccfacf00f9af210c","5c12c34fccfacf00f9af210d","5c12c34fccfacf00f9af210e","5c12c34fccfacf00f9af210f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.13.0","version":"2.13.0"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-16T17:05:55.422Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":11,"body":"A `ViroARPlane` is a component that allows developers to place components relative to a plane discovered by the AR system. The process of attaching a `ViroARPlane` to a plane discovered by the AR system is discussed in the next section.\n[block:api-header]\n{\n \"title\": \"Anchoring\"\n}\n[/block]\nAnchoring is our term for attaching virtual content to detected real-world points/features (anchors). For `ViroARPlanes`, we support two types: manual and automatic anchoring.\n\n### Automatic Anchoring\n\nTo enable automatic anchoring, the developer provides a `minHeight` and `minWidth` to the `ViroARPlane` and adds the content they desire within the `ViroARPlane` component. When the AR system finds a plane that matches the given dimensions, the `ViroARPlane` will be anchored to the real world plane and the child components will be made visible. Any updates to the real-world plane will be given to the developer through the `onAnchorFound`, `onAnchorUpdated`, and `onAnchorRemoved` callback functions. \n\n######Example use:\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"<ViroARPlane minHeight={.5} minWidth={.5} alignment={\\\"Horizontal\\\"}>\\n <ViroBox position={[0, .25, 0]} scale={[.5, .5, .5] />\\n ...\\n</ViroARPlane>\",\n \"language\": \"javascript\"\n }\n ]\n}\n[/block]\n### Manual Anchoring\n\nIn manual anchoring, rather than having the platform determine which real-world feature/anchor the `ViroARPlane` is attached to, the developer is required to listen for all the anchors and \"choose\" the anchor they want the `ViroARPlane` to attach to via the `anchorId` property. To listen for all the anchors, the user should add `onAnchorFound`, `onAnchorUpdated` and `onAnchorRemoved` listeners to their [ViroARScene](doc:viroarscene) component which will receive all anchors that the AR platform discovers.\n\n######Example use:\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"<ViroARPlane anchorId={foundAnchor.anchorId} >\\n <ViroBox position={[0, .25, 0]} scale={[.5, .5, .5] />\\n ...\\n</ViroARPlane>\",\n \"language\": \"javascript\"\n }\n ]\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Props\"\n}\n[/block]\n\n##Optional Props\n[block:parameters]\n{\n \"data\": {\n \"1-0\": \"**anchorId**\",\n \"18-0\": \"**onScroll**\",\n \"19-0\": \"**onSwipe**\",\n \"24-0\": \"**visible**\",\n \"26-0\": \"**rotation**\",\n \"27-0\": \"**scale**\",\n \"28-0\": \"**transformBehaviors**\",\n \"30-0\": \"**volume**\",\n \"31-0\": \"**visible**\",\n \"29-0\": \"**width**\",\n \"h-0\": \"PropKey\",\n \"h-1\": \"PropType\",\n \"1-1\": \"**PropTypes.string**\\n\\n**For Manual Anchoring**, see [Anchoring](doc:viroarplane#anchoring)\\n\\nThe ID of the anchor that the platform should anchor this `ViroARPlane` to. If no [Anchor](doc:viroarscene#anchor) has the specified anchorId, then plane will not be visible until an `Anchor` appears with the same ID.\",\n \"18-1\": \"**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 \"19-1\": \"**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 \"24-1\": \"**PropTypes.bool**\\n\\nFalse if the container should be hidden. By default the container is visible and this value is true.\",\n \"26-1\": \"PropTypes.arrayOf(PropTypes.number)\\n\\nPut the PropType Description here.\",\n \"27-1\": \"PropTypes.arrayOf(PropTypes.number)\\n\\nPut the PropType Description here.\",\n \"28-1\": \"PropTypes.arrayOf(PropTypes.string)\\n\\nPut the PropType Description here.\",\n \"29-1\": \"PropTypes.number\\n\\nPut the PropType Description here.\",\n \"30-1\": \"PropTypes.number\\n\\nPut the PropType Description here.\",\n \"31-1\": \"PropTypes.bool\\n\\nPut the PropType Description here.\",\n \"15-0\": \"**onHover**\",\n \"15-1\": \"**PropTypes.func**\\nFunction to be invoked when the user hovers on or off the container view. If defined, this is only invoked if the child hovered upon doesn't have onHover defined. \\n\\nFor instance, let's say you have a <ViroFlexView> that contains a few buttons and text. If none of them have a onHover handler defined, and they get hovered upon, then this function will invoke, effectively capturing the onHover event from it's children.\\n\\nFor example:\\n``` \\n_onHover(isHovering, position, source) {\\n if(isHovering) {\\n // user is hovering on the container view.\\n } else {\\n // user is no longer hovering on the container view.\\n }\\n}\\n```\\n\\nThe position parameter represents the position in world coordinates on the plane where the click occurred.\\n\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\",\n \"11-0\": \"**onClickState**\",\n \"11-1\": \"**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, position, 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```\\nThe position parameter represents the position in world coordinates on the plane where the click occurred.\\n\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\",\n \"13-0\": \"**onDrag**\",\n \"13-1\": \"**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 \"20-0\": \"**onTouch**\",\n \"20-1\": \"**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 \"21-0\": \"**opacity**\",\n \"21-1\": \"**PropTypes.number**\\n\\nA number from 0 to 1 that specifies the opacity of the container. A value of 1 translates into a fully opaque node while 0 represents full transparency.\",\n \"14-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 \"14-0\": \"**onFuse**\",\n \"10-0\": \"**onClick**\",\n \"10-1\": \"**PropTypes.func**\\n\\nCalled when an objeect has been clicked.\\n\\nExample code:\\n``` \\n_onClick(position, source) {\\n // user has clicked the object\\n}\\n```\\nThe position parameter represents the position in world coordinates on the plane where the click occurred. \\n\\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.\",\n \"6-0\": \"**minWidth**\",\n \"5-0\": \"**minHeight**\",\n \"4-0\": \"**ignoreEventHandling**\",\n \"16-0\": \"**onPinch**\",\n \"17-0\": \"**onRotate**\",\n \"12-0\": \"**onCollision**\",\n \"23-0\": \"**viroTag**\",\n \"7-0\": \"**onAnchorFound**\",\n \"8-0\": \"**onAnchorRemoved**\",\n \"9-0\": \"**onAnchorUpdated**\",\n \"4-1\": \"**PropTypes.bool**\\n\\nWhen set to true, this control will ignore events and not prevent controls behind it from receiving event callbacks.\\n\\nThe default value is false.\",\n \"16-1\": \"**PropTypes.func**\\n\\nCalled when the user performs a pinch gesture on the control. When the pinch starts, the scale factor is set to 1 is relative to the points of the two touch points. \\n\\nFor example:\\n```\\n _onPinch(pinchState, scaleFactor, source) {\\n if(pinchState == 3) {\\n // update scale of obj by multiplying by scaleFactor when pinch ends.\\n return;\\n }\\n //set scale using native props to reflect pinch.\\n }\\n```\\npinchState can be the following values:\\n\\n|State Value|Description|\\n|:------|:----------:|\\n|1| Pinch Start: Triggered when the user has started a pinch gesture.|\\n|2| Pinch Move: Triggered when the user has adjusted the pinch, moving both fingers. |\\n|3| Pinch End: When the user has finishes the pinch gesture and released both touch points. |\\n\\n**This event is only available in AR**.\",\n \"17-1\": \"**PropTypes.func**\\n\\nCalled when the user performs a rotation touch gesture on the control. Rotation factor is returned in degrees.\\n\\nWhen setting rotation, the rotation should be relative to it's current rotation, *not* set to the absolute value of the given rotationFactor.\\n\\nFor example:\\n\\n```\\n _onRotate(rotateState, rotationFactor, source) {\\n\\n if (rotateState == 3) {\\n //set to current rotation - rotationFactor.\\n return;\\n }\\n //update rotation using setNativeProps\\n },\\n\\n```\\nrotationState can be the following values:\\n\\n|State Value|Description|\\n|:------|:----------:|\\n|1| Rotation Start: Triggered when the user has started a rotation gesture.|\\n|2| Rotation Move: Triggered when the user has adjusted the rotation, moving both fingers. |\\n|3| Rotation End: When the user has finishes the rotation gesture and released both touch points. |\\n\\n**This event is only available in AR**.\",\n \"5-1\": \"**PropTypes.number**\\n\\n**For Automatic Anchoring**, see [Anchoring](doc:viroarplane#anchoring) \\n\\nSpecifies the minimum height, in meters, of a plane that this component will \\\"anchor\\\" to.\\n\\nThe default value is 0.\",\n \"6-1\": \"**PropTypes.number**\\n\\n**For Automatic Anchoring**, see [Anchoring](doc:viroarplane#anchoring) \\n\\nSpecifies the minimum width, in meters, of a plane that this component will \\\"anchor\\\" to.\\n\\nThe default value is 0.\",\n \"7-1\": \"**PropTypes.func**\\n\\nCalled when this component is anchored to a plane that is at least `minHeight` by `minWidth` large. This is when the component is made visible.\\n\\n|Parameters | Description |\\n|---|---|\\n|anchor| see [Anchor](doc:viroarscene#anchor) |\",\n \"8-1\": \"**PropTypes.func**\\n\\nCalled when this component is detached from a plane and is no longer visible.\",\n \"9-1\": \"**PropTypes.func**\\n\\nCalled when the plane to which this component is anchored is updated.\\n\\n|Parameters | Description |\\n|---|---|\\n|anchor| see [Anchor](doc:viroarscene#anchor) |\",\n \"12-1\": \"**React.PropTypes.func**\\n\\nCalled when this component's physics body collides with another component's physics body. Also invoked by [ViroScene](doc:viroscene)/[ViroARScene](doc:viroarscene)'s `findCollisions...` functions.\\n\\n|Return Value | Description |\\n|---|---|\\n|viroTag | the given viroTag (string) of the collided component |\\n|collidedPoint | an array of numbers representing the position, in world coordinates, of the point of collision|\\n|collidedNormal | an array representing the normal of the collision in world coordinates. |\",\n \"23-1\": \"**PropTypes.string**\\n\\nA tag given to other components when their physics body collides with this component's physics body. Refer to [physics](doc:physics) for more information.\",\n \"22-0\": \"**pauseUpdates**\",\n \"22-1\": \"**PropTypes.boolean**\\n\\nTrue/False to stop the automatic positioning/rotation of children components of a `ViroARPlane`. This does not stop `onAnchorUpdated` from being called.\",\n \"3-0\": \"**dragType**\",\n \"3-1\": \"**PropTypes.oneOf([\\\"FixedDistance\\\", \\\"FixedToWorld\\\"])**\\n\\nDetermines the behavior of drag if **onDrag** is specified.\\n\\n|Value|Description|\\n|:------|:----------:|\\n|FixedDistance| Dragging is limited to a fixed radius around the user, dragged from the point at which the user has grabbed the geometry containing this draggable node|\\n|FixedDistanceOrigin| Dragging is limited to a fixed radius around the user, dragged from the point of this node's position in world space.|\\n|FixedToWorld| Dragging is based on intersection with real world objects. **Available only in AR** |\\n|FixedToPlane| Dragging is limited to a fixed plane around the user. The configuration of this plane is defined by the **dragPlane** property.| \\n\\nThe default value is \\\"FixedDistance\\\".\",\n \"0-0\": \"**alignment**\",\n \"0-1\": \"**Don't forget to set the `anchorDetectionTypes` prop of [ViroARScene](doc:viroarscene) to tell the AR Session what type of planes to discover.**\\n\\n*Note: \\\"HorizontalUpward\\\" and \\\"HorizontalDownward\\\" are only supported in Android.\\n\\n**PropTypes.oneOf([\\\"Horizontal\\\",\\\"HorizontalUpward\\\",\\\"HorizontalDownward\\\",\\\"Vertical\\\"])**\\n\\n**For Automatic Anchoring**, see [Anchoring](doc:viroarplane#anchoring) \\n\\nSpecifies the desired alignment of a plane that this component will \\\"anchor\\\" to.\\n\\nThe default value is \\\"Horizontal\\\".\",\n \"2-1\": \"**PropTypes.shape({\\n planePoint:PropTypes.arrayOf(PropTypes.number),\\n planeNormal:PropTypes.arrayOf(PropTypes.number), \\n maxDistance:PropTypes.number\\n})**\\n\\n\\nWhen a drag type of \\\"FixedToPlane\\\" is given, dragging is limited to a user defined plane. The dragging behavior is then configured by this property (specified by a point on the plane and its normal vector). You can also limit the maximum distance the dragged object is allowed to travel away from the camera/controller (useful for situations where the user can drag an object towards infinity).\",\n \"2-0\": \"**dragPlane**\",\n \"25-0\": \"**renderingOrder**\",\n \"25-1\": \"**PropTypes.number**\\n\\nThis determines the order in which this Node is rendered relative to other Nodes. Nodes with greater rendering orders are rendered last. The default rendering order is zero. For example, setting a Node's rendering order to -1 will cause the Node to be rendered before all Nodes with rendering orders greater than or equal to 0.\"\n },\n \"cols\": 2,\n \"rows\": 26\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"info\"\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":"viroarplane","type":"basic","title":"ViroARPlane"}

A `ViroARPlane` is a component that allows developers to place components relative to a plane discovered by the AR system. The process of attaching a `ViroARPlane` to a plane discovered by the AR system is discussed in the next section. [block:api-header] { "title": "Anchoring" } [/block] Anchoring is our term for attaching virtual content to detected real-world points/features (anchors). For `ViroARPlanes`, we support two types: manual and automatic anchoring. ### Automatic Anchoring To enable automatic anchoring, the developer provides a `minHeight` and `minWidth` to the `ViroARPlane` and adds the content they desire within the `ViroARPlane` component. When the AR system finds a plane that matches the given dimensions, the `ViroARPlane` will be anchored to the real world plane and the child components will be made visible. Any updates to the real-world plane will be given to the developer through the `onAnchorFound`, `onAnchorUpdated`, and `onAnchorRemoved` callback functions. ######Example use: [block:code] { "codes": [ { "code": "<ViroARPlane minHeight={.5} minWidth={.5} alignment={\"Horizontal\"}>\n <ViroBox position={[0, .25, 0]} scale={[.5, .5, .5] />\n ...\n</ViroARPlane>", "language": "javascript" } ] } [/block] ### Manual Anchoring In manual anchoring, rather than having the platform determine which real-world feature/anchor the `ViroARPlane` is attached to, the developer is required to listen for all the anchors and "choose" the anchor they want the `ViroARPlane` to attach to via the `anchorId` property. To listen for all the anchors, the user should add `onAnchorFound`, `onAnchorUpdated` and `onAnchorRemoved` listeners to their [ViroARScene](doc:viroarscene) component which will receive all anchors that the AR platform discovers. ######Example use: [block:code] { "codes": [ { "code": "<ViroARPlane anchorId={foundAnchor.anchorId} >\n <ViroBox position={[0, .25, 0]} scale={[.5, .5, .5] />\n ...\n</ViroARPlane>", "language": "javascript" } ] } [/block] [block:api-header] { "type": "basic", "title": "Props" } [/block] ##Optional Props [block:parameters] { "data": { "1-0": "**anchorId**", "18-0": "**onScroll**", "19-0": "**onSwipe**", "24-0": "**visible**", "26-0": "**rotation**", "27-0": "**scale**", "28-0": "**transformBehaviors**", "30-0": "**volume**", "31-0": "**visible**", "29-0": "**width**", "h-0": "PropKey", "h-1": "PropType", "1-1": "**PropTypes.string**\n\n**For Manual Anchoring**, see [Anchoring](doc:viroarplane#anchoring)\n\nThe ID of the anchor that the platform should anchor this `ViroARPlane` to. If no [Anchor](doc:viroarscene#anchor) has the specified anchorId, then plane will not be visible until an `Anchor` appears with the same ID.", "18-1": "**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)", "19-1": "**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)", "24-1": "**PropTypes.bool**\n\nFalse if the container should be hidden. By default the container is visible and this value is true.", "26-1": "PropTypes.arrayOf(PropTypes.number)\n\nPut the PropType Description here.", "27-1": "PropTypes.arrayOf(PropTypes.number)\n\nPut the PropType Description here.", "28-1": "PropTypes.arrayOf(PropTypes.string)\n\nPut the PropType Description here.", "29-1": "PropTypes.number\n\nPut the PropType Description here.", "30-1": "PropTypes.number\n\nPut the PropType Description here.", "31-1": "PropTypes.bool\n\nPut the PropType Description here.", "15-0": "**onHover**", "15-1": "**PropTypes.func**\nFunction to be invoked when the user hovers on or off the container view. If defined, this is only invoked if the child hovered upon doesn't have onHover defined. \n\nFor instance, let's say you have a <ViroFlexView> that contains a few buttons and text. If none of them have a onHover handler defined, and they get hovered upon, then this function will invoke, effectively capturing the onHover event from it's children.\n\nFor example:\n``` \n_onHover(isHovering, position, source) {\n if(isHovering) {\n // user is hovering on the container view.\n } else {\n // user is no longer hovering on the container view.\n }\n}\n```\n\nThe position parameter represents the position in world coordinates on the plane where the click occurred.\n\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.", "11-0": "**onClickState**", "11-1": "**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, position, 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```\nThe position parameter represents the position in world coordinates on the plane where the click occurred.\n\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.", "13-0": "**onDrag**", "13-1": "**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", "20-0": "**onTouch**", "20-1": "**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).", "21-0": "**opacity**", "21-1": "**PropTypes.number**\n\nA number from 0 to 1 that specifies the opacity of the container. A value of 1 translates into a fully opaque node while 0 represents full transparency.", "14-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.", "14-0": "**onFuse**", "10-0": "**onClick**", "10-1": "**PropTypes.func**\n\nCalled when an objeect has been clicked.\n\nExample code:\n``` \n_onClick(position, source) {\n // user has clicked the object\n}\n```\nThe position parameter represents the position in world coordinates on the plane where the click occurred. \n\nFor the mapping of sources to controller inputs, see the [Events](doc:events) section.", "6-0": "**minWidth**", "5-0": "**minHeight**", "4-0": "**ignoreEventHandling**", "16-0": "**onPinch**", "17-0": "**onRotate**", "12-0": "**onCollision**", "23-0": "**viroTag**", "7-0": "**onAnchorFound**", "8-0": "**onAnchorRemoved**", "9-0": "**onAnchorUpdated**", "4-1": "**PropTypes.bool**\n\nWhen set to true, this control will ignore events and not prevent controls behind it from receiving event callbacks.\n\nThe default value is false.", "16-1": "**PropTypes.func**\n\nCalled when the user performs a pinch gesture on the control. When the pinch starts, the scale factor is set to 1 is relative to the points of the two touch points. \n\nFor example:\n```\n _onPinch(pinchState, scaleFactor, source) {\n if(pinchState == 3) {\n // update scale of obj by multiplying by scaleFactor when pinch ends.\n return;\n }\n //set scale using native props to reflect pinch.\n }\n```\npinchState can be the following values:\n\n|State Value|Description|\n|:------|:----------:|\n|1| Pinch Start: Triggered when the user has started a pinch gesture.|\n|2| Pinch Move: Triggered when the user has adjusted the pinch, moving both fingers. |\n|3| Pinch End: When the user has finishes the pinch gesture and released both touch points. |\n\n**This event is only available in AR**.", "17-1": "**PropTypes.func**\n\nCalled when the user performs a rotation touch gesture on the control. Rotation factor is returned in degrees.\n\nWhen setting rotation, the rotation should be relative to it's current rotation, *not* set to the absolute value of the given rotationFactor.\n\nFor example:\n\n```\n _onRotate(rotateState, rotationFactor, source) {\n\n if (rotateState == 3) {\n //set to current rotation - rotationFactor.\n return;\n }\n //update rotation using setNativeProps\n },\n\n```\nrotationState can be the following values:\n\n|State Value|Description|\n|:------|:----------:|\n|1| Rotation Start: Triggered when the user has started a rotation gesture.|\n|2| Rotation Move: Triggered when the user has adjusted the rotation, moving both fingers. |\n|3| Rotation End: When the user has finishes the rotation gesture and released both touch points. |\n\n**This event is only available in AR**.", "5-1": "**PropTypes.number**\n\n**For Automatic Anchoring**, see [Anchoring](doc:viroarplane#anchoring) \n\nSpecifies the minimum height, in meters, of a plane that this component will \"anchor\" to.\n\nThe default value is 0.", "6-1": "**PropTypes.number**\n\n**For Automatic Anchoring**, see [Anchoring](doc:viroarplane#anchoring) \n\nSpecifies the minimum width, in meters, of a plane that this component will \"anchor\" to.\n\nThe default value is 0.", "7-1": "**PropTypes.func**\n\nCalled when this component is anchored to a plane that is at least `minHeight` by `minWidth` large. This is when the component is made visible.\n\n|Parameters | Description |\n|---|---|\n|anchor| see [Anchor](doc:viroarscene#anchor) |", "8-1": "**PropTypes.func**\n\nCalled when this component is detached from a plane and is no longer visible.", "9-1": "**PropTypes.func**\n\nCalled when the plane to which this component is anchored is updated.\n\n|Parameters | Description |\n|---|---|\n|anchor| see [Anchor](doc:viroarscene#anchor) |", "12-1": "**React.PropTypes.func**\n\nCalled when this component's physics body collides with another component's physics body. Also invoked by [ViroScene](doc:viroscene)/[ViroARScene](doc:viroarscene)'s `findCollisions...` functions.\n\n|Return Value | Description |\n|---|---|\n|viroTag | the given viroTag (string) of the collided component |\n|collidedPoint | an array of numbers representing the position, in world coordinates, of the point of collision|\n|collidedNormal | an array representing the normal of the collision in world coordinates. |", "23-1": "**PropTypes.string**\n\nA tag given to other components when their physics body collides with this component's physics body. Refer to [physics](doc:physics) for more information.", "22-0": "**pauseUpdates**", "22-1": "**PropTypes.boolean**\n\nTrue/False to stop the automatic positioning/rotation of children components of a `ViroARPlane`. This does not stop `onAnchorUpdated` from being called.", "3-0": "**dragType**", "3-1": "**PropTypes.oneOf([\"FixedDistance\", \"FixedToWorld\"])**\n\nDetermines the behavior of drag if **onDrag** is specified.\n\n|Value|Description|\n|:------|:----------:|\n|FixedDistance| Dragging is limited to a fixed radius around the user, dragged from the point at which the user has grabbed the geometry containing this draggable node|\n|FixedDistanceOrigin| Dragging is limited to a fixed radius around the user, dragged from the point of this node's position in world space.|\n|FixedToWorld| Dragging is based on intersection with real world objects. **Available only in AR** |\n|FixedToPlane| Dragging is limited to a fixed plane around the user. The configuration of this plane is defined by the **dragPlane** property.| \n\nThe default value is \"FixedDistance\".", "0-0": "**alignment**", "0-1": "**Don't forget to set the `anchorDetectionTypes` prop of [ViroARScene](doc:viroarscene) to tell the AR Session what type of planes to discover.**\n\n*Note: \"HorizontalUpward\" and \"HorizontalDownward\" are only supported in Android.\n\n**PropTypes.oneOf([\"Horizontal\",\"HorizontalUpward\",\"HorizontalDownward\",\"Vertical\"])**\n\n**For Automatic Anchoring**, see [Anchoring](doc:viroarplane#anchoring) \n\nSpecifies the desired alignment of a plane that this component will \"anchor\" to.\n\nThe default value is \"Horizontal\".", "2-1": "**PropTypes.shape({\n planePoint:PropTypes.arrayOf(PropTypes.number),\n planeNormal:PropTypes.arrayOf(PropTypes.number), \n maxDistance:PropTypes.number\n})**\n\n\nWhen a drag type of \"FixedToPlane\" is given, dragging is limited to a user defined plane. The dragging behavior is then configured by this property (specified by a point on the plane and its normal vector). You can also limit the maximum distance the dragged object is allowed to travel away from the camera/controller (useful for situations where the user can drag an object towards infinity).", "2-0": "**dragPlane**", "25-0": "**renderingOrder**", "25-1": "**PropTypes.number**\n\nThis determines the order in which this Node is rendered relative to other Nodes. Nodes with greater rendering orders are rendered last. The default rendering order is zero. For example, setting a Node's rendering order to -1 will cause the Node to be rendered before all Nodes with rendering orders greater than or equal to 0." }, "cols": 2, "rows": 26 } [/block] [block:callout] { "type": "info" } [/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]

ViroReact

Getting Started

iOS - Platform Setup

Android - Platform Setup

Basics

Augmented Reality

Enhanced Scenes

Design

Other

API Reference