Модули

API Ink имеет модульную структуру, поэтому вы можете использовать только то, что вам необходимо.

Инсульты

The strokes module serves as the foundation of the Ink API. Key data types within this module are:

  • StrokeInputBatch: Represents a series of pointer inputs, including their position, timestamp, and optionally pressure, tilt, and orientation.
  • InProgressStroke: Represents a stroke that is actively being drawn. InProgressStroke is used to render partial strokes with low latency and to build the final Stroke once input is complete, after which the object can be reused. InProgressStroke is used by the InProgressStrokes composable.
  • Stroke: An immutable representation of a finalized stroke with fixed geometry. Each Stroke has an ImmutableStrokeInputBatch (input points), a Brush (style), and a PartitionedMesh (geometric shape). You can store, manipulate, and render strokes within your application.

Геометрия

Модуль Geometry поддерживает геометрические операции над примитивными фигурами (с использованием специальных классов, таких как Box и Vec ), а также над произвольными фигурами (с использованием PartitionedMesh ), включая обнаружение пересечений и преобразование. PartitionedMesh также может содержать дополнительные данные для поддержки рендеринга.

Щетка

Модуль brush определяет стиль мазков. Он состоит из двух основных частей:

  • Brush : Задает стиль штриха, включая базовый цвет, базовый размер и BrushFamily . BrushFamily аналогичен семейству шрифтов, он определяет стиль штриха. Например, BrushFamily может представлять определенный стиль маркера или текстовыделителя, позволяя штрихам разных размеров и цветов использовать один и тот же стиль.
  • StockBrushes : Предоставляет фабричные функции для создания готовых к использованию экземпляров BrushFamily .

Создание контента

Модуль Compose Authoring позволяет захватывать ввод данных с сенсорного экрана пользователем и отображать его в виде штрихов с низкой задержкой в ​​реальном времени. Это достигается с помощью компонента InProgressStrokes , который обрабатывает события движения и отображает штрихи по мере их отрисовки.

После завершения штриха, компонент уведомляет клиентское приложение с помощью функции обратного вызова InProgressStrokesFinishedListener . Это позволяет приложению получить готовые штрихи для рендеринга или сохранения.

В Compose функция InProgressStrokes принимает этот коллбэк в параметре onStrokesFinished . Передайте завершенные штрихи другому компоненту, чтобы отобразить их на экране с помощью модуля рендеринга .

Визуализация

Модуль Rendering упрощает рисование штрихов чернилами на Android Canvas . Он предоставляет CanvasStrokeRenderer для Compose и ViewStrokeRenderer для макетов на основе представлений. Эти рендереры оптимизируют производительность рендеринга и помогают обеспечить высококачественное отображение, включая сглаживание.

Для отрисовки штрихов вызовите метод create() , чтобы получить экземпляр CanvasStrokeRenderer , а затем вызовите метод draw() , чтобы отрисовать на Canvas либо завершенные ( Stroke ), либо незавершенные ( InProgressStroke ) штрихи.

При рисовании обводки можно изменять холст. Например, можно перемещать, масштабировать и вращать изображение. Для корректного отображения обводки необходимо также передать преобразование canvas в метод CanvasStrokeRenderer.draw .

Чтобы избежать отдельного отслеживания преобразования canvas , используйте вместо этого ViewStrokeRenderer .

Хранилище

Модуль хранения предоставляет утилиты для эффективной сериализации и десериализации данных об инсульте, в первую очередь, с упором на StrokeInputBatch .

Модуль использует протоколы буферизации и оптимизированные методы дельта-сжатия, что приводит к значительной экономии места по сравнению с простыми методами.

Модуль хранения упрощает сохранение, загрузку и обмен результатами действий.