VectorAssetBuilder
class VectorAssetBuilder
| kotlin.Any | |
| ↳ | androidx.compose.ui.graphics.vector.VectorAssetBuilder |
Builder used to construct a Vector graphic tree. This is useful for caching the result of expensive operations used to construct a vector graphic for compose. For example, the vector graphic could be serialized and downloaded from a server and represented internally in a VectorAsset before it is composed through VectorPainter The generated VectorAsset is recommended to be memoized across composition calls to avoid doing redundant work
Summary
| Public constructors | |
|---|---|
<init>(name: String = DefaultGroupName, defaultWidth: Dp, defaultHeight: Dp, viewportWidth: Float, viewportHeight: Float)Builder used to construct a Vector graphic tree. |
|
| Public methods | |
|---|---|
| VectorAssetBuilder |
addPath(pathData: List<PathNode>, pathFillType: PathFillType = DefaultFillType, name: String = DefaultPathName, fill: Brush? = null, fillAlpha: Float = 1.0f, stroke: Brush? = null, strokeAlpha: Float = 1.0f, strokeLineWidth: Float = DefaultStrokeLineWidth, strokeLineCap: StrokeCap = DefaultStrokeLineCap, strokeLineJoin: StrokeJoin = DefaultStrokeLineJoin, strokeLineMiter: Float = DefaultStrokeLineMiter, trimPathStart: Float = DefaultTrimPathStart, trimPathEnd: Float = DefaultTrimPathEnd, trimPathOffset: Float = DefaultTrimPathOffset)Add a path to the VectorAsset graphic. |
| VectorAsset |
build()Construct a VectorAsset. |
| VectorAssetBuilder |
popGroup()Pops the topmost VectorGroup from this VectorAssetBuilder. |
| VectorAssetBuilder |
pushGroup(name: String = DefaultGroupName, rotate: Float = DefaultRotation, pivotX: Float = DefaultPivotX, pivotY: Float = DefaultPivotY, scaleX: Float = DefaultScaleX, scaleY: Float = DefaultScaleY, translationX: Float = DefaultTranslationX, translationY: Float = DefaultTranslationY, clipPathData: List<PathNode> = EmptyPath)Create a new group and push it to the front of the stack of VectorAsset nodes |
| Extension functions | ||||
|---|---|---|---|---|
From androidx.compose.ui.graphics.vector
|
||||
From androidx.compose.material.icons
|
||||
| Properties | |
|---|---|
| Dp |
Intrinsic height of the Vector in Dp |
| Dp |
Intrinsic width of the Vector in Dp |
| String |
Name of the vector asset |
| Float |
Used to define the height of the viewport space. |
| Float |
Used to define the width of the viewport space. |
Public constructors
<init>
VectorAssetBuilder(
name: String = DefaultGroupName,
defaultWidth: Dp,
defaultHeight: Dp,
viewportWidth: Float,
viewportHeight: Float)
Builder used to construct a Vector graphic tree. This is useful for caching the result of expensive operations used to construct a vector graphic for compose. For example, the vector graphic could be serialized and downloaded from a server and represented internally in a VectorAsset before it is composed through VectorPainter The generated VectorAsset is recommended to be memoized across composition calls to avoid doing redundant work
Public methods
addPath
fun addPath(
pathData: List<PathNode>,
pathFillType: PathFillType = DefaultFillType,
name: String = DefaultPathName,
fill: Brush? = null,
fillAlpha: Float = 1.0f,
stroke: Brush? = null,
strokeAlpha: Float = 1.0f,
strokeLineWidth: Float = DefaultStrokeLineWidth,
strokeLineCap: StrokeCap = DefaultStrokeLineCap,
strokeLineJoin: StrokeJoin = DefaultStrokeLineJoin,
strokeLineMiter: Float = DefaultStrokeLineMiter,
trimPathStart: Float = DefaultTrimPathStart,
trimPathEnd: Float = DefaultTrimPathEnd,
trimPathOffset: Float = DefaultTrimPathOffset
): VectorAssetBuilder
Add a path to the VectorAsset graphic. This represents a leaf node in the VectorAsset graphics tree structure
| Parameters | |
|---|---|
| pathData: List<PathNode> | path information to render the shape of the path |
| pathFillType: PathFillType = DefaultFillType | rule to determine how the interior of the path is to be calculated |
| name: String = DefaultPathName | the name of the path |
| fill: Brush? = null | specifies the Brush used to fill the path |
| fillAlpha: Float = 1.0f | the alpha to fill the path |
| stroke: Brush? = null | specifies the Brush used to fill the stroke |
| strokeAlpha: Float = 1.0f | the alpha to stroke the path |
| strokeLineWidth: Float = DefaultStrokeLineWidth | the width of the line to stroke the path |
| strokeLineCap: StrokeCap = DefaultStrokeLineCap | specifies the linecap for a stroked path |
| strokeLineJoin: StrokeJoin = DefaultStrokeLineJoin | specifies the linejoin for a stroked path |
| strokeLineMiter: Float = DefaultStrokeLineMiter | specifies the miter limit for a stroked path |
| trimPathStart: Float = DefaultTrimPathStart | specifies the fraction of the path to trim from the start in the range from 0 to 1. Values outside the range will wrap around the length of the path. Default is 0. |
| trimPathStart: Float = DefaultTrimPathStart | specifies the fraction of the path to trim from the end in the range from 0 to 1. Values outside the range will wrap around the length of the path. Default is 1. |
| trimPathOffset: Float = DefaultTrimPathOffset | specifies the fraction to shift the path trim region in the range from 0 to 1. Values outside the range will wrap around the length of the path. Default is 0. |
| Return | |
|---|---|
| This VectorAssetBuilder instance as a convenience for chaining calls | |
build
fun build(): VectorAsset
Construct a VectorAsset. This concludes the creation process of a VectorAsset graphic This builder cannot be re-used to create additional VectorAsset instances
| Return | |
|---|---|
| The newly created VectorAsset instance | |
popGroup
fun popGroup(): VectorAssetBuilder
Pops the topmost VectorGroup from this VectorAssetBuilder. This is used to indicate that no additional VectorAsset nodes will be added to the current VectorGroup
| Return | |
|---|---|
| This VectorAssetBuilder instance as a convenience for chaining calls | |
pushGroup
fun pushGroup(
name: String = DefaultGroupName,
rotate: Float = DefaultRotation,
pivotX: Float = DefaultPivotX,
pivotY: Float = DefaultPivotY,
scaleX: Float = DefaultScaleX,
scaleY: Float = DefaultScaleY,
translationX: Float = DefaultTranslationX,
translationY: Float = DefaultTranslationY,
clipPathData: List<PathNode> = EmptyPath
): VectorAssetBuilder
Create a new group and push it to the front of the stack of VectorAsset nodes
| Parameters | |
|---|---|
| name: String = DefaultGroupName | the name of the group |
| rotate: Float = DefaultRotation | the rotation of the group in degrees |
| pivotX: Float = DefaultPivotX | the x coordinate of the pivot point to rotate or scale the group |
| pivotY: Float = DefaultPivotY | the y coordinate of the pivot point to rotate or scale the group |
| scaleX: Float = DefaultScaleX | the scale factor in the X-axis to apply to the group |
| scaleY: Float = DefaultScaleY | the scale factor in the Y-axis to apply to the group |
| translationX: Float = DefaultTranslationX | the translation in virtual pixels to apply along the x-axis |
| translationY: Float = DefaultTranslationY | the translation in virtual pixels to apply along the y-axis |
| clipPathData: List<PathNode> = EmptyPath | the path information used to clip the content within the group |
| Return | |
|---|---|
| This VectorAssetBuilder instance as a convenience for chaining calls | |
Properties
viewportHeight
val viewportHeight: Float
Used to define the height of the viewport space. Viewport is basically the virtual canvas where the paths are drawn on.
viewportWidth
val viewportWidth: Float
Used to define the width of the viewport space. Viewport is basically the virtual canvas where the paths are drawn on.