VectorDrawable
public
class
VectorDrawable
extends Drawable
java.lang.Object | ||
↳ | android.graphics.drawable.Drawable | |
↳ | android.graphics.drawable.VectorDrawable |
This lets you create a drawable based on an XML vector graphic.
Note: To optimize for the re-drawing performance, one bitmap cache is created for each VectorDrawable. Therefore, referring to the same VectorDrawable means sharing the same bitmap cache. If these references don't agree upon on the same size, the bitmap will be recreated and redrawn every time size is changed. In other words, if a VectorDrawable is used for different sizes, it is more efficient to create multiple VectorDrawables, one for each size. VectorDrawable can be defined in an XML file with the<vector>
element.
The vector drawable has the following elements:
<vector>
- Used to define a vector drawable
android:name
- Defines the name of this vector drawable.
android:width
- Used to define the intrinsic width of the drawable. This supports all the dimension units, normally specified with dp.
android:height
- Used to define the intrinsic height of the drawable. This supports all the dimension units, normally specified with dp.
android:viewportWidth
- Used to define the width of the viewport space. Viewport is basically the virtual canvas where the paths are drawn on.
android:viewportHeight
- Used to define the height of the viewport space. Viewport is basically the virtual canvas where the paths are drawn on.
android:tint
- The color to apply to the drawable as a tint. By default, no tint is applied.
android:tintMode
- The Porter-Duff blending mode for the tint color. Default is src_in.
android:autoMirrored
- Indicates if the drawable needs to be mirrored when its layout direction is RTL (right-to-left). Default is false.
android:alpha
- The opacity of this drawable. Default is 1.0.
<group>
- Defines a group of paths or subgroups, plus transformation information.
The transformations are defined in the same coordinates as the viewport.
And the transformations are applied in the order of scale, rotate then translate.
android:name
- Defines the name of the group.
android:rotation
- The degrees of rotation of the group. Default is 0.
android:pivotX
- The X coordinate of the pivot for the scale and rotation of the group. This is defined in the viewport space. Default is 0.
android:pivotY
- The Y coordinate of the pivot for the scale and rotation of the group. This is defined in the viewport space. Default is 0.
android:scaleX
- The amount of scale on the X Coordinate. Default is 1.
android:scaleY
- The amount of scale on the Y coordinate. Default is 1.
android:translateX
- The amount of translation on the X coordinate. This is defined in the viewport space. Default is 0.
android:translateY
- The amount of translation on the Y coordinate. This is defined in the viewport space. Default is 0.
<path>
- Defines paths to be drawn.
android:name
- Defines the name of the path.
android:pathData
- Defines path data using exactly same format as "d" attribute in the SVG's path data. This is defined in the viewport space.
android:fillColor
- Specifies the color used to fill the path. May be a color or, for SDK 24+, a color state list
or a gradient color (See
R.styleable.GradientColor
andR.styleable.GradientColorItem
). If this property is animated, any value set by the animation will override the original value. No path fill is drawn if this property is not specified. android:strokeColor
- Specifies the color used to draw the path outline. May be a color or, for SDK 24+, a color
state list or a gradient color (See
R.styleable.GradientColor
andR.styleable.GradientColorItem
). If this property is animated, any value set by the animation will override the original value. No path outline is drawn if this property is not specified. android:strokeWidth
- The width a path stroke. Default is 0.
android:strokeAlpha
- The opacity of a path stroke. Default is 1.
android:fillAlpha
- The opacity to fill the path with. Default is 1.
android:trimPathStart
- The fraction of the path to trim from the start, in the range from 0 to 1. Default is 0.
android:trimPathEnd
- The fraction of the path to trim from the end, in the range from 0 to 1. Default is 1.
android:trimPathOffset
- Shift trim region (allows showed region to include the start and end), in the range from 0 to 1. Default is 0.
android:strokeLineCap
- Sets the linecap for a stroked path: butt, round, square. Default is butt.
android:strokeLineJoin
- Sets the lineJoin for a stroked path: miter,round,bevel. Default is miter.
android:strokeMiterLimit
- Sets the Miter limit for a stroked path. Default is 4.
android:fillType
- For SDK 24+, sets the fillType for a path. The types can be either "evenOdd" or "nonZero". They behave the same as SVG's "fill-rule" properties. Default is nonZero. For more details, see FillRuleProperty
<clip-path>
- Defines path to be the current clip. Note that the clip path only apply to
the current group and its children.
android:name
- Defines the name of the clip path.
- Animatable : No.
android:pathData
- Defines clip path using the same format as "d" attribute in the SVG's path data.
- Animatable : Yes.
<vector xmlns:android="http://schemas.android.com/apk/res/android" android:height="64dp" android:width="64dp" android:viewportHeight="600" android:viewportWidth="600" > <group android:name="rotationGroup" android:pivotX="300.0" android:pivotY="300.0" android:rotation="45.0" > <path android:name="v" android:fillColor="#000000" android:pathData="M300,70 l 0,-70 70,70 0,0 -70,70z" /> </group> </vector>
Gradient support
We support 3 types of gradients:LinearGradient
,
RadialGradient
, or SweepGradient
.
And we support all of 3 types of tile modes Shader.TileMode
:
CLAMP, REPEAT, MIRROR.
All of the attributes are listed in R.styleable.GradientColor
.
Note that different attributes are relevant for different types of gradient.
LinearGradient | RadialGradient | SweepGradient |
---|---|---|
startColor | startColor | startColor |
centerColor | centerColor | centerColor |
endColor | endColor | endColor |
type | type | type |
tileMode | tileMode | tileMode |
startX | centerX | centerX |
startY | centerY | centerY |
endX | gradientRadius | |
endY |
R.styleable.GradientColorItem
is defined, then
startColor, centerColor and endColor will be ignored.
See more details in R.styleable.GradientColor
and
R.styleable.GradientColorItem
.
Here is a simple example that defines a linear gradient.
<gradient xmlns:android="http://schemas.android.com/apk/res/android" android:startColor="?android:attr/colorPrimary" android:endColor="?android:attr/colorControlActivated" android:centerColor="#f00" android:startX="0" android:startY="0" android:endX="100" android:endY="100" android:type="linear"> </gradient>
<gradient xmlns:android="http://schemas.android.com/apk/res/android" android:centerX="300" android:centerY="300" android:gradientRadius="100" android:type="radial"> <item android:offset="0.1" android:color="#0ff"/> <item android:offset="0.4" android:color="#fff"/> <item android:offset="0.9" android:color="#ff0"/> </gradient>
Summary
Public constructors | |
---|---|
VectorDrawable()
|
Public methods | |
---|---|
void
|
applyTheme(Resources.Theme t)
Applies the specified theme to this Drawable and its children. |
boolean
|
canApplyTheme()
|
void
|
draw(Canvas canvas)
Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter). |
int
|
getAlpha()
Gets the current alpha value for the drawable. |
int
|
getChangingConfigurations()
Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. |
ColorFilter
|
getColorFilter()
Returns the current color filter, or |
Drawable.ConstantState
|
getConstantState()
Return a |
int
|
getIntrinsicHeight()
Returns the drawable's intrinsic height. |
int
|
getIntrinsicWidth()
Returns the drawable's intrinsic width. |
int
|
getOpacity()
This method is deprecated. This method is no longer used in graphics optimizations |
Insets
|
getOpticalInsets()
Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout. |
boolean
|
hasFocusStateSpecified()
Indicates whether this drawable has at least one state spec explicitly
specifying |
void
|
inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
Inflate this Drawable from an XML resource optionally styled by a theme. |
boolean
|
isAutoMirrored()
Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. |
boolean
|
isStateful()
Indicates whether this drawable will change its appearance based on state. |
Drawable
|
mutate()
Make this drawable mutable. |
void
|
setAlpha(int alpha)
Specify an alpha value for the drawable. |
void
|
setAutoMirrored(boolean mirrored)
Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). |
void
|
setColorFilter(ColorFilter colorFilter)
Specify an optional color filter for the drawable. |
void
|
setTintBlendMode(BlendMode blendMode)
Specifies a tint blending mode for this drawable. |
void
|
setTintList(ColorStateList tint)
Specifies tint color for this drawable as a color state list. |
Protected methods | |
---|---|
boolean
|
onStateChange(int[] stateSet)
Override this in your subclass to change appearance if you recognize the specified state. |
Inherited methods | |
---|---|
Public constructors
Public methods
applyTheme
public void applyTheme (Resources.Theme t)
Applies the specified theme to this Drawable and its children.
Parameters | |
---|---|
t |
Resources.Theme : the theme to apply
This value cannot be null . |
draw
public void draw (Canvas canvas)
Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).
Parameters | |
---|---|
canvas |
Canvas : The canvas to draw into
This value cannot be null . |
getAlpha
public int getAlpha ()
Gets the current alpha value for the drawable. 0 means fully transparent, 255 means fully opaque. This method is implemented by Drawable subclasses and the value returned is specific to how that class treats alpha. The default return value is 255 if the class does not override this method to return a value specific to its use of alpha.
Returns | |
---|---|
int |
Value is between 0 and 255 inclusive |
getChangingConfigurations
public int getChangingConfigurations ()
Return a mask of the configuration parameters for which this drawable
may change, requiring that it be re-created. The default implementation
returns whatever was provided through
setChangingConfigurations(int)
or 0 by default. Subclasses
may extend this to or in the changing configurations of any other
drawables they hold.
getColorFilter
public ColorFilter getColorFilter ()
Returns the current color filter, or null
if none set.
Returns | |
---|---|
ColorFilter |
the current color filter, or null if none set |
getConstantState
public Drawable.ConstantState getConstantState ()
Return a ConstantState
instance that holds the shared state of this Drawable.
Returns | |
---|---|
Drawable.ConstantState |
The ConstantState associated to that Drawable.
This value may be null . |
getIntrinsicHeight
public int getIntrinsicHeight ()
Returns the drawable's intrinsic height.
Intrinsic height is the height at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic height, such as a solid color, this method returns -1.
Returns | |
---|---|
int |
the intrinsic height, or -1 if no intrinsic height |
getIntrinsicWidth
public int getIntrinsicWidth ()
Returns the drawable's intrinsic width.
Intrinsic width is the width at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic width, such as a solid color, this method returns -1.
Returns | |
---|---|
int |
the intrinsic width, or -1 if no intrinsic width |
getOpacity
public int getOpacity ()
This method is deprecated.
This method is no longer used in graphics optimizations
Return the opacity/transparency of this Drawable. The returned value is
one of the abstract format constants in
PixelFormat
:
PixelFormat.UNKNOWN
,
PixelFormat.TRANSLUCENT
,
PixelFormat.TRANSPARENT
, or
PixelFormat.OPAQUE
.
An OPAQUE drawable is one that draws all all content within its bounds, completely covering anything behind the drawable. A TRANSPARENT drawable is one that draws nothing within its bounds, allowing everything behind it to show through. A TRANSLUCENT drawable is a drawable in any other state, where the drawable will draw some, but not all, of the content within its bounds and at least some content behind the drawable will be visible. If the visibility of the drawable's contents cannot be determined, the safest/best return value is TRANSLUCENT.
Generally a Drawable should be as conservative as possible with the
value it returns. For example, if it contains multiple child drawables
and only shows one of them at a time, if only one of the children is
TRANSLUCENT and the others are OPAQUE then TRANSLUCENT should be
returned. You can use the method resolveOpacity(int, int)
to perform a
standard reduction of two opacities to the appropriate single output.
Note that the returned value does not necessarily take into account a
custom alpha or color filter that has been applied by the client through
the setAlpha(int)
or setColorFilter(ColorFilter)
methods. Some subclasses,
such as BitmapDrawable
, ColorDrawable
, and GradientDrawable
,
do account for the value of setAlpha(int)
, but the general behavior is dependent
upon the implementation of the subclass.
Returns | |
---|---|
int |
int The opacity class of the Drawable.
Value is PixelFormat.UNKNOWN , PixelFormat.TRANSLUCENT , PixelFormat.TRANSPARENT , or PixelFormat.OPAQUE |
getOpticalInsets
public Insets getOpticalInsets ()
Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.
Returns | |
---|---|
Insets |
This value cannot be null . |
hasFocusStateSpecified
public boolean hasFocusStateSpecified ()
Indicates whether this drawable has at least one state spec explicitly
specifying R.attr.state_focused
.
Note: A View uses a Drawable
instance as its background and it
changes its appearance based on a state. On keyboard devices, it should
specify its R.attr.state_focused
to make sure the user
knows which view is holding the focus.
Returns | |
---|---|
boolean |
true if R.attr.state_focused is specified
for this drawable. |
inflate
public void inflate (Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
Inflate this Drawable from an XML resource optionally styled by a theme. This can't be called more than once for each Drawable. Note that framework may have called this once to create the Drawable instance from XML resource.
Parameters | |
---|---|
r |
Resources : This value cannot be null . |
parser |
XmlPullParser : This value cannot be null . |
attrs |
AttributeSet : This value cannot be null . |
theme |
Resources.Theme : This value may be null . |
Throws | |
---|---|
IOException |
|
XmlPullParserException |
isAutoMirrored
public boolean isAutoMirrored ()
Tells if this Drawable will be automatically mirrored when its layout direction is RTL
right-to-left. See LayoutDirection
.
Returns | |
---|---|
boolean |
boolean Returns true if this Drawable will be automatically mirrored. |
isStateful
public boolean isStateful ()
Indicates whether this drawable will change its appearance based on state. Clients can use this to determine whether it is necessary to calculate their state and call setState.
Returns | |
---|---|
boolean |
True if this drawable changes its appearance based on state, false otherwise. |
mutate
public Drawable mutate ()
Make this drawable mutable. This operation cannot be reversed. A mutable drawable is guaranteed to not share its state with any other drawable. This is especially useful when you need to modify properties of drawables loaded from resources. By default, all drawables instances loaded from the same resource share a common state; if you modify the state of one instance, all the other instances will receive the same modification. Calling this method on a mutable Drawable will have no effect.
Returns | |
---|---|
Drawable |
This drawable.
This value cannot be null . |
setAlpha
public void setAlpha (int alpha)
Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.
Parameters | |
---|---|
alpha |
int : Value is between 0 and 255 inclusive |
setAutoMirrored
public void setAutoMirrored (boolean mirrored)
Set whether this Drawable is automatically mirrored when its layout direction is RTL
(right-to left). See LayoutDirection
.
Parameters | |
---|---|
mirrored |
boolean : Set to true if the Drawable should be mirrored, false if not. |
setColorFilter
public void setColorFilter (ColorFilter colorFilter)
Specify an optional color filter for the drawable.
If a Drawable has a ColorFilter, each output pixel of the Drawable's drawing contents will be modified by the color filter before it is blended onto the render target of a Canvas.
Pass null
to remove any existing color filter.
Note: Setting a non-null
color
filter disables tint
.
Parameters | |
---|---|
colorFilter |
ColorFilter : The color filter to apply, or null to remove the
existing color filter |
setTintBlendMode
public void setTintBlendMode (BlendMode blendMode)
Specifies a tint blending mode for this drawable.
Defines how this drawable's tint color should be blended into the drawable
before it is drawn to screen. Default tint mode is BlendMode#SRC_IN
.
Note: Setting a color filter via
setColorFilter(android.graphics.ColorFilter)
Parameters | |
---|---|
blendMode |
BlendMode : This value cannot be null . |
setTintList
public void setTintList (ColorStateList tint)
Specifies tint color for this drawable as a color state list.
A Drawable's drawing content will be blended together with its tint
before it is drawn to the screen. This functions similarly to
setColorFilter(int, android.graphics.PorterDuff.Mode)
.
Note: Setting a color filter via
setColorFilter(android.graphics.ColorFilter)
or
setColorFilter(int, android.graphics.PorterDuff.Mode)
overrides tint.
Parameters | |
---|---|
tint |
ColorStateList : Color state list to use for tinting this drawable, or
null to clear the tint |
Protected methods
onStateChange
protected boolean onStateChange (int[] stateSet)
Override this in your subclass to change appearance if you recognize the specified state.
Parameters | |
---|---|
stateSet |
int : This value cannot be null . |
Returns | |
---|---|
boolean |
Returns true if the state change has caused the appearance of the Drawable to change (that is, it needs to be drawn), else false if it looks the same and there is no need to redraw it since its last state. |