material-components_material-components-android/lib/java/com/google/android/material/shape/EdgeTreatment.java

/*
 * Copyright 2017 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.android.material.shape;

import com.google.android.material.internal.Experimental;

/** A basic edge treatment (a single straight line). Sub-classed for custom edge treatments. */
@Experimental("The shapes API is currently experimental and subject to change")
public class EdgeTreatment {

  /**
   * Generates a {@link ShapePath} for this edge treatment.
   *
   * <p>EdgeTreatments have an origin of (0, 0) and a destination of (0, length) (i.e. they
   * represent the top edge), and are be 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.
   *
   * @param length the length of the edge.
   * @param interpolation 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.
   * @param shapePath the {@link ShapePath} that this treatment should write to.
   */
  public void getEdgePath(float length, float interpolation, ShapePath shapePath) {
    shapePath.lineTo(length, 0);
  }
}