Modules

L'Ink API est modularisée. Vous pouvez donc n'utiliser que ce dont vous avez besoin.

Traits

Le module strokes sert de base à l'API Ink. Voici les principaux types de données de ce module :

  • StrokeInputBatch : représente une série d'entrées de pointeur, y compris leur position, leur code temporel et, éventuellement, leur pression, leur inclinaison et leur orientation.
  • InProgressStroke : représente un tracé en cours de dessin. InProgressStroke est utilisé pour afficher des traits partiels avec une faible latence et pour créer le Stroke final une fois la saisie terminée, après quoi l'objet peut être réutilisé. InProgressStroke est utilisé par le composable InProgressStrokes.
  • Stroke : représentation immuable d'un tracé finalisé avec une géométrie fixe. Chaque Stroke comporte un ImmutableStrokeInputBatch (points d'entrée), un Brush (style) et une PartitionedMesh (forme géométrique). Vous pouvez stocker, manipuler et afficher des traits dans votre application.

Géométrie

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.

Pinceau

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.

Création

Le module Authoring de Compose vous permet de capturer les entrées tactiles de l'utilisateur et de les afficher sous forme de traits à faible latence sur l'écran en temps réel. Pour ce faire, nous utilisons le composable InProgressStrokes, qui traite les événements de mouvement et affiche les traits à mesure qu'ils sont dessinés.

Une fois un tracé terminé, le composable avertit l'application cliente à l'aide d'un rappel InProgressStrokesFinishedListener. Cela permet à l'application de récupérer les traits terminés pour les afficher ou les stocker.

Dans Compose, InProgressStrokes accepte ce rappel dans le paramètre onStrokesFinished. Transmettez les traits terminés à un autre composable pour les valider à l'écran à l'aide du module de rendu.

Affichage

Le module Rendering simplifie le dessin de traits d'encre sur un Canvas Android. Il fournit CanvasStrokeRenderer pour Compose et ViewStrokeRenderer pour les mises en page basées sur les vues. Ces renderers optimisent les performances de rendu et permettent de fournir des visuels de haute qualité, y compris l'anticrénelage.

Pour afficher les traits, appelez la méthode create() pour obtenir une instance CanvasStrokeRenderer, puis appelez la méthode draw() pour afficher les traits terminés (Stroke) ou en cours (InProgressStroke) sur un Canvas.

Vous pouvez transformer le canevas lorsque vous dessinez un trait. Par exemple, le déplacement, le zoom et la rotation. Pour afficher correctement le trait, vous devez également transmettre la transformation canvas à CanvasStrokeRenderer.draw.

Pour éviter de suivre la transformation canvas séparément, utilisez plutôt ViewStrokeRenderer.

Stockage

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.