{"_id":"58796781cd4a9c37007c971e","parentDoc":null,"category":{"_id":"58796781cd4a9c37007c96f9","__v":0,"version":"58796781cd4a9c37007c96ef","project":"571fa55ca0acd42000af9545","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-01-01T17:00:24.070Z","from_sync":false,"order":11,"slug":"ui","title":"UI"},"user":"571fa519db52d01700f5cf3d","__v":0,"version":{"_id":"58796781cd4a9c37007c96ef","__v":4,"project":"571fa55ca0acd42000af9545","createdAt":"2017-01-13T23:49:21.393Z","releaseDate":"2017-01-13T23:49:21.393Z","categories":["58796781cd4a9c37007c96f0","58796781cd4a9c37007c96f1","58796781cd4a9c37007c96f2","58796781cd4a9c37007c96f3","58796781cd4a9c37007c96f4","58796781cd4a9c37007c96f5","58796781cd4a9c37007c96f6","58796781cd4a9c37007c96f7","58796781cd4a9c37007c96f8","58796781cd4a9c37007c96f9","58796781cd4a9c37007c96fa","58796781cd4a9c37007c96fb","58796781cd4a9c37007c96fc","58796781cd4a9c37007c96fd","58796781cd4a9c37007c96fe","58796781cd4a9c37007c96ff","58796781cd4a9c37007c9700","58b157ca1756cf370022f90d","58b1596f5dae732f00adeca2","58b1605a5dae732f00adecb1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Mukota","version_clean":"3.1.0","version":"3.1.0"},"project":"571fa55ca0acd42000af9545","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-01-01T17:01:15.985Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"> extends MonoBehaviour, IBeginDragHandler, IDragHandler, IEndDragHandler\n\n## Overview\n\nThe UI Draggable item will make any UI element draggable on the canvas.\n\nIf a UI Draggable item is set to `Restrict To Drop Zone = true` then the UI Draggable item must be a child of an element that has the VRTK_UIDropZone script applied to it to ensure it starts in a valid drop zone.\n\n## Inspector Parameters\n\n * **Restrict To Drop Zone:** If checked then the UI element can only be dropped in valid a VRTK_UIDropZone object and must start as a child of a VRTK_UIDropZone object. If unchecked then the UI element can be dropped anywhere on the canvas.\n * **Restrict To Original Canvas:** If checked then the UI element can only be dropped on the original parent canvas. If unchecked the UI element can be dropped on any valid VRTK_UICanvas.\n * **Forward Offset:** The offset to bring the UI element forward when it is being dragged.\n\n## Class Variables\n\n * `public GameObject validDropZone` - The current valid drop zone the dragged element is hovering over.\n\n## Example\n\n`VRTK/Examples/034_Controls_InteractingWithUnityUI` demonstrates a collection of UI elements that are draggable","excerpt":"","slug":"vrtk_uidraggableitem","type":"basic","title":"VRTK_UIDraggableItem"}

VRTK_UIDraggableItem


> extends MonoBehaviour, IBeginDragHandler, IDragHandler, IEndDragHandler ## Overview The UI Draggable item will make any UI element draggable on the canvas. If a UI Draggable item is set to `Restrict To Drop Zone = true` then the UI Draggable item must be a child of an element that has the VRTK_UIDropZone script applied to it to ensure it starts in a valid drop zone. ## Inspector Parameters * **Restrict To Drop Zone:** If checked then the UI element can only be dropped in valid a VRTK_UIDropZone object and must start as a child of a VRTK_UIDropZone object. If unchecked then the UI element can be dropped anywhere on the canvas. * **Restrict To Original Canvas:** If checked then the UI element can only be dropped on the original parent canvas. If unchecked the UI element can be dropped on any valid VRTK_UICanvas. * **Forward Offset:** The offset to bring the UI element forward when it is being dragged. ## Class Variables * `public GameObject validDropZone` - The current valid drop zone the dragged element is hovering over. ## Example `VRTK/Examples/034_Controls_InteractingWithUnityUI` demonstrates a collection of UI elements that are draggable