Package uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds

Class CirclePromptBackground

java.lang.Object

uk.co.samuelwall.materialtaptargetprompt.extras.PromptBackground

uk.co.samuelwall.materialtaptargetprompt.extras.backgrounds.CirclePromptBackground

public class CirclePromptBackground
extends PromptBackground

PromptBackground implementation that renders the prompt background as a circle.

Constructor Summary

Constructors

Constructor	Description
CirclePromptBackground()	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	contains(float x, float y)
void	draw(android.graphics.Canvas canvas)
android.graphics.Path	getPath()
void	prepare(PromptOptions options, boolean clipToBounds, android.graphics.Rect clipBounds)	Prepares the background for drawing.
void	setColour(int colour)	Sets the colour to use for the background.
void	update(PromptOptions options, float revealModifier, float alphaModifier)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CirclePromptBackground

public CirclePromptBackground()

Constructor.

Method Detail

setColour

public void setColour(int colour)

Description copied from class: PromptBackground

Sets the colour to use for the background.

Specified by:

setColour in class PromptBackground

Parameters:

colour - Colour integer representing the colour.

prepare

public void prepare(@NonNull
                    PromptOptions options,
                    boolean clipToBounds,
                    @NonNull
                    android.graphics.Rect clipBounds)

Description copied from class: PromptBackground

Prepares the background for drawing.

Specified by:

prepare in class PromptBackground

Parameters:

options - The options from which the prompt was created.

clipToBounds - Should the prompt be clipped to the supplied clipBounds.

clipBounds - The bounds to clip the drawing to.

update

public void update(@NonNull
                   PromptOptions options,
                   float revealModifier,
                   float alphaModifier)

draw

public void draw(@NonNull
                 android.graphics.Canvas canvas)

contains

public boolean contains(float x,
                        float y)

getPath

public android.graphics.Path getPath()

Overrides:

getPath in class PromptBackground

Returns:

The path of the current background, useful for clipping content