{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"VRTK_UICanvas","type":"basic","slug":"vrtk_uicanvas","excerpt":"","body":"## Overview\n\nDenotes a Unity World UI Canvas can be interacted with a UIPointer script.\n\n**Script Usage:**\n * Place the `VRTK_UICanvas` script on the Unity World UI Canvas to allow UIPointer interactions with.\n\n**Script Dependencies:**\n * A UI Pointer attached to another GameObject (e.g. controller script alias) to interact with the UICanvas script.\n\n## Inspector Parameters\n\n * **Click On Pointer Collision:** Determines if a UI Click action should happen when a UI Pointer game object collides with this canvas.\n * **Auto Activate Within Distance:** Determines if a UI Pointer will be auto activated if a UI Pointer game object comes within the given distance of this canvas. If a value of `0` is given then no auto activation will occur.\n\n## Example\n\n`VRTK/Examples/034_Controls_InteractingWithUnityUI` uses the `VRTK_UICanvas` script on two of the canvases to show how the UI Pointer can interact with them.","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b1f8576c2505d0003125459","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"UI","slug":"ui","order":12,"from_sync":false,"reference":false,"_id":"5b1f8576c2505d000312542f","version":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","createdAt":"2017-01-01T17:00:24.070Z","__v":0},"parentDoc":null,"user":"571fa519db52d01700f5cf3d","project":"571fa55ca0acd42000af9545","version":{"version":"3.3.0","version_clean":"3.3.0","codename":"Mangalica","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5b1f8576c2505d0003125424","5b1f8576c2505d0003125425","5b1f8576c2505d0003125426","5b1f8576c2505d0003125427","5b1f8576c2505d0003125428","5b1f8576c2505d0003125429","5b1f8576c2505d000312542a","5b1f8576c2505d000312542b","5b1f8576c2505d000312542c","5b1f8576c2505d000312542d","5b1f8576c2505d000312542e","5b1f8576c2505d000312542f","5b1f8576c2505d0003125430","5b1f8576c2505d0003125431","5b1f8576c2505d0003125432","5b1f8576c2505d0003125433","5b1f8576c2505d0003125434","5b1f8576c2505d0003125435","5b1f8576c2505d0003125436","5b1f8576c2505d0003125437","5b1f8576c2505d0003125438","5b1f8aab9c683000032979e7","5b1f8b2f3073470003ffa5da","5b1f8bd9fd653400031d94f4","5b1f900bd4c5f000036b57bd"],"_id":"5b1f8576c2505d00031254db","project":"571fa55ca0acd42000af9545","__v":4,"forked_from":"594949e52be16d0026ec04cd","createdAt":"2017-06-20T16:14:29.816Z","releaseDate":"2017-06-20T16:14:29.816Z"},"createdAt":"2017-01-01T17:00:53.933Z","githubsync":"","__v":0}
## Overview Denotes a Unity World UI Canvas can be interacted with a UIPointer script. **Script Usage:** * Place the `VRTK_UICanvas` script on the Unity World UI Canvas to allow UIPointer interactions with. **Script Dependencies:** * A UI Pointer attached to another GameObject (e.g. controller script alias) to interact with the UICanvas script. ## Inspector Parameters * **Click On Pointer Collision:** Determines if a UI Click action should happen when a UI Pointer game object collides with this canvas. * **Auto Activate Within Distance:** Determines if a UI Pointer will be auto activated if a UI Pointer game object comes within the given distance of this canvas. If a value of `0` is given then no auto activation will occur. ## Example `VRTK/Examples/034_Controls_InteractingWithUnityUI` uses the `VRTK_UICanvas` script on two of the canvases to show how the UI Pointer can interact with them.