Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseDetermines whether the user is dragging the mouse or trackpad.
PointerEventData.dragging returns true when the user is moving the mouse or trackpad pointer. Returns false when the mouse or trackpad pointer is not moving. The dragging uses the move of the mouse or trackpad finger. OnDrag includes the dragging event.
The example below uses the IBeginDragHandler, IDragHandler, and IEndDragHandler interfaces. They provide EventTrigger.OnBeginDrag, EventTrigger.OnDrag, and EventTrigger.OnEndDrag event handlers respectively. IDragHandler.OnDrag queries when the pointer starts moving, and only sends a message when the user drags the pointer.
using UnityEngine; using UnityEngine.EventSystems; using UnityEngine.UI;
// PointerEventDrag.dragging example.
// PointerEventData.dragging is set totruewhen the object is moving. // Otherwise dragging is set tofalse. // // Create a 2D Project and add a Canvas and an Image as a child. Position the Image in the center // of the Canvas. Resize the Image to approximately a quarter of the height and width. Create a // Resources folder and add a sprite. Set the sprite to the Image component. Then add this script // to the Image. Then press the Play button. The Image should be clickable and moved with the // mouse or trackpad.
public class Example : MonoBehaviour, IBeginDragHandler, IDragHandler, IEndDragHandler { private Vector3 position; private float timeCount = 0.0f;
public void OnBeginDrag(PointerEventData eventData) { position = transform.position; Debug.Log("OnBeginDrag: " + position); }
// Drag the selected item. public void OnDrag(PointerEventData data) { if (data.dragging) { // Object is being dragged. timeCount += Time.deltaTime; if (timeCount > 0.25f) { Debug.Log("Dragging:" + data.position); timeCount = 0.0f; } } transform.position = data.position; }
public void OnEndDrag(PointerEventData eventData) { transform.position = position; Debug.Log("OnEndDrag: " + position); } }
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thanks for helping to make the Unity documentation better!