better-genshin-impact/BetterGenshinImpact/Core/BgiVision/BvLocator.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using BetterGenshinImpact.Core.Recognition;
using BetterGenshinImpact.GameTask;
using BetterGenshinImpact.GameTask.Common;
using BetterGenshinImpact.GameTask.Model.Area;
using Microsoft.Extensions.Logging;
using OpenCvSharp;
using static BetterGenshinImpact.GameTask.Common.TaskControl;


namespace BetterGenshinImpact.Core.BgiVision;

/// <summary>
/// 针对 Region 体系的包装
/// </summary>
public class BvLocator
{
    private static readonly ILogger Logger = App.GetLogger<BvLocator>();
    private readonly CancellationToken _cancellationToken;

    public RecognitionObject RecognitionObject { get; }

    public Action<List<Region>>? RetryAction { get; set; }

    public static int DefaultTimeout { get; set; } = 10000;

    public static int DefaultRetryInterval { get; set; } = 250;

    public BvLocator(RecognitionObject recognitionObject, CancellationToken cancellationToken)
    {
        RecognitionObject = recognitionObject.Clone();
        _cancellationToken = cancellationToken;
    }

    /// <summary>
    /// 根据传入的位置信息定位元素
    /// 不建议外部调用使用
    /// </summary>
    /// <returns></returns>
    /// <exception cref="NotSupportedException"></exception>
    public List<Region> FindAll()
    {
        using var screen = CaptureToRectArea();

        if (RecognitionObject.RecognitionType == RecognitionTypes.TemplateMatch)
        {
            var region = screen.Find(RecognitionObject);
            if (region.IsExist())
            {
                return [region];
            }

            return [];
        }
        else if (RecognitionObject.RecognitionType == RecognitionTypes.Ocr)
        {
            var results = screen.FindMulti(RecognitionObject);
            if (!string.IsNullOrEmpty(RecognitionObject.Text))
            {
                return results.FindAll(r => r.Text.Contains(RecognitionObject.Text));
            }

            return results;
        }
        else
        {
            throw new NotSupportedException($"不被 Locator 支持的识别类型: {RecognitionObject.RecognitionType}");
        }
    }

    public bool IsExist()
    {
        return FindAll().Count > 0;
    }

    public async Task<Region> Click(int? timeout = null)
    {
        return (await WaitFor(timeout)).First().Click();
    }

    public async Task<Region> ClickUntilDisappears(int? timeout = null)
    {
        var region = (await WaitFor(timeout)).First().Click();
        await new BvLocator(RecognitionObject, _cancellationToken)
            .WithRetryAction(resList => { resList.First().Click(); }).WaitForDisappear();
        return region;
    }

    public async Task<Region> DoubleClick(int? timeout = null)
    {
        var list = await WaitFor(timeout);
        return list.First().DoubleClick();
    }

    public async Task<List<Region>> WaitFor(int? timeout = null)
    {
        var actualTimeout = timeout ?? DefaultTimeout;
        var retryCount = actualTimeout / DefaultRetryInterval;

        List<Region> results = [];
        var retryRes = await NewRetry.WaitForAction(() =>
        {
            results = FindAll();
            var b = results.Count > 0;
            RetryAction?.Invoke(results);
            return b;
        }, _cancellationToken, retryCount, DefaultRetryInterval);

        if (retryRes)
        {
            return results;
        }
        else
        {
            throw BuildTimeoutException(actualTimeout);
        }
    }

    private TimeoutException BuildTimeoutException(int actualTimeout)
    {
        if (RecognitionObject.RecognitionType == RecognitionTypes.Ocr)
        {
            return new TimeoutException($"识别文字[{RecognitionObject.Text}]在 {actualTimeout}ms 后超时未出现！");
        }
        else if (RecognitionObject.RecognitionType == RecognitionTypes.TemplateMatch)
        {
            return new TimeoutException($"识别图像[{RecognitionObject.Name}]在 {actualTimeout}ms 后超时未出现！");
        }
        else
        {
            return new TimeoutException($"识别元素在 {actualTimeout}ms 后超时未出现！");
        }
    }

    public async Task<List<Region>> TryWaitFor(int? timeout = null)
    {
        try
        {
            return await WaitFor(timeout);
        }
        catch
        {
            return [];
        }
    }

    public async Task WaitForDisappear(int? timeout = null)
    {
        var actualTimeout = timeout ?? DefaultTimeout;
        var retryCount = actualTimeout / DefaultRetryInterval;

        var retryRes = await NewRetry.WaitForAction(() =>
        {
            var results = FindAll();
            var b = results.Count == 0;
            if (!b)
            {
                RetryAction?.Invoke(results);
            }

            return b;
        }, _cancellationToken, retryCount, DefaultRetryInterval);

        if (!retryRes)
        {
            throw new TimeoutException($"识别元素在 {actualTimeout}ms 后超时未消失！");
        }
    }

    public async Task TryWaitForDisappear(int? timeout = null)
    {
        try
        {
            await WaitForDisappear(timeout);
        }
        catch
        {
            // ignored
        }
    }

    /// <summary>
    /// 方便优雅的设置感兴趣区域 (ROI)
    /// 该方法会覆盖 RecognitionObject.RegionOfInterest 的值。
    /// </summary>
    /// <param name="rect"></param>
    /// <returns></returns>
    public BvLocator WithRoi(Rect rect)
    {
        RecognitionObject.RegionOfInterest = rect;
        return this;
    }

    public BvLocator WithRoi(Func<Rect, Rect> deltaFunc)
    {
        var captureAreaRect = TaskContext.Instance().SystemInfo.ScaleMax1080PCaptureRect;
        var rect = deltaFunc(captureAreaRect);
        RecognitionObject.RegionOfInterest = rect;
        return this;
    }

    public BvLocator WithRetryAction(Action<List<Region>>? action)
    {
        RetryAction = action;
        return this;
    }
}