sketchbook/io.getstream.sketchbook/SketchbookController

SketchbookController

SketchbookController interacts with Sketchbook and it allows you to control the canvas and all of the components with it.

Constructors

fun SketchbookController()

Functions

clear

fun clear()

Clear drawn paths and the bitmap image.

clearImageBitmap

fun clearImageBitmap()

Clear the image bitmap.

clearPaths

fun clearPaths()

Clear the drawn paths and redo paths on canvas..

getSketchbookBitmap

fun getSketchbookBitmap(): ImageBitmap

Returns the current Sketchbook's bitmap.

redo

fun redo()

Executes redo the drawn path if possible.

setBackgroundColor

fun setBackgroundColor(color: Color)

Sets a background color.

setEraseMode

fun setEraseMode(isEraseMode: Boolean)

Sets the erase mode or not.

setEraseRadius

fun setEraseRadius(eraseRadius: Float)

Sets the radius size of the erase circle.

setImageBitmap

fun setImageBitmap(bitmap: ImageBitmap?)

Sets an ImageBitmap to draw on the canvas as a background.

setLinearShader

fun setLinearShader(colors: List<Color>)

Sets a color list as a linear shader to the paint.

setPaint

fun setPaint(paint: Paint)

Sets a new Paint.

setPaintAlpha

fun setPaintAlpha(alpha: Float)

Sets an alpha to the drawPaint.

setPaintColor

fun setPaintColor(color: Color)

Sets a Color to the drawPaint.

setPaintingStyle

fun setPaintingStyle(paintingStyle: PaintingStyle)

Sets a PaintingStyle to the drawPaint.

setPaintShader

fun setPaintShader(shader: Shader?)

Sets a Shader to the drawPaint.

setPaintStrokeWidth

fun setPaintStrokeWidth(strokeWidth: Float)

Sets a stroke width to the drawPaint.

setPathEffect

fun setPathEffect(pathEffect: PathEffect?)

Sets a PathEffect to the drawPaint.

setRainbowShader

fun setRainbowShader()

Sets a rainbow shader to the paint.

setSelectedColorIndex

fun setSelectedColorIndex(index: Int)

Sets an index of the selected color.

toggleEraseMode

fun toggleEraseMode()

Toggles the erase mode.

undo

fun undo()

Executes undo the drawn path if possible.

Properties

canRedo

val canRedo: State<Boolean>

Indicates can execute redo or not.

canUndo

val canUndo: State<Boolean>

Indicates can execute undo or not.

currentPaint

val currentPaint: Paint

The current Paint to draws paths on canvas.

currentPaintColor

val currentPaintColor: State<Color>

MutableState of the current color of the Paint.

isEraseMode

val isEraseMode: State<Boolean>

Indicates whether erase mode or not.