Module

Die Ink API ist modularisiert, sodass Sie nur die Funktionen verwenden können, die Sie benötigen.

Schläge

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.

Geometrie

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.

Pinsel

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.

Autorentool

Mit dem Compose-Modul Authoring können Sie Touch-Eingaben von Nutzern erfassen und in Echtzeit als Striche mit geringer Latenz auf dem Bildschirm rendern. Dies wird durch die kombinierbare Funktion InProgressStrokes erreicht, die Bewegungsereignisse verarbeitet und die Striche beim Zeichnen anzeigt.

Sobald ein Strich abgeschlossen ist, benachrichtigt die Composable die Clientanwendung über einen InProgressStrokesFinishedListener-Callback. So kann die Anwendung die fertigen Striche zum Rendern oder Speichern abrufen.

In Compose wird dieser Callback im Parameter onStrokesFinished von InProgressStrokes übergeben. Übergeben Sie die fertigen Striche an eine andere zusammensetzbare Funktion, um sie mit dem Rendering-Modul auf dem Bildschirm darzustellen.

Rendering

Das Rendering-Modul vereinfacht das Zeichnen von Tinte auf einem Android-Canvas. Es bietet CanvasStrokeRenderer für Compose und ViewStrokeRenderer für auf Views basierende Layouts. Diese Renderer optimieren die Rendering-Leistung und sorgen für hochwertige Grafiken, einschließlich Antialiasing.

Rufen Sie zum Rendern von Strichen die Methode create() auf, um eine CanvasStrokeRenderer-Instanz abzurufen, und rufen Sie dann die Methode draw() auf, um entweder fertige (Stroke) oder laufende (InProgressStroke) Striche auf einem Canvas zu rendern.

Sie können die Arbeitsfläche transformieren, während Sie einen Strich zeichnen. Beispiele hierfür sind Schwenken, Zoomen und Drehen. Damit der Strich richtig gerendert wird, müssen Sie auch die canvas-Transformation an CanvasStrokeRenderer.draw übergeben.

Wenn Sie die canvas-Transformation nicht separat erfassen möchten, verwenden Sie stattdessen ViewStrokeRenderer.

Speicher

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.