easyreveal / com.jem.easyreveal.clippathproviders / WaveClipPathProvider

WaveClipPathProvider

class WaveClipPathProvider : ClipPathProvider

ClipPathProvider which provides Wave shaped paths which are flatter when percent is closer to 0 or 100, and are at max height when closer to 50.

Types

Name	Summary
Direction	`enum class Direction` Direction in which reveal animation is performed.

Constructors

Name	Summary
<init>	`WaveClipPathProvider(direction:` `WaveClipPathProvider.Direction` `= Direction.BOTTOM_TO_TOP, amplitude:` `Int` `= 30, frequency:` `Int` `= 45, speed:` `Int` `= 20)WaveClipPathProvider()` ClipPathProvider which provides Wave shaped paths which are flatter when percent is closer to 0 or 100, and are at max height when closer to 50.

Properties

Name	Summary
amplitude	`var amplitude:` `Int` Maximum height of waves.
direction	`var direction:` `WaveClipPathProvider.Direction` Wave reveal direction.
frequency	`var frequency:` `Int` Frequency of waves, higher frequency == more waves
speed	`var speed:` `Int` Speed at which waves ‘move’.

Inherited Properties

Name	Summary
op	`var op: Op` Region.Op variable that is used in android.graphics.Canvas.clipPath in the EasyRevealLayouts
path	`var path: Path` Path variable that should be used to make the path to be returned in getPath function.

Functions

Name	Summary
getPath	`fun getPath(percent:` `Float, view: View): Path` Generate the Path for the percent value to be applied in the view.