| /* |
| * Copyright 2019 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 androidx.ui.graphics.vector |
| |
| import androidx.compose.Composable |
| import androidx.compose.compositionReference |
| import androidx.compose.currentComposer |
| import androidx.compose.onPreCommit |
| import androidx.compose.remember |
| import androidx.ui.core.Alignment |
| import androidx.ui.core.ContentScale |
| import androidx.ui.core.DensityAmbient |
| import androidx.ui.core.Modifier |
| import androidx.ui.core.composed |
| import androidx.ui.core.drawBehind |
| import androidx.ui.core.scale |
| import androidx.ui.geometry.Size |
| import androidx.ui.graphics.BlendMode |
| import androidx.ui.graphics.Brush |
| import androidx.ui.graphics.Color |
| import androidx.ui.graphics.ColorFilter |
| import androidx.ui.graphics.StrokeCap |
| import androidx.ui.graphics.StrokeJoin |
| import androidx.ui.graphics.withSave |
| import androidx.ui.unit.Dp |
| import androidx.ui.unit.IntPx |
| import androidx.ui.unit.IntPxSize |
| import androidx.ui.unit.Px |
| import kotlin.math.ceil |
| |
| /** |
| * Sentinel value used to indicate that a dimension is not provided |
| */ |
| private const val unset: Float = -1.0f |
| |
| private val DefaultAlignment = Alignment.Center |
| |
| /** |
| * Modifier to draw a vector graphic with the provided width, height and viewport dimensions |
| * @param[defaultWidth] Intrinsic width of the Vector in [Dp] |
| * @param[defaultHeight] Intrinsic height of the Vector in [Dp] |
| * @param[viewportWidth] Width of the viewport space. The viewport is the virtual canvas where |
| * paths are drawn on. |
| * This parameter is optional. Not providing it will use the [defaultWidth] converted to [Px] |
| * @param[viewportHeight] Height of hte viewport space. The viewport is the virtual canvas where |
| * paths are drawn on. |
| * This parameter is optional. Not providing it will use the [defaultHeight] converted to [Px] |
| * @param[tintColor] Optional color used to tint this vector graphic |
| * @param[tintBlendMode] Optional blend mode used with [tintColor], default is [BlendMode.srcIn] |
| * @param[alignment] Specifies the placement of the vector within the drawing bounds |
| * @param[contentScale] Specifies how the vector is to be scaled within the parent bounds |
| */ |
| @Deprecated("Favor usage of VectorPainter instead", |
| ReplaceWith("VectorPainter(" + |
| "defaultWidth, " + |
| "defaultHeight, " + |
| "viewportWidth, " + |
| "viewportHeight, " + |
| "colorFilter, " + |
| "name" |
| ) |
| ) |
| @Composable |
| fun drawVector( |
| defaultWidth: Dp, |
| defaultHeight: Dp, |
| viewportWidth: Float = unset, |
| viewportHeight: Float = unset, |
| tintColor: Color = DefaultTintColor, |
| tintBlendMode: BlendMode = DefaultTintBlendMode, |
| alignment: Alignment = DefaultAlignment, |
| contentScale: ContentScale = ContentScale.Inside, |
| name: String = "", |
| children: @Composable() VectorScope.(viewportWidth: Float, viewportHeight: Float) -> Unit |
| ): Modifier { |
| val density = DensityAmbient.current |
| val widthPx = with(density) { defaultWidth.toPx() } |
| val heightPx = with(density) { defaultHeight.toPx() } |
| |
| val vpWidth = if (viewportWidth == unset) widthPx.value else viewportWidth |
| val vpHeight = if (viewportHeight == unset) heightPx.value else viewportHeight |
| return Modifier.drawVector( |
| defaultWidth = widthPx, |
| defaultHeight = heightPx, |
| viewportWidth = vpWidth, |
| viewportHeight = vpHeight, |
| tintColor = tintColor, |
| tintBlendMode = tintBlendMode, |
| alignment = alignment, |
| contentScale = contentScale, |
| name = name, |
| children = children |
| ) |
| } |
| |
| /** |
| * Modifier to draw a vector graphic with the provided width, height and viewport dimensions |
| * @param[defaultWidth] Intrinsic width of the Vector in [Px] |
| * @param[defaultHeight] Intrinsic height of hte Vector in [Px] |
| * @param[viewportWidth] Width of the viewport space. The viewport is the virtual canvas |
| * where paths are drawn on. This parameter is optional. Not providing it will use the |
| * [defaultWidth] |
| * @param[viewportHeight] Height of hte viewport space. The viewport is the virtual canvas |
| * where paths are drawn on. This parameter is optional. Not providing it will use the |
| * [defaultHeight] |
| * @param[tintColor] Optional color used to tint this vector graphic |
| * @param[tintBlendMode] Optional blend mode used with [tintColor], default is [BlendMode.srcIn] |
| * @param[alignment] Specifies the placement of the vector within the drawing bounds |
| * @param[contentScale] Specifies how the vector is to be scaled within the parent bounds |
| */ |
| @Deprecated("use Modifier.drawVector") |
| @Composable |
| fun drawVector( |
| defaultWidth: Px, |
| defaultHeight: Px, |
| viewportWidth: Float = defaultWidth.value, |
| viewportHeight: Float = defaultHeight.value, |
| tintColor: Color = DefaultTintColor, |
| tintBlendMode: BlendMode = DefaultTintBlendMode, |
| alignment: Alignment = DefaultAlignment, |
| contentScale: ContentScale = ContentScale.Inside, |
| name: String = "", |
| children: @Composable() VectorScope.(viewportWidth: Float, viewportHeight: Float) -> Unit |
| ): Modifier = Modifier.drawVector( |
| defaultWidth = defaultWidth, |
| defaultHeight = defaultHeight, |
| viewportWidth = viewportWidth, |
| viewportHeight = viewportHeight, |
| tintColor = tintColor, |
| tintBlendMode = tintBlendMode, |
| alignment = alignment, |
| contentScale = contentScale, |
| name = name, |
| children = children |
| ) |
| |
| /** |
| * Modifier to draw a vector graphic with the provided width, height and viewport dimensions |
| * @param[defaultWidth] Intrinsic width of the Vector in [Px] |
| * @param[defaultHeight] Intrinsic height of hte Vector in [Px] |
| * @param[viewportWidth] Width of the viewport space. The viewport is the virtual canvas |
| * where paths are drawn on. This parameter is optional. Not providing it will use the |
| * [defaultWidth] |
| * @param[viewportHeight] Height of hte viewport space. The viewport is the virtual canvas |
| * where paths are drawn on. This parameter is optional. Not providing it will use the |
| * [defaultHeight] |
| * @param[tintColor] Optional color used to tint this vector graphic |
| * @param[tintBlendMode] Optional blend mode used with [tintColor], default is [BlendMode.srcIn] |
| * @param[alignment] Specifies the placement of the vector within the drawing bounds |
| * @param[contentScale] Specifies how the vector is to be scaled within the parent bounds |
| */ |
| fun Modifier.drawVector( |
| defaultWidth: Px, |
| defaultHeight: Px, |
| viewportWidth: Float = defaultWidth.value, |
| viewportHeight: Float = defaultHeight.value, |
| tintColor: Color = DefaultTintColor, |
| tintBlendMode: BlendMode = DefaultTintBlendMode, |
| alignment: Alignment = DefaultAlignment, |
| contentScale: ContentScale = ContentScale.Inside, |
| name: String = "", |
| children: @Composable() VectorScope.(viewportWidth: Float, viewportHeight: Float) -> Unit |
| ): Modifier = composed { |
| val vector = remember(name, viewportWidth, viewportHeight) { |
| VectorComponent( |
| name = name, |
| viewportWidth = viewportWidth, |
| viewportHeight = viewportHeight, |
| defaultWidth = defaultWidth, |
| defaultHeight = defaultHeight |
| ) |
| } |
| |
| val ref = compositionReference() |
| val composition = composeVector(vector, currentComposer.recomposer, ref, children) |
| onPreCommit(vector) { |
| onDispose { |
| composition.dispose() |
| } |
| } |
| |
| val vectorWidth = defaultWidth.value |
| val vectorHeight = defaultHeight.value |
| val vectorSize = Size(vectorWidth, vectorHeight) |
| |
| drawBehind { |
| val parentWidth = size.width |
| val parentHeight = size.height |
| val scale = contentScale.scale(vectorSize, size) |
| |
| val alignedPosition = alignment.align( |
| IntPxSize( |
| IntPx(ceil(parentWidth - (vectorWidth * scale)).toInt()), |
| IntPx(ceil(parentHeight - (vectorHeight * scale)).toInt()) |
| ) |
| ) |
| |
| val translateX = alignedPosition.x.value.toFloat() |
| val translateY = alignedPosition.y.value.toFloat() |
| |
| // apply the scale to the root of the vector |
| vector.root.scaleX = (vectorWidth / viewportWidth) * scale |
| vector.root.scaleY = (vectorHeight / viewportHeight) * scale |
| |
| withSave { |
| translate(translateX, translateY) |
| vector.draw(this, DefaultAlpha, ColorFilter(tintColor, tintBlendMode)) |
| } |
| } |
| } |
| |
| @Composable |
| fun VectorScope.Group( |
| name: String = DefaultGroupName, |
| rotation: Float = DefaultRotation, |
| pivotX: Float = DefaultPivotX, |
| pivotY: Float = DefaultPivotY, |
| scaleX: Float = DefaultScaleX, |
| scaleY: Float = DefaultScaleY, |
| translationX: Float = DefaultTranslationX, |
| translationY: Float = DefaultTranslationY, |
| clipPathData: List<PathNode> = EmptyPath, |
| children: @Composable() VectorScope.() -> Unit |
| ) { |
| GroupComponent( |
| name = name, |
| rotation = rotation, |
| pivotX = pivotX, |
| pivotY = pivotY, |
| scaleX = scaleX, |
| scaleY = scaleY, |
| translationX = translationX, |
| translationY = translationY, |
| clipPathData = clipPathData |
| ) { |
| children() |
| } |
| } |
| |
| @Composable |
| fun VectorScope.Path( |
| pathData: List<PathNode>, |
| name: String = DefaultPathName, |
| fill: Brush? = null, |
| fillAlpha: Float = DefaultAlpha, |
| stroke: Brush? = null, |
| strokeAlpha: Float = DefaultAlpha, |
| strokeLineWidth: Float = DefaultStrokeLineWidth, |
| strokeLineCap: StrokeCap = DefaultStrokeLineCap, |
| strokeLineJoin: StrokeJoin = DefaultStrokeLineJoin, |
| strokeLineMiter: Float = DefaultStrokeLineMiter |
| ) { |
| PathComponent( |
| name = name, |
| pathData = pathData, |
| fill = fill, |
| fillAlpha = fillAlpha, |
| stroke = stroke, |
| strokeAlpha = strokeAlpha, |
| strokeLineWidth = strokeLineWidth, |
| strokeLineJoin = strokeLineJoin, |
| strokeLineCap = strokeLineCap, |
| strokeLineMiter = strokeLineMiter |
| ) |
| } |