diff --git a/docs/ImageSearch.md b/docs/ImageSearch.md new file mode 100644 index 0000000..c80c90e --- /dev/null +++ b/docs/ImageSearch.md @@ -0,0 +1,15 @@ +#

Модуль «Поиск изображения»

+ +

Модуль «Поиск изображения», в основном, используется в связке с модулем «Кликер». Его задача – определить, существует ли на текущем экране заданное изображение, и если да, то вернуть координаты его центра.

+ +## Интерфейс модуля +

Окно модуля выглядит следующим образом: +

![Screenshot](img/is_1.png)

+

Кнопки «Выбрать изображение» и «Выделить изображение» позволяют выбрать изображение для поиска. +

Поле «Координата x». В поле вводится переменная (начиная с символа «@»), в которую будет записана координата x искомого изображения, если оно найдется. +

Поле «Координата y». Аналогично полю «Координата x», в данном поле указывается переменная, в которую будет записана координата y. +

Поле «Результат». В поле вводится название переменной, в которой будет итоговый результат поиска изображения (после использования всех попыток его найти». Результирующее значение будет представлено в виде строки: «true» - найдено, «false» - не найдено. +

Поля «Кол-во попыток», «Пауза» и «Процент совпадения» аналогичны полям модуля «Кликер». +

Поле «Кол-во попыток». В поле указывается количество попыток поиска изображения. +

Поле «Пауза» предназначено для указания паузы между попытками поиска в миллисекундах. +

Поле «Процент совпадения» - насколько сильно совпадает изображение, которое будет искаться, с фрагментом изображения на текущем экране. Вводится число от 0 до 100, чем больше, тем больше должно быть сходства между изображениями. diff --git a/docs/ImagesSearch.md b/docs/ImagesSearch.md new file mode 100644 index 0000000..332ed00 --- /dev/null +++ b/docs/ImagesSearch.md @@ -0,0 +1,15 @@ +#

Модуль «Поиск изображений»

+ +

Модуль «Поиск изображений» аналогичен модулю «Поиск изображения» с одним лишь отличием в том, что этот модуль возвращает список всех найденных изображений, а не одного.

+ +## Интерфейс модуля +

Интерфейс этого модуля очень похож на интерфейс модуля «Поиск изображения», но в нем вместо полей «Координата X», «Координата Y» и «Результат» только одно поле – «Переменная», а также появилось поле «Минимальная дистанция». +

![Screenshot](img/is_2.png)

+

В поле «Переменная» вводится название переменной с символа «@», в которую запишется результат поиска. +

Поле «Кол-во попыток» заполняется числом, указывающим, сколько раз пробовать искать изображения, если с первого раза ни одного найти не удалось. +

Поле «Пауза» предназначено для указания паузы между попытками поиска в миллисекундах. +

В поле «Процент совпадения» вводится значение от 0 до 100, указывающее, насколько сильно совпадают изображение, которое будет искаться, с фрагментом изображения на текущем экране. Чем больше число, тем сильнее они должны совпадать. +

Поле «Минимальная дистанция» заполняется числом, указывающим, какое минимальное количество пикселей должно быть между двумя одинаковыми изображениями. В некоторых задачах может быть потребоваться отсекать изображения, которые расположены достаточно близко друг к другу и получать только первое из этих изображений (начиная с верхнего левого угла). Обратите внимание, если это расстояние поставить совсем маленьким (не менее 5 пикселей) или равным 0, то одно изображение может быть найдено несколько раз! +## Выходные данные +

В указанную переменную будет записан список объектов, количество которых будет равно количеству найденных изображений на экране. Каждый объект соответствует найденному изображению. Для обращения к конкретному изображению списка необходимо указывать его номер (нумерация с 0) в квадратных скобках после названия переменной, например @listImages[0]. +

Каждый объект содержит три поля: «x», «y» и «similarity». В поле «x» содержится координата x выбранного изображения, в поле «y» - координата y, а в поле «similarity» - процент совпадения найденного изображения с искомым. diff --git a/docs/img/is_1.png b/docs/img/is_1.png new file mode 100644 index 0000000..77e975e Binary files /dev/null and b/docs/img/is_1.png differ diff --git a/docs/img/is_2.png b/docs/img/is_2.png new file mode 100644 index 0000000..24854a9 Binary files /dev/null and b/docs/img/is_2.png differ diff --git a/mkdocs.yml b/mkdocs.yml index 7b6b9f3..7ba6139 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,7 +2,10 @@ site_name: Lexema-RPA Studio Docs nav: - Основные сведения: index.md - 'Модули программы': - - 'Кликер': 'clicker.md' - 'Excel': 'excel.md' + - 'Кликер': 'clicker.md' + - 'Поиск изображения': 'ImageSearch.md' + - 'Поиск изображений': 'ImagesSearch.md' + - About: about.md theme: readthedocs