【Unity学习笔记】UI事件接口和参数PointerEventData

声明：此篇文章是个人学习笔记，并非教程，所以内容可能不够严谨。可作参考，但不保证绝对正确。如果你发现我的文章有什么错误，非常欢迎指正，谢谢哦

【事件接口】

零 事件接口作用：https://blog.csdn.net/eazey_wj/article/details/65632664

一 鼠标移入移出：https://blog.csdn.net/eazey_wj/article/details/65947037

二 鼠标按下抬起点击：https://blog.csdn.net/eazey_wj/article/details/66477004

三：拖拽、拖拽前、拖拽开始、拖拽结束、A拖到B：https://blog.csdn.net/eazey_wj/article/details/69788909

除了上面大佬写的接口外，还有几个接口可以使用

接口名	函数	功能
IScrollHandler	OnScroll	当鼠标滚轮滚动的时候
IUpdateSelectedHandler	OnUpdateSelected	当物体被选中时，每一帧都会触发
ISelectHandler	OnSelect	当物体从未被选中状态切换为选中状态时触发
IDeselectHandler	OnDeselect	当物体从选中状态切换为未被选中状态时触发
IMoveHandler	OnMove	当按下水平移动或垂直移动按钮时触发
ISubmitHandler	OnSubmit	当按下提交按钮时触发
ICancelHandler	OnCancel	当按下取消按钮时触发

上面提到的水平移动按钮、垂直移动按钮、提交按钮、取消按钮在Input Module组件中设置。详见：这里

【参数PointerEventData 】

猜测：上边接口提供的函数都有同一个参数PointerEventData ，猜测上述所有接口函数的实参都是同一个，即若A和B都实现了上述接口的任一个，则Unity在调用二者实现的函数时，传入的PointerEventData 对象是同一个。

官方网站：https://docs.unity3d.com/2018.3/Documentation/ScriptReference/EventSystems.PointerEventData.html

【PointerEventData详解】

button (inputButton)

触发事件的按钮，如鼠标左键、中键、右键。

clickCount (int)

连续点击次数。

经过测试，需要实现了IPointerDownHandler或IPointerClickHandler接口，才会正确更新此值。
通常的用法应当是在除了OnPointerDown函数外的其它函数中使用，因为

如果是在OnPointerDown函数中调用，显示结果应当是上一次点击时，连续点击的次数。
这个连续点击的目标不一定是自身，也可以是实现了实现了IPointerDownHandler或IPointerClickHandler接口的其它UI。
比如在A中实现接口IPointerDownHandler

  public void OnPointerDown(PointerEventData eventData)
    {
       Debug.Log(eventData.clickCount);
    }

我连续点击A三次，会分别输出0，1，2。
因为第一次点击时，上一次没有点击过物体，所以为0。
第二次点击时，上次点击A只连续点了一次，所以是1。
同样道理，第三次点击时由于前一次点击是连续点击了A两次，所以输出2。
如果此时我再单独点击一次A，则输出的是3。再单独点击A一次，就会输出1。

如果在B中实现IPointerDownHandler或IPointerClickHandler接口，则在B中连续点击后，再在A中点击一次同样会输出B中连续点击的次数，相当于二者共用一个eventData参数。

clickTime (float)

上一次发送点击事件的时间，是从游戏开始到当前时间点的累积计时。

delta

当前帧距上一帧鼠标移动的方向
当OnBeginDrag函数被调用时，该值将会从Vector2(0.0f, 0.0f)开始，当OnDrag函数被调用时，会更新此值。
按照官网的代码示例，可以根据deltaValue的值判断拖拽的方向。

public class ExampleScript : MonoBehaviour, IBeginDragHandler, IDragHandler, IEndDragHandler
{
    private float timeCount;
    private Vector2 deltaValue = Vector2.zero;

    public void OnBeginDrag(PointerEventData data)
    {
        deltaValue = Vector2.zero;
    }

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

    public void OnEndDrag(PointerEventData data)
    {
        deltaValue = Vector2.zero;
    }
}

draggin （bool）

判断用户是否正在拖动鼠标

enterEventCamera (Camera)

和上一次OnPointerEnter函数相关联的Camera

hovered (List)

悬停栈中的物体列表
经测试，包含两个物体：鼠标所在位置“最上层勾选了raycastTarget属性的UI“和”Canvas“

lastPress (GameObject)

上一个响应按下事件的物体，如实现了IPointerDownHandler或IPointerClickHandler接口的UI物体，含有Button组件的物体

pointerCurrentRaycast (RaycastResult )

返回从鼠标位置发射射线的碰撞结果

pointerDrag (GameObject)

返回当前脚本所在物体，如果设为null,则不会调用OnDrag 和OnEndDrag函数。

pointerEnter (GameObject)

触发OnPointerEnter的物体

pointerId (int)

指针的标识
如果使用的鼠标，则返回-1，-2，-3分别对应鼠标左键、中键和右键。如果是移动端触屏，则从0开始到设备支持的最大触摸个数。

pointerPress （GameObject）

触发OnPointerDown的物体

pointerPressRaycast （GameObject）

鼠标点击时，射线返回的物体

position (Vector2)

鼠标位置，左下角为（0，0），如果在窗口模式下，鼠标位置坐标可以超出窗口尺寸。

pressEventCamera (Camera)

与上一次OnPointerPress 事件相关的摄像头

pressPosition (Vector2)

上一次点击时，鼠标在屏幕坐标系下的位置坐标。

rawPointerPress （GameObject）

此次点击的物体。

scrollDelta （Vector2）

鼠标滚轮当前滚动的方向，（0，1）表示向上滚动，（0，-1）表示向下滚动

useDragThreshold (bool)

是否使用拖拽阈值。如果启用了，那么只有当鼠标当前帧和上一帧的插值达到拖拽阈值时，才会触发拖拽事件。
如果想将此项设为false，需要在IInitializePotentialDragHandler.OnInitializePotentialDrag中进行设置。 
在EventSystem组件中可以设置拖拽阈值：Drag Threshold属性（以像素为单位）

相关问题和解决方案:

https://stackoverflow.com/questions/58916459/is-there-a-fast-way-to-detect-drag-events-on-a-game-object-in-unity

https://blog.csdn.net/aawoe/article/details/89846180