SESL Material/com.google.android.material.circularreveal/CircularRevealHelper

CircularRevealHelper

Helper class to implement circular reveal functionality.

A CircularRevealWidget subclass will call the corresponding method in this helper, which contains the actual implementations for circular reveal. This helper communicates back to the widget via the Delegate.

Constructors

constructor(delegate: CircularRevealHelper.Delegate)

Types

Delegate

interface Delegate

Delegate interface to be implemented by the CircularRevealWidget that owns this helper.

Strategy

@Retention(value = RetentionPolicy.SOURCE)

annotation class Strategy

Which strategy this view should use to create the circular reveal effect.

Properties

BITMAP_SHADER

val BITMAP_SHADER: Int = 0

Specify that this view should use a BitmapShader to create the circular reveal effect.

CLIP_PATH

val CLIP_PATH: Int = 1

Specify that this view should use clipPath to create the circular reveal effect.

REVEAL_ANIMATOR

val REVEAL_ANIMATOR: Int = 2

Specify that this view should use createCircularReveal to create the circular reveal effect.

revealInfo

@Nullable

@get:Nullable

open var revealInfo: CircularRevealWidget.RevealInfo

The circular reveal representation which affects how the current frame will be drawn.

STRATEGY

val STRATEGY: Int

Functions

buildCircularRevealCache

open fun buildCircularRevealCache()

destroyCircularRevealCache

open fun destroyCircularRevealCache()

draw

open fun draw(@NonNull canvas: Canvas)

getCircularRevealOverlayDrawable

@Nullable

open fun getCircularRevealOverlayDrawable(): Drawable

getCircularRevealScrimColor

@ColorInt

open fun getCircularRevealScrimColor(): Int

isOpaque

open fun isOpaque(): Boolean

setCircularRevealOverlayDrawable

open fun setCircularRevealOverlayDrawable(@Nullable drawable: Drawable)

setCircularRevealScrimColor

open fun setCircularRevealScrimColor(@ColorInt color: Int)