Moduły

Ink API jest podzielony na moduły, więc możesz używać tylko tych funkcji, których potrzebujesz.

Pociągnięcia

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.

Geometria

Moduł Geometry obsługuje operacje geometryczne na kształtach podstawowych (przy użyciu dedykowanych klas, takich jak Box i Vec), a także na dowolnych kształtach (przy użyciu PartitionedMesh), w tym wykrywanie przecięć i transformacje. PartitionedMesh może też zawierać dodatkowe dane potrzebne do renderowania.

Pędzel

Moduł brush określa styl linii. Składa się z 2 głównych części:

• Brush: określa styl obrysu, w tym kolor podstawowy, rozmiar podstawowy i BrushFamily. BrushFamily jest analogiczna do rodziny czcionek i określa styl linii. Na przykład BrushFamily może reprezentować określony styl markera lub zakreślacza, dzięki czemu pociągnięcia o różnych rozmiarach i kolorach mogą mieć ten sam styl.
• StockBrushes: udostępnia funkcje fabryczne do tworzenia gotowych do użycia instancji BrushFamily.

Tworzenie

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.

Renderowanie

Moduł renderowania upraszcza rysowanie pociągnięć piórem na urządzeniu z AndroidemCanvas. Zapewnia CanvasStrokeRenderer w przypadku Compose i ViewStrokeRenderer w przypadku układów opartych na widokach. Te renderery optymalizują wydajność renderowania i pomagają dostarczać wysokiej jakości treści wizualne, w tym wygładzanie krawędzi.

Aby wyrenderować pociągnięcia, wywołaj metodę create(), aby uzyskać instancję CanvasStrokeRenderer, a następnie wywołaj metodę draw(), aby wyrenderować gotowe (Stroke) lub w trakcie tworzenia (InProgressStroke) pociągnięcia na obiekcie Canvas.

Podczas rysowania pociągnięcia możesz przekształcać obszar roboczy. Może to być na przykład przesuwanie, powiększanie i obracanie. Aby obrys był renderowany prawidłowo, musisz też przekazać canvas transform do CanvasStrokeRenderer.draw.

Aby uniknąć oddzielnego śledzenia przekształcenia canvas, użyj zasady ViewStrokeRenderer.

Miejsce na dane

Moduł storage udostępnia narzędzia do wydajnego serializowania i deserializowania danych dotyczących pociągnięć, koncentrując się głównie na StrokeInputBatch.

Moduł korzysta z buforów protokołów i zoptymalizowanych technik kompresji różnicowej, co pozwala znacznie zaoszczędzić miejsce na dane w porównaniu z prostymi metodami.

Moduł pamięci ułatwia zapisywanie, wczytywanie i udostępnianie pociągnięć.