mirror of
https://github.com/material-components/material-components-android.git
synced 2026-01-19 03:21:36 +08:00
98d4b148d1
Implement Cloneable and override Object#clone() to create deep copies of the corner and edge treatments. The Cloneable method is generally discouraged, but this solution appears to be the most effective solution for our use case because: - CornerTreatment and EdgeTreatment don't contain mutable fields, so using the native Object#clone() should be fine. This allows us to avoid intervening in the clone() method, which is one of the main reasons to avoid using Obect#clone(). - Since we have to maintain binary compatibility with our 1.0.0 stable release, we have very little wiggle room with which to ensure that we have effective copy() methods in each subclass of CornerTreatment and EdgeTreatment. PiperOrigin-RevId: 222311453
66 lines
3.0 KiB
Java
66 lines
3.0 KiB
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.
|
|
*
|
|
* <p>Note: For edge treatments which result in a concave shape, the parent view must disable
|
|
* clipping of children by calling {@link android.view.ViewGroup#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.
|
|
*/
|
|
@Experimental("The shapes API is currently experimental and subject to change")
|
|
public class EdgeTreatment implements Cloneable {
|
|
|
|
/**
|
|
* 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 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 center 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.
|
|
* @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 center, float interpolation, ShapePath shapePath) {
|
|
shapePath.lineTo(length, 0);
|
|
}
|
|
|
|
@Override
|
|
public EdgeTreatment clone() {
|
|
try {
|
|
return (EdgeTreatment) super.clone();
|
|
} catch (CloneNotSupportedException e) {
|
|
throw new AssertionError(e); // This should never happen, because EdgeTreatment handles the
|
|
// cloning, so all subclasses of EdgeTreatment will support cloning.
|
|
}
|
|
}
|
|
}
|