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 InProgressStrokesView.
  • 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

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.

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

Moduł Authoring umożliwia rejestrowanie danych wejściowych wskaźnika użytkownika i renderowanie ich w czasie rzeczywistym na ekranie w postaci kresek o niskim opóźnieniu. Zawiera element InProgressStrokesView, który przetwarza zdarzenia ruchu i wyświetla pociągnięcia w miarę ich rysowania.

Po zakończeniu rysowania widok powiadamia aplikację kliencką za pomocą zarejestrowanego wywołania zwrotnego (InProgressStrokesFinishedListener). Wywołanie zwrotne umożliwia aplikacji pobranie gotowego pociągnięcia do renderowania lub przechowywania.

Renderowanie

Moduł renderowania pomaga rysować pociągnięcia piórem na urządzeniu z AndroidemCanvas. Zapewnia CanvasStrokeRenderer w przypadku Compose i ViewStrokeRenderer w przypadku układów opartych na widokach. Te renderery są przeznaczone do renderowania o wysokiej wydajności i pomagają wyświetlać 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. Następnie wywołaj metodę draw(), aby wyrenderować na obiekcie Canvas gotowe (Stroke) lub trwające (InProgressStroke) pociągnięcia.

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

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.