Interfejsy Brush API

Interfejsy BrushInk API umożliwiają tworzenie i dostosowywanie pędzli do rysowania na obszarze roboczym.

Tworzenie pędzla

Aby utworzyć pędzel, użyj metod fabrycznych Brush z argumentami nazwanymi, takimi jak Brush.createWithColorLong(). Ta klasa umożliwia ustawienie tych właściwości:

  • family: styl pędzla, analogiczny do kroju lub czcionki w tekście. Dostępne wartości znajdziesz w sekcji StockBrushes.BrushFamily
  • color: kolor pędzla. Kolor możesz ustawić za pomocą ColorLong.
  • size: podstawowa grubość pociągnięć pędzla.
  • epsilon: najmniejsza odległość, przy której 2 punkty w pociągnięciu muszą być uznawane za różne. Określa poziom szczegółowości lub wierności geometrii pociągnięcia.
    • Wyższe wartości bardziej upraszczają pociągnięcie, co zmniejsza wykorzystanie pamięci i przyspiesza renderowanie, ale może powodować widoczne artefakty, takie jak poszarpane krawędzie po powiększeniu.
    • Niższe wartości zachowują więcej szczegółów podczas powiększania w wysokiej jakości, ale zwiększają zużycie pamięci.
    • W przypadku prototypowania ze skalą jednostki 1 piksela dobrym punktem wyjścia jest wartość 0, 1. W przypadku aplikacji produkcyjnych obsługujących różne gęstości ekranu używaj jednostek niezależnych od gęstości (np. dp) i odpowiednio dostosuj wartość epsilon.
val redBrush = Brush.createWithColorLong(
  family = StockBrushes.pressurePen(),
  colorLong = Color.RED.pack(),
  size = 5F,
  epsilon = 0.1F
)

Modyfikowanie właściwości pędzla

Możesz utworzyć kopię istniejącego pędzla za pomocą metody copy(). Ta metoda umożliwia zmianę dowolnej właściwości pędzla.

val blueBrush = redBrush.copy(colorLong = Color.BLUE.pack())

Pędzle niestandardowe

While StockBrushes provides a versatile set of common brushes, Ink API also offers an advanced path for creating entirely new brush behaviors for unique artistic effects or to replicate specific existing brushes for backward compatibility.

A custom BrushFamily is loaded from its serialized format. The required format is the gzipped binary encoding of the BrushFamily protocol buffer. This lets you load and use custom brush files today. Once deserialized, the custom BrushFamily can be used to create a new Brush with a specific color and size, just like any of the StockBrushes families.

class CustomBrushes(val context: Context) {

  private const val TAG = "CustomBrushes"

  val brushes by lazy { loadCustomBrushes(context) }

  @OptIn(ExperimentalInkCustomBrushApi::class)
  private fun loadCustomBrushes(): List<CustomBrush> {
    val brushFiles = mapOf(
        "Calligraphy" to (R.raw.calligraphy to R.drawable.draw_24px),
        "Flag Banner" to (R.raw.flag_banner to R.drawable.flag_24px),
        "Graffiti" to (R.raw.graffiti to R.drawable.format_paint_24px),
    // ...
    )

    val loadedBrushes = brushFiles.mapNotNull { (name, pair) ->
      val (resourceId, icon) = pair
      val brushFamily = context.resources.openRawResource(resourceId).use
      { inputStream ->
          BrushFamily.decode(inputStream)
      }
      CustomBrush(name, icon, brushFamily.copy(clientBrushFamilyId = name))     
    }
    return loadedBrushes
  }
}

data class CustomBrush(
  val name: String,
  val icon: Int,
  val brushFamily: BrushFamily
)