Merge "feat(non linear font scaling): add easier-to-find alias functions to TypedValue"

3 files changed, 52 insertions, 0 deletions

diff --git a/core/api/current.txt b/core/api/current.txt
index 233be5a325ef..05926b851bfc 100644
--- a/core/api/current.txt
+++ b/core/api/current.txt
@@ -49373,6 +49373,8 @@ package android.util {
     method public static int complexToDimensionPixelSize(int, android.util.DisplayMetrics);
     method public static float complexToFloat(int);
     method public static float complexToFraction(int, float, float);
+    method public static float convertDimensionToPixels(int, float, @NonNull android.util.DisplayMetrics);
+    method public static float convertPixelsToDimension(int, float, @NonNull android.util.DisplayMetrics);
     method public static float deriveDimension(int, float, @NonNull android.util.DisplayMetrics);
     method public int getComplexUnit();
     method public float getDimension(android.util.DisplayMetrics);
diff --git a/core/java/android/util/TypedValue.java b/core/java/android/util/TypedValue.java
index 09545fcfa60f..b93e3386b7cc 100644
--- a/core/java/android/util/TypedValue.java
+++ b/core/java/android/util/TypedValue.java
@@ -495,6 +495,48 @@ public class TypedValue {
     }
 
     /**
+     * Converts a pixel value to the given dimension, e.g. PX to DP.
+     *
+     * <p>This is just an alias of {@link #deriveDimension(int, float, DisplayMetrics)} with an
+     * easier-to-find name.
+     *
+     * @param unitToConvertTo The unit to convert to.
+     * @param pixelValue The raw pixels value to convert from.
+     * @param metrics Current display metrics to use in the conversion --
+     *                supplies display density and scaling information.
+     *
+     * @return A dimension value equivalent to the given number of pixels
+     * @throws IllegalArgumentException if unitToConvertTo is not valid.
+     */
+    public static float convertPixelsToDimension(
+            @ComplexDimensionUnit int unitToConvertTo,
+            float pixelValue,
+            @NonNull DisplayMetrics metrics) {
+        return deriveDimension(unitToConvertTo, pixelValue, metrics);
+    }
+
+    /**
+     * Converts a dimension value to raw pixels, e.g. DP to PX.
+     *
+     * <p>This is just an alias of {@link #applyDimension(int, float, DisplayMetrics)} with an
+     * easier-to-find name.
+     *
+     * @param unitToConvertFrom The unit to convert from.
+     * @param value The dimension value to apply the unit to.
+     * @param metrics Current display metrics to use in the conversion --
+     *                supplies display density and scaling information.
+     *
+     * @return The equivalent pixel value—i.e. the complex floating point value multiplied by the
+     * appropriate metrics depending on its unit—or zero if unit is not valid.
+     */
+    public static float convertDimensionToPixels(
+            @ComplexDimensionUnit int unitToConvertFrom,
+            float value,
+            @NonNull DisplayMetrics metrics) {
+        return applyDimension(unitToConvertFrom, value, metrics);
+    }
+
+    /**
      * Return the data for this value as a dimension.  Only use for values 
      * whose type is {@link #TYPE_DIMENSION}. 
      * 
diff --git a/core/tests/coretests/src/android/util/TypedValueTest.kt b/core/tests/coretests/src/android/util/TypedValueTest.kt
index af01447fc21e..d4e77b505a79 100644
--- a/core/tests/coretests/src/android/util/TypedValueTest.kt
+++ b/core/tests/coretests/src/android/util/TypedValueTest.kt
@@ -276,5 +276,13 @@ class TypedValueTest {
         assertThat(dimenValueToTest)
             .isWithin(0.05f)
             .of(actualDimenValue)
+
+        // Also test the alias functions
+        assertThat(TypedValue.convertDimensionToPixels(dimenType, dimenValueToTest, metrics))
+            .isWithin(0.05f)
+            .of(actualPx)
+        assertThat(TypedValue.convertPixelsToDimension(dimenType, actualPx, metrics))
+            .isWithin(0.05f)
+            .of(actualDimenValue)
     }
 }