CircularRevealHelper

View Source

public class 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.

Summary

Nested types
`public interface CircularRevealHelper.Delegate` Delegate interface to be implemented by the `CircularRevealWidget` that owns this helper.
`@Retention(value = RetentionPolicy.SOURCE) public annotation CircularRevealHelper.Strategy` Which strategy this view should use to create the circular reveal effect.

Constants
`static final int`	`BITMAP_SHADER = 0` Specify that this view should use a BitmapShader to create the circular reveal effect.
`static final int`	`CLIP_PATH = 1` Specify that this view should use clipPath to create the circular reveal effect.
`static final int`	`REVEAL_ANIMATOR = 2` Specify that this view should use createCircularReveal to create the circular reveal effect.
`static final int`	`@CircularRevealHelper.Strategy STRATEGY = 2`

Public fields
`CircularRevealWidget.RevealInfo`	`revealInfo` The circular reveal representation which affects how the current frame will be drawn.

Public constructors
`CircularRevealHelper(CircularRevealHelper.Delegate delegate)`

Public methods
`void`	`buildCircularRevealCache()`
`void`	`destroyCircularRevealCache()`
`void`	`draw(Canvas canvas)`
`Drawable`	`getCircularRevealOverlayDrawable()`
`int`	`getCircularRevealScrimColor()`
`CircularRevealWidget.RevealInfo`	`getRevealInfo()`
`boolean`	`isOpaque()`
`void`	`setCircularRevealOverlayDrawable(Drawable drawable)`
`void`	`setCircularRevealScrimColor(int color)`
`void`	`setRevealInfo(CircularRevealWidget.RevealInfo revealInfo)` Sets the reveal info, ensuring that a reveal circle with a large enough radius that covers the entire View has its `radius` set to `INVALID_RADIUS`.

Constants

BITMAP_SHADER

public static final int BITMAP_SHADER = 0

Specify that this view should use a BitmapShader to create the circular reveal effect. The downside that it can only animate a static Bitmap.

CLIP_PATH

public static final int CLIP_PATH = 1

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

REVEAL_ANIMATOR

public static final int REVEAL_ANIMATOR = 2

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

STRATEGY

@CircularRevealHelper.Strategy
public static final int STRATEGY = 2

Public fields

revealInfo

public CircularRevealWidget.RevealInfo revealInfo

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

A non-null RevealInfo is invalid if a circular reveal is active and the circular reveal does not cover all four corners of this view. When the circular reveal is such that it covers the entire view, radius should be set to INVALID_RADIUS, making the RevealInfo invalid. An invalid RevealInfo is a optimization that allows draw to use the fastest code path.

Public constructors