Módulos

La API de Ink está modularizada, por lo que puedes usar solo lo que necesitas.

Brazadas

El módulo trazos sirve como base de la API de Ink. Los tipos de datos clave de este módulo son los siguientes:

  • StrokeInputBatch: Representa una serie de entradas de puntero, incluidas su posición, marca de tiempo y, de manera opcional, presión, inclinación y orientación.
  • InProgressStroke: Representa un trazo que se está dibujando de forma activa. InProgressStroke se usa para renderizar trazos parciales con baja latencia y para compilar el objeto Stroke final una vez que se completa la entrada, después de lo cual se puede reutilizar el objeto. `InProgressStroke is used by InProgressStrokesView.
  • Stroke: Es una representación inmutable de un trazo finalizado con geometría fija. Cada Stroke tiene un ImmutableStrokeInputBatch (puntos de entrada), un Brush (estilo) y una PartitionedMesh (forma geométrica). Puedes almacenar, manipular y renderizar trazos dentro de tu aplicación.

Geometría

El módulo Geometry admite operaciones geométricas en formas primitivas (con clases específicas como Box y Vec), así como formas arbitrarias (con PartitionedMesh), incluida la detección y transformación de intersecciones. PartitionedMesh también puede contener datos adicionales para admitir la renderización.

Pincel

The brush module defines the style of strokes. It consists of two main parts:

  • Brush: Specifies the style of a stroke including base color, base size, and BrushFamily. BrushFamily is analogous to a font family, it defines a stroke's style. For example, a BrushFamily can represent a specific style of marker or highlighter, allowing strokes with different sizes and colors to share that style.
  • StockBrushes: Provides factory functions for creating ready-to-use BrushFamily instances.

Autoría

The Authoring module lets you capture user pointer input and render it as low-latency strokes on the screen in real time. It provides an InProgressStrokesView, which processes motion events and displays the strokes as they are drawn.

Once a stroke is completed, the view notifies the client application by means of a registered callback (InProgressStrokesFinishedListener). The callback lets the application retrieve the finished stroke for rendering or storage.

Renderización

El módulo de renderización te ayuda a dibujar trazos de tinta en un Canvas de Android. Proporciona CanvasStrokeRenderer para Compose y ViewStrokeRenderer para diseños basados en vistas. Estos renderizadores están diseñados para un renderizado de alto rendimiento y ayudan a ofrecer imágenes de alta calidad, incluido el suavizado.

Para renderizar trazos, llama al método create() para obtener una instancia de CanvasStrokeRenderer. Luego, llama al método draw() para renderizar trazos terminados (Stroke) o en curso (InProgressStroke) en un objeto Canvas.

Puedes transformar el lienzo cuando dibujas un trazo. Algunos ejemplos incluyen el desplazamiento horizontal, el zoom y la rotación. Para renderizar el trazo correctamente, también debes pasar la transformación canvas a CanvasStrokeRenderer.draw.

Para evitar hacer un seguimiento de la transformación canvas por separado, usa ViewStrokeRenderer.

Almacenamiento

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.