Register now for Android Dev Summit 2019!

EdgeTreatment

public class EdgeTreatment
extends Object implements Cloneable

java.lang.Object
   ↳ com.google.android.material.shape.EdgeTreatment
Known Direct Subclasses


A basic edge treatment (a single straight line). Sub-classed for custom edge treatments.

Note: For edge treatments which result in a concave shape, the parent view must disable clipping of children by calling setClipChildren(boolean), or by setting `android:clipChildren="false"` in xml. `clipToPadding` may also need to be false if there is any padding on the parent that could intersect the shadow.

Summary

Public constructors

EdgeTreatment()

Public methods

EdgeTreatment clone()
void getEdgePath(float length, float center, float interpolation, ShapePath shapePath)

Generates a ShapePath for this edge treatment.

void getEdgePath(float length, float interpolation, ShapePath shapePath)

This method is deprecated. Does not support interpolation. Use getEdgePath(float, float, float, ShapePath) instead.

Inherited methods

From class java.lang.Object

Public constructors

EdgeTreatment

EdgeTreatment ()

Public methods

clone

EdgeTreatment clone ()

Returns
EdgeTreatment

getEdgePath

void getEdgePath (float length, 
                float center, 
                float interpolation, 
                ShapePath shapePath)

Generates a ShapePath for this edge treatment.

EdgeTreatments have an origin of (0, 0) and a destination of (0, length) (i.e. they represent the top edge), and are automatically rotated and scaled as necessary when applied to other edges. Only the horizontal, top EdgeTreatment needs to be defined in order to apply it to all four edges.

Parameters
length float: the length of the edge.

center float: the distance to the center of the edge. This takes into account any offset added by the proceeding corner. Drawing anything at (center, 0) will be center aligned with the shape. Normally you'll want to use this instead of length / 2.

interpolation float: the interpolation of the edge treatment. Ranges between 0 (none) and 1 (fully) interpolated. Custom edge treatments can implement interpolation to support shape transition between two arbitrary states. Typically, a value of 0 indicates that the custom edge treatment is not rendered (i.e. that it is a straight line), and a value of 1 indicates that the treatment is fully rendered. Animation between these two values can "heal" or "reveal" an edge treatment.

shapePath ShapePath: the ShapePath that this treatment should write to.

getEdgePath

void getEdgePath (float length, 
                float interpolation, 
                ShapePath shapePath)

This method is deprecated.
Does not support interpolation. Use getEdgePath(float, float, float, ShapePath) instead.

Parameters
length float

interpolation float

shapePath ShapePath