mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-03-22 10:34:30 +08:00
feat(godot): 添加2D拖拽功能组件
- 新增抽象基类 AbstractDragDrop2DComponentBase,提供基础拖拽信号和属性 - 实现 AbstractDragDropArea2DComponent 类,处理具体拖拽逻辑与输入事件 - 支持拖拽开始、取消、放置等完整交互流程 - 集成 Godot 节点生命周期管理与输入系统 - 添加对拖拽组、Z轴层级及偏移量的控制支持 - 引入 Godot.SourceGenerators 包以支持信号生成
This commit is contained in:
parent
ceb7219fa1
commit
7e93d7d089
@ -9,6 +9,7 @@
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Godot.SourceGenerators" Version="4.5.1"/>
|
||||
<PackageReference Include="GodotSharpEditor" Version="4.5.1"/>
|
||||
</ItemGroup>
|
||||
|
||||
|
||||
@ -0,0 +1,100 @@
|
||||
using GFramework.Core.architecture;
|
||||
using GFramework.Core.controller;
|
||||
using GFramework.Core.events;
|
||||
using GFramework.Core.extensions;
|
||||
using Godot;
|
||||
|
||||
namespace GFramework.Core.Godot.component;
|
||||
|
||||
/// <summary>
|
||||
/// 抽象基类,用于实现2D拖拽功能的组件。
|
||||
/// 继承自Godot的Node类并实现了IController接口。
|
||||
/// 提供了拖拽相关的信号定义以及基础属性配置。
|
||||
/// </summary>
|
||||
public abstract partial class AbstractDragDrop2DComponentBase : Node, IController
|
||||
{
|
||||
/// <summary>
|
||||
/// 取消注册列表,用于管理需要在节点销毁时取消注册的对象
|
||||
/// </summary>
|
||||
protected readonly IUnRegisterList UnRegisterList = new UnRegisterList();
|
||||
|
||||
/// <summary>
|
||||
/// 当拖拽被取消时触发的信号。
|
||||
/// </summary>
|
||||
/// <param name="startingPosition">拖拽起始位置。</param>
|
||||
[Signal]
|
||||
public delegate void DragCanceledEventHandler(Vector2 startingPosition);
|
||||
|
||||
/// <summary>
|
||||
/// 当拖拽开始时触发的信号。
|
||||
/// </summary>
|
||||
[Signal]
|
||||
public delegate void DragStartedEventHandler();
|
||||
|
||||
/// <summary>
|
||||
/// 当拖拽结束并放置时触发的信号。
|
||||
/// </summary>
|
||||
/// <param name="startingPosition">拖拽起始位置。</param>
|
||||
[Signal]
|
||||
public delegate void DroppedEventHandler(Vector2 startingPosition);
|
||||
|
||||
/// <summary>
|
||||
/// 是否启用拖拽功能。若为 false,则忽略所有输入事件。
|
||||
/// </summary>
|
||||
public bool Enable { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 拖拽组的名称,用于区分不同的拖拽组。
|
||||
/// </summary>
|
||||
public string GroupName { get; set; } = "dragging";
|
||||
|
||||
/// <summary>
|
||||
/// 获取或设置取消拖拽输入操作的名称
|
||||
/// </summary>
|
||||
public string CancelDragInputActionName { get; set; } = "cancel_drag";
|
||||
|
||||
/// <summary>
|
||||
/// 获取或设置选择输入操作的名称
|
||||
/// </summary>
|
||||
public string SelectInputActionName { get; set; } = "select";
|
||||
|
||||
/// <summary>
|
||||
/// 拖拽时元素的最大Z轴索引值。
|
||||
/// </summary>
|
||||
public int ZIndexMax { get; set; } = 99;
|
||||
|
||||
/// <summary>
|
||||
/// 拖拽时元素的最小Z轴索引值。
|
||||
/// </summary>
|
||||
public int ZIndexMin { get; set; } = 0;
|
||||
|
||||
/// <summary>
|
||||
/// 获取架构实例。
|
||||
/// </summary>
|
||||
/// <returns>返回实现IArchitecture接口的架构实例。</returns>
|
||||
public abstract IArchitecture GetArchitecture();
|
||||
|
||||
/// <summary>
|
||||
/// 表示是否正在拖拽操作的标志位。
|
||||
/// </summary>
|
||||
protected bool IsDragging;
|
||||
|
||||
/// <summary>
|
||||
/// 表示拖拽操作中的偏移量,用于计算当前位置与起始位置的差值。
|
||||
/// </summary>
|
||||
protected Vector2 Offset = Vector2.Zero;
|
||||
|
||||
/// <summary>
|
||||
/// 表示拖拽操作的起始位置坐标。
|
||||
/// </summary>
|
||||
protected Vector2 StartingPosition;
|
||||
|
||||
/// <summary>
|
||||
/// 节点退出场景树时的回调方法。
|
||||
/// 在节点从场景树移除前调用,用于清理资源。
|
||||
/// </summary>
|
||||
public override void _ExitTree()
|
||||
{
|
||||
UnRegisterList.UnRegisterAll();
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,127 @@
|
||||
using GFramework.Core.Godot.extensions;
|
||||
using Godot;
|
||||
|
||||
namespace GFramework.Core.Godot.component;
|
||||
|
||||
/// <summary>
|
||||
/// 抽象拖拽组件类,用于处理节点的拖放逻辑。
|
||||
/// 实现了 IController 接口以支持架构通信,并通过信号通知拖拽事件的发生。
|
||||
/// </summary>
|
||||
public abstract partial class AbstractDragDropArea2DComponent : AbstractDragDrop2DComponentBase
|
||||
{
|
||||
/// <summary>
|
||||
/// 目标区域,通常是可交互的游戏对象(如单位或物品)所在的碰撞区域。
|
||||
/// </summary>
|
||||
public required Area2D Target { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// 节点准备就绪时的回调方法。
|
||||
/// 在节点添加到场景树后调用,绑定目标区域的输入事件处理器。
|
||||
/// </summary>
|
||||
public override void _Ready()
|
||||
{
|
||||
Target = GetParent() as Area2D ?? throw new InvalidOperationException("Target must be an Area2D node.");
|
||||
Target.InputEvent += OnTargetInputEvent;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 处理输入事件的回调方法。
|
||||
/// 根据当前拖拽状态和输入事件类型,执行相应的拖拽操作。
|
||||
/// </summary>
|
||||
/// <param name="event">输入事件对象</param>
|
||||
public override void _Input(InputEvent @event)
|
||||
{
|
||||
switch (IsDragging)
|
||||
{
|
||||
// 处理取消拖拽操作:当正在拖拽且按下取消拖拽按键时,执行取消拖拽逻辑
|
||||
case true when Target.IsValidNode() && @event.IsActionPressed(CancelDragInputActionName):
|
||||
CancelDragging();
|
||||
// 设置输入为处理,防止输入穿透
|
||||
this.SetInputAsHandled();
|
||||
break;
|
||||
case true when @event.IsActionReleased(SelectInputActionName):
|
||||
Drop();
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 目标区域的输入事件处理器。
|
||||
/// 当目标区域接收到输入事件时被调用,用于控制拖拽的开始和结束。
|
||||
/// </summary>
|
||||
/// <param name="viewport">事件发生的视口节点</param>
|
||||
/// <param name="event">输入事件对象</param>
|
||||
/// <param name="_">事件触点ID(未使用)</param>
|
||||
private void OnTargetInputEvent(Node viewport, InputEvent @event, long _)
|
||||
{
|
||||
if (!Enable) return;
|
||||
|
||||
// 获取当前正在拖拽的对象
|
||||
var draggingObj = GetTree().GetFirstNodeInGroup(GroupName);
|
||||
switch (IsDragging)
|
||||
{
|
||||
// 处理开始拖拽操作:当未在拖拽状态且按下选择按键时,开始拖拽
|
||||
case false when
|
||||
// 如果当前没有拖拽操作且已有其他对象正在拖拽,则直接返回
|
||||
draggingObj is not null:
|
||||
return;
|
||||
case false when @event.IsActionPressed(SelectInputActionName):
|
||||
StartDragging();
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 每帧更新逻辑,在拖拽过程中持续更新目标的位置。
|
||||
/// </summary>
|
||||
/// <param name="delta">与上一帧的时间间隔(秒)。</param>
|
||||
public override void _Process(double delta)
|
||||
{
|
||||
if (IsDragging && Target.IsValidNode()) Target.GlobalPosition = Target.GetGlobalMousePosition() + Offset;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 结束拖拽流程的基础方法。
|
||||
/// 清除拖拽标志位并将目标从拖拽组中移除,恢复其层级顺序。
|
||||
/// </summary>
|
||||
private void EndDragging()
|
||||
{
|
||||
IsDragging = false;
|
||||
Target.RemoveFromGroup(GroupName);
|
||||
Target.ZIndex = ZIndexMin;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 执行取消拖拽的操作。
|
||||
/// 调用 EndDragging 并发出 DragCanceled 信号。
|
||||
/// </summary>
|
||||
private void CancelDragging()
|
||||
{
|
||||
EndDragging();
|
||||
EmitSignalDragCanceled(StartingPosition);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 开始拖拽操作。
|
||||
/// 设置初始位置和偏移量,将目标加入拖拽组并提升显示层级,最后发出 DragStarted 信号。
|
||||
/// </summary>
|
||||
private void StartDragging()
|
||||
{
|
||||
IsDragging = true;
|
||||
StartingPosition = Target.GlobalPosition;
|
||||
Target.AddToGroup(GroupName);
|
||||
Target.ZIndex = ZIndexMax;
|
||||
Offset = Target.GlobalPosition - Target.GetGlobalMousePosition();
|
||||
EmitSignalDragStarted();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 完成一次拖拽操作。
|
||||
/// 调用 EndDragging 方法并发出 Dropped 信号。
|
||||
/// </summary>
|
||||
private void Drop()
|
||||
{
|
||||
EndDragging();
|
||||
EmitSignalDropped(StartingPosition);
|
||||
}
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user