Legacy Documentation: Version 2018.2 (Go to current version)
LanguageEnglish
  • C#

PointerEventData.position

Suggest a change

Success!

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.

Close

Submission failed

For 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.

Close

Cancel

public Vector2 position;

Description

Current pointer position.

The position is where Vector2 locates it. For example, if OnDrag is used the PointerEventData argument will include the position. Moving the mouse will change the position. The value of position will come from the PointerEventData. The position value is window-based. This is zero-zero bottom left.

The script example of position below displays the position of the mouse. For example an aspect ratio of 800x600 will allow the position value to vary in this range. Note, however, the mouse can move outside of the window and the position will change beyond the size of the window. If the game is played full-screen then the position will stay inside the window.

// Window is 800x600 pixels.  It holds an Image of 600x550 and this hosts a Panel.
// The Panel on the RectTransform defines the resolution of the ScrollView.
// As the cursor moves the three Drag functions are used.

using UnityEngine; using UnityEngine.EventSystems; using UnityEngine.UI;

public class ExampleScript : MonoBehaviour, IBeginDragHandler, IDragHandler, IEndDragHandler { private float timeCount;

public void OnBeginDrag(PointerEventData data) { Debug.Log("OnBeginDrag: " + data.position); }

public void OnDrag(PointerEventData data) { if (data.dragging) { timeCount += Time.deltaTime; if (timeCount > 1.0f) { Debug.Log("Dragging:" + data.position); timeCount = 0.0f; } } }

public void OnEndDrag(PointerEventData data) { Debug.Log("OnEndDrag: " + data.position); } }

Did you find this page useful? Please give it a rating: