Módulos

A API Ink é modularizada, então você pode usar apenas o que precisa.

Braçadas

O módulo strokes serve como base para a API Ink. Os principais tipos de dados neste módulo são:

  • StrokeInputBatch: representa uma série de entradas de ponteiro, incluindo posição, carimbo de data/hora e, opcionalmente, pressão, inclinação e orientação.
  • InProgressStroke: Representa um traço que está sendo desenhado ativamente. O InProgressStroke é usado para renderizar traços parciais com baixa latência e para criar o Stroke final quando a entrada é concluída. Depois disso, o objeto pode ser reutilizado. InProgressStroke é usado pelo elemento combinável InProgressStrokes.
  • Stroke: uma representação imutável de um traço finalizado com geometria fixa. Cada Stroke tem um ImmutableStrokeInputBatch (pontos de entrada), um Brush (estilo) e uma PartitionedMesh (forma geométrica). É possível armazenar, manipular e renderizar traços no aplicativo.

Geometria

The Geometry module supports geometric operations on primitive shapes (using dedicated classes like Box and Vec), as well as arbitrary shapes (using PartitionedMesh), including intersection detection and transformation. PartitionedMesh can also hold additional data to support rendering.

Brush

O módulo brush define o estilo dos traços. Ela é composta por duas partes principais:

  • Brush: especifica o estilo de um traço, incluindo cor base, tamanho base e BrushFamily. BrushFamily é análogo a uma família de fontes, definindo o estilo de um traço. Por exemplo, um BrushFamily pode representar um estilo específico de marcador ou destaque, permitindo que traços com tamanhos e cores diferentes compartilhem esse estilo.
  • StockBrushes: fornece funções de fábrica para criar instâncias BrushFamily prontas para uso.

Criação

The Compose Authoring module lets you capture user touch input and render it as low-latency strokes on the screen in real time. This is achieved through the InProgressStrokes composable, which processes motion events and displays the strokes as they are drawn.

Once a stroke is completed, the composable notifies the client application using an InProgressStrokesFinishedListener callback. This allows the application to retrieve the finished strokes for rendering or storage.

In Compose, InProgressStrokes takes this callback in the onStrokesFinished parameter. Pass the finished strokes to another composable to commit them to the screen using the rendering module.

Renderização

O módulo Rendering simplifica o desenho de traços de tinta em um Canvas do Android. Ele fornece CanvasStrokeRenderer para o Compose e ViewStrokeRenderer para layouts baseados em visualizações. Esses renderizadores otimizam o desempenho da renderização e ajudam a oferecer recursos visuais de alta qualidade, incluindo antialiasing.

Para renderizar traços, chame o método create() para receber uma instância de CanvasStrokeRenderer e, em seguida, chame o método draw() para renderizar traços concluídos (Stroke) ou em andamento (InProgressStroke) em um Canvas.

É possível transformar a tela ao desenhar um traço. Exemplos incluem panorâmica, zoom e rotação. Para renderizar o traço corretamente, também é necessário transmitir a transformação canvas para CanvasStrokeRenderer.draw.

Para evitar o rastreamento da transformação canvas separadamente, use ViewStrokeRenderer.

Armazenamento

The storage module provides utilities for efficiently serializing and deserializing stroke data, primarily focusing on StrokeInputBatch.

The module uses protocol buffers and optimized delta compression techniques, resulting in significant storage savings compared to naive methods.

The storage module simplifies saving, loading, and sharing strokes.