引擎概述

引擎制作锁屏,基于xml用特定的语法描述锁屏界面。在一定需求下可用于开发风格多变的用户界面。可方便地通过更换皮肤改变界面风格、动画甚至交互方式。框架支持动态帧率,不必按照固定帧率不停渲染。在没有动画和更新的时侯停止渲染,此时仅占用极少资源,对于缓慢变化的动画使用低帧率渲染,高动态的动画开始后立即调整到高帧率全速渲染。全速渲染时全屏帧率基本可以达到60帧。合理使用可以既炫酷又不费电。

 

动态脚本在锁屏中的应用

引擎通过解析资源中的描述脚本manifest.xml文件,生成一个丰富多彩符合设计者预期的画面,应用在锁屏中,使锁屏变得生动有趣

 

锁屏资源包含的文件

manifest.xml

 

基础功能

视图

文本-Text

 

功能概述

按照特定格式来显示文本,支持对文字大小、颜色、行间距、是否自动换行(当文字实际宽度超过设置的宽度时)等进行设置;此外,还提供文字跑马灯、文字阴影以及文字路径(即可以将文字按照设定的路径轨迹来进行展示)等高级的文字效果。

 

XML规范

 

参数说明

参 数类 型选 项注释
color字符串选填文字颜色,支持6位或8位16进制颜色表示,如:#FFFFFF . #FFFFFFFF,8位中前两位表示透明度,
后六位依次表示红. 绿. 蓝;支持函数argb(255,255,255,255) (argb(透明度,红,绿,蓝),
每个数值在[0-255]范围内);支持字符串变量,如:@abc,字符串变量需为无#的6或8位16进制表示:
"ffffff". “ffffffff",或argb函数。注意:设置color后通用属性alpha设置无效。
size数值选填文字大小,取值正数,默认40,单位为像素。
format字符串选填支持在文字中引用数值或字符串变量,用%d,%s 指定变量位置,并在paras参数中指定对应变量表达式;
支持引用多个变量;%d表示数值表达式,%s表示字符串表达式。
paras字符串选填如果使用format参数, 则需要在paras参数中指定%d,%s对应的变量表达式;多个变量表达式用"," 隔开;
%d表示数值表达式,%s表示字符串表达式。
textExp(text)字符串选填文字表达式,可直接引用单变量,不支持由多个变量构建的表达式。示例:想要输出“现在时间是9点”,
则可以写成textExp="'现在时间是'+#hour+'点'";text与textExp效果相同。使用text方式,
则可以写成text="现在时间是9点"。
width数值选填文字宽度,当文字超过该宽度时会被切掉。如果设置了自动换行,则会折行显示文字。
autoLineFeed字符串选填true/false,控制是否支持自动换行。true为支持自动换行,默认false。为true时须设置width,
否则不会自动换行。
textalign字符串选填文字的对齐方式,可选输入为left, right, center,分别为左对齐,右对齐和居中对齐。
bold字符串选填true/false,字体是否加粗,true表示加粗,默认false。
spaceTimes数值选填行间距倍数,类似于word行间距,默认1。
spaceExtraAdd数值选填行间距的额外增加值,即在基础行距上增加多少行间距。单位像素,默认0。
shadowDx数值选填文字阴影横向偏移距离,单位为像素。
shadowDy数值选填文字阴影纵向偏移距离,单位为像素。
radius数值选填模糊半径,建议范围[1-24],值越小文字阴影越清晰。(模糊半径相同时,
size大的文本阴影相对size小的文本模糊程度略小一些)注意:小于等于0无阴影效果。
shadowColor字符串选填阴影颜色,颜色取值见color参数解释;不设置该参数则无文字阴影效果。
marquee字符串选填true/false,控制是否使用文字跑马灯效果,true为使用,默认false。
注意:若同时使用文字跑马灯和文字阴影,则文字阴影颜色会被跑马灯颜色覆盖。
showTime数值选填跑马灯移动间隔时长,单位为ms。
showStyle数值选填0/1,默认为0,控制跑马灯效果。0表示单向闪动,1表示来回闪动。
marqueeColor字符串选填跑马灯灯的颜色,颜色取值见color参数解释。
tileMode字符串选填跑马灯颜色平铺模式,支持两种模式。STRETCH:跑马灯颜色边缘拉伸,是默认值;
LOOP:color和marqueeColor在水平方向上重复。注意:如果无法清楚地看到两种模式的区别,
可以将text内容设置为,中文字符7个以上,英文字符10个以上。
canPath字符串选填true/false,控制是否将文字按照path路径进行展示,其中路径由一系列PathItem定义。
Text标签中x,y参数表示路径起始点; PathItem标签参数解析:PathItem 表示一小段路径,
其中type表示路径类型(quadTo或者lineTo);controlX, controlY表示路径控制点的横纵坐标
(路径控制点类似PS中钢笔工具两点之间锚点的位置坐标,用于控制弧度大小);
PathItem标签中x,y参数表示路径结束点的横纵坐标;注意:controlX, controlY 仅在type类型为
quadTo时生效,为lineTo时无须设置。

 

应用示例

示例一:演示文本行间距、自动换行、文字阴影、文字跑马灯等效果。

示例二:演示文本路径效果,支持将文字按照PathItem中定义的路径进行展示。

 

图片-Image

 

功能概述

用于在锁屏界面上展示一张图片,可以指定图片路径,模糊程度等属性,支持通用属性来设置图片的位置、大小以及旋转等等。

 

XML规范

模式1:使用src解析图片资源。

模式2:使用srcExp解析图片资源。

 

参数说明

参 数类 型选 项注 释
src字符串选填图片名称的相对路径,图片文件名image.png,可在前加文件夹,如wenjianjia/image.png。
src与srcExp两个参数必须填写一个,以指定显示的图片内容。图片支持用户自动义,
自定义路径必须为sd卡下路径,须以“../../../../../sdcard”开头,例如“../../../../../sdcard/Pictures/123.png”,
后续路径可自定义。图片必须为png/jpg格式。图片大小须小于10M。
blur字符串选填模糊半径值的设置,其值为0到24,设置值越大则图片模糊程度越高。
srcid数值选填图片序列后缀数字,一般用变量表示,可以根据变量显示不同的图片,如果src="pic.png" srcid="1"
则最后会显示图片 "pic_1.png",大于0, 正整数,支持数字表达式。
scaleType字符串选填图片的缩放模式,目前支持三种模式:fill、center_crop和hold_center_crop,默认为center_crop模式。
1. fill 表示填充满屏幕,若图片比例与屏幕不匹配会导致图片拉伸。
2. center_crop 表示按照屏幕宽高的比例进行缩放,使图片居中充满整个屏幕,多余部分裁剪。
3. hold_center_crop 表示图片不进行缩放处理,居中裁剪脚本中设置的w、h区域。
srcExp字符串选填图片源表达式,解析字符串表达式指定图片的源地址。无法与src共存,当存在src值时,
图片使用src作为地址。
useVirtualScreen字符串选填是否支持虚拟屏幕,true/false,默认false,若为true支持虚拟屏幕则src参数必须为虚拟屏幕的名称。

 

应用示例

示例:左上角(120,500)显示一张图片,距离左上角点x方向110,y方向80像素的位置为旋转中心,根据旋转中心x轴有一个50度,根据旋转中心y轴有一个50度的旋转,加载图片源名为yun_#id.png。图片包含位移动画和旋转动画,并且有一个模糊半径为15的模糊效果。

 

动态图片-Image

 

动效概述

Image的增强功能,支持Gif类型图片循环播放。

 

场景举例

XML规范

参 数类 型选 项注 释
src字符串必填图片文件名,如:image.gif,也可在前加文件夹,如wenjianjia/image.gif。当图片名称中包含.gif,
循环播放Gif图片;图片的大小、位置等参数与Image设置相同,只需要在src参数中填入gif图片名称即可。
小于5.0MB动态显示,大于或等于5.0MB静态显示,设计师应提供大小合适图片资源。
loop字符串选填该参数不配置或空,默认循环播放gif动画;若显式配置该参数true循环播放或false只播放一次。
save数值选填可为表达式;大于1是保存Gif至Gallary;等于或小于1时不保存。

 

代码展示和效果

Gif背景动态图显示播放。

 

 

视频-Video

 

功能概述

视频播放控件,将一段视频加入到视图中,能够设置播放、循环播放、声音控制等功能;支持AVI,MP4,MOV等多种格式的本地视频的播放。

 

XML规范

 

参数说明

参 数类 型选 项注 释
name字符串必填视频命名,可用于videoCommand的定位Video对象,以控制视频的播放、换源和音量等。
x数值选填视频左上角x位置,支持数字表达式,默认值为0。
y数值选填视频左上角y位置,支持数字表达式,默认值为0。
w(width)数值选填视频显示的宽,单位像素,默认为屏幕大小。
h(height)数值选填视频显示的高,单位像素,默认为屏幕大小。
play字符串选填是否加载之后自动开始播放,true/false,默认值为true。
looping字符串选填视频是否循环播放,true/false,默认值为false不循环播放。
sound数值选填视频播放声音控制,值为0~1之间的值,值越大声音越大。
living字符串选填路径是否为URI路径而非本地路径,true/false。living为true则src需为uri路径,默认false,
默认为本地路径。
src字符串必填视频的文件路径,可带文件夹路径,例如aa/exmple.mp4,js.mp4等。
scaleType字符串选填支持fill、fit_width二种模式,默认为fill模式。fill表示填充满width和height宽高,
若视频比例与屏幕不匹配会导致视频拉伸。fit_width表示宽匹配功能,视频缩放到设置的width那么宽,
按照视频比例调整height,若视频宽高比例大于屏幕,则填充不满屏幕,若视频宽高比小于屏幕,
则会有部分视频不在显示区域中。
visibility数值选填视频组件的可见性,支持true/false和1/0来分别调整视频的可见或者不可见。
defaultBitmap字符串选填选填,默认图片,即视频未加载时或者停止时默认显示的图片。
普通手机/折叠屏手机折叠态/平板竖屏态时使用。图片需要和普通手机/折叠屏手机折叠态/平板竖屏态
原本的视频保持一致的宽高,推荐使用视频首帧图片。因为视频加载需要时间,先显示一张首帧图,
让视频显示有个平滑的过渡效果。
defaultBigBitmap字符串选填选填,默认图片,即视频未加载时或者停止时默认显示的图片。折叠屏手机展开态/平板横屏态时使用。
图片需要和折叠屏手机展开态/平板横屏态原本的视频保持一致的宽高,推荐使用视频首帧图片。
因为视频加载需要时间,先显示一张首帧图,让视频显示有个平滑的过渡效果

 

应用示例

示例一:插入一段视频,视频左上角坐标是x=0,y=0,宽高为屏幕的宽高,采用的模式是fit_width,那么最终显示的宽度为屏幕宽度,显示的高度为原视频高宽比例乘以屏幕宽度。视频的源是目录下的js.mp4文件,并且在视频未加载的时候会展示bg.jpg这张图片。视频加载之后会自动播放,并且没有声音,视频设置为循环播放。

示例二:插入一段有声视频。

 

时间-Time

 

功能概述

这里的时间,其实是由10个数字图片和分隔符图片依时间格式(HH:mm)组成的图片组合。使用该功能需要准备“0”-“9” 10张数字图片和“:”时间间隔图片。该组合图片也支持通用属性和图片的透明度、缩放、旋转动画。

 

XML规范

参数说明

参 数类 型选 项注 释
src字符串必填时间图片的前缀和后缀组合字符串,例如src=“time.png",
此时文件夹中的数字图片和分隔符图片名称为”time_0.png“,...,"time_9.png"和”time_dot.png"
space数值选填时间图片的间隔,单位为像素,数值越大图片之间的间距越大,小于0时图片会有重叠,默认值为0

 

应用示例

示例一:显示时间,space为10可以使所有数字和时间间隔图片间的间隔增加10个像素。

图片展示时间的另一种自定义写法:通过根据时间变量计算得到Image的srcid,从而实现利用图片显示时间。

示例二:带透明度动画效果时间。设置时间图片在每个1000ms内从透明到不透明变化,呈现闪动效果。

 

日期-DateTime

 

功能概述

显示指定格式(format)的日期文本,会根据手机默认语言显示该语言下format中特殊字符对应的表示。该功能也支持通用属性和透明度、旋转、缩放动画。

 

XML规范

 

参数说明

参 数类 型选 项注 释
format字符串必填通过格式化字符,输出期望格式的日期,字符含义如下表。(实际功能:
替换format中出现在格式化字符含义表格中的字符,其余字符保持原位)。
如果没有format则会根据区域和语言显示月日星期的信息
color字符串选填日期文本颜色,支持6或8位16进制颜色表示,如#ffffff
size数值必填日期文本的大小,默认为0,支持表达式

格式化字符的含义

时间格式化通用字符:

字 母表 示数据格式示 例
yYearyyy,yyyy:四位数字年,2019y,yy:两位数年,19
M年中的月份MonthM : 7MM : 07MMM : Jul,7月MMMM : July,七月MMMMM : J,7
d月份中的天数Numberd :5dd :05
E星期中的天数TextE,EE,EEE : Fri,周五EEEE : Friday 星期五EEEEE : F,五
a(Am/pm). (上午/下午) 标记TextAM PM /上午 下午
H一天中的小时数(0-23)Number0,会根据手机时间设置更换成12/24小时制显示
k一天中的小时数(1-24)Number24,会根据手机时间设置更换成12/24小时制显示
Kam/pm 中的小时数(0-11)Number0,会根据手机时间设置更换成12/24小时制显示
ham/pm 中的小时数(1-12)Number12,会根据手机时间设置更换成12/24小时制显示
m小时中的分钟数Numberm : 7mm : 07mmm : 007mmmm : 0007
s分钟中的秒数Numbers : 7ss : 07sss : 007ssss : 0007
z时区Textzzzz:“中国标准时间”ZZZZZ:“+08:00”ZZZZ:“GMT+08:00”z/Z/ZZ/ZZZ:“+0800”

时间格式化特殊字符:

字 母表 示数据格式示 例
NNNN农历Text六月初八,手机系统默认语言对功能无效,始终显示中文
AA生肖Text十二生肖,手机系统默认语言对功能无效,始终显示中文
YY年干支Text“己亥” 年干支 目前只支持2019及以后的年份,手机系统默认语言对功能无效,始终显示中文
NN月干支Text”壬申” 等月干支,手机系统默认语言对功能无效,始终显示中文
ee日干支Text“癸未” 等日干支,手机系统默认语言对功能无效,始终显示中文
II时辰干支Text“甲子”等 时辰干支,手机系统默认语言对功能无效,始终显示中文
I地支时辰Text“子” 等地支时辰,手机系统默认语言对功能无效,始终显示中文
N农历月Text“正月”,...,“腊月”等 农历月,手机系统默认语言对功能无效,始终显示中文
e农历日Text“初一”,...,“廿十” 等 农历日,手机系统默认语言对功能无效,始终显示中文
aa时间段描述Text0-5点 凌晨;5-11点 上午; 11-13点 中午; 13-17点 下午;17-19点傍晚;19-24点 晚上。
手机系统默认语言对功能无效,始终显示中文
G公元Text"公元",手机系统默认语言对功能无效,始终显示中文
Y公元年Text如“二〇一九”,手机系统默认语言对功能无效,始终显示中文
CM汉字月Text“一”,...,“十二” 等汉字月,手机系统默认语言对功能无效,始终显示中文
DD汉字日Text"一",...,"三十一"等汉字日,手机系统默认语言对功能无效,始终显示中文
D一年的第几天Number一年的第几天
t二十四节气Text二十四节气 目前只支持2019-2050年的节气查询,手机系统默认语言对功能无效,始终显示中文

 

应用示例

示例一:带动画效果日期。添加透明度动画效果,设置日期文本在每个1000ms内从透明到不透明变化,呈现闪动效果。

示例二:部分格式化字符使用展示。

 

倒计时-CountDownTime

 

功能概述

能够计算目前时间到另外一个日期时间所剩余的时间,提供了多个不同粒度的时间显示以及不同的目标日期的设定方法。

 

XML规范

倒计时标签为-CountDownTime其中仅仅包含了时间的设定以及显示的粒度设定,其中name为全局变量的设定,使用直接对全局变量进行引用,具体见全局变量。

 

参数说明

参 数类 型选 项注 释
name字符串必填设定全局变量的名称,能够使用该名称对全局变量进行值的设置和获取,
注意使用全局变量一定要在声明之后。
countDownType字符串必填输入日期的类型,分为concrete和loop,详情见后文
date字符串必填目标日期,根据不同的日期或者时间的格式,结合类型判断目标时间
unit字符串选填粒度单位,提供不同粒度的倒计时显示,默认为day

注意:

  1. 无论是过去的时间还是将来还剩下来的时间的输出都是正值,方便自定义文字的输出。

  2. unit 中hour、minute、second等只包含不满一个周期的时间,即hour范围为为0-23、 minute为0-59、 second为0-59。如果需要全部计算请使用后面带Only的unit字段。

  3. 注意所有填写的日期必须是真实存在的日期。

     

应用示例

示例:不同concrete和loop以及不同粒度的倒计时的应用。

 

数字图片-ImageNumber

 

功能概述

数字图片能够对输入的数值或者数值表达式进行解析,并按照表达式中数字顺序拼接字符图片。例如,src="number.png" 则会使用 number_0.png,number_1.png 等字符图片来显示数字(即映射"_"字符后的数字字符)。串联图片-ImageSeries已包含了数字图片的功能,在使用ImageNumber的时候较长的数值会导致不精确的问题,建议使用串联图片ImageSeries。

 

XML规范

 

参数说明

参 数类 型选 项注 释
number数值必填要显示的数值或者数值表达式,取值需为有效数值,且位数小于8位。
有效数值示例:1234,1023456;无效数值示例:0123
src字符串必填字符图片源的文件名,例如图片前缀是pre,则需要准备pre_0~pre_9等10张图片,
图片后缀保持与src一致

应用示例

示例一:该示例展示了number取数值1234567的情景。由于图片前缀为number,则会取number_1.png,...,number_7.png这7张字符图片,拼接为数字串并进行显示。

示例二:该示例展示了number取全局变量#screen_width(屏幕宽度)得到参数值并且与src使用下划线进行拼接,加载相应的图片。例如#screen_width等于720, 则取number_7.png、number_2.png、number_0.png这几张图进行显示。

 

串联图片-ImageSeries

 

功能概述

串联图片ImageSeries提供了根据输入字符串进行图片串联的功能,即能够按照字符顺序将字符图片拼在一起并显示;相比较ImageNumber,串联图片能够解析字符而不仅限于数字,提供了更强的解析能力。例如,可以用字符图片显示 '2020.01.01'(包含两个'.')或者 'Moon Festival 8.15'(包含字符),而这些功能数字图片均无法支持。

 

XML规范

 

参数说明

参 数类 型选 项注 释
src字符串必填待拼接的字符图片前缀,前缀与后缀通过“_”连接
string表达式必填按照字符串的形式提供待拼接的多张字符图片后缀,支持字符串和字符串表达式。
例如,letter_0.png表示一张完整字符图片名称,其中letter表示前缀,0表示后缀,通过“_”相连
space数值选填待拼接的字符图片之间的间隔,默认为0
mapList字符串必填映射列表,用英文逗号分隔。其中,每项第一个字符表示原字符(对应string中的字符),
后续字符串(一个或多个)表示映射字符串(对应字符图片名称)

 

应用示例

示例一:该示例展示了string为字符串"Aa/Bb/Cc/Dd"的情形,可以支持字母以及斜杠字符的展示。关键在于mapList设置字符对应关系。

示例二:该示例展示string为字符串变量的情形,实现显示农历日期的功能。string中使用了ifelse、plus、#month以及#date等函数和变量。0表示汉字“初”,1-9为汉字“一”- “九”,a表示汉字“十”,b表示汉字“廿”,c表示“冬”,d表示“腊”,“/”表示“月”。如果月份小于9则加1(#month取值为0-11),等于9则将其转化为a,等于10则转化为c,等于11则转化为d; #date则分别计算十位和个位数字,并找到对应字符图片。注意:这时需要把string中可能出现的字符在mapList中做字符映射,否则无法显示。

说明

 

帧解锁视图-SourceImage

 

功能概述

根据设定的图片和时间间隔顺序播放图片,是另外一种形式的帧动画。它提供解锁的功能,当触摸时帧数大于等于设定值时能够调用解锁操作,若未大于等于设定值时抬起手指,则加速递减回首帧。但是,帧解锁视图会在一定程度上牺牲流畅度,降低系统的内存占用,适用于不需要高流畅度的帧动画效果。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
sourceName字符串必填指定图片名的前缀,例如name="aa/pic_",表示aa文件夹中pic开头的图片
format字符串必填图片后缀名,.jpg/.png,组合成的图片的文件名,例如 aa/pic_0.jpg
from数值选填动画首帧图片名字的序号,正整数,默认0,支持表达式
to数值必填动画末帧图片名字的序号,正整数,默认0,支持表达式
space数值选填每帧动画播放的间隔时间(毫秒),正整数,默认30
loop字符串选填动画是否需要循环,true/false,默认为true。true时循环播放,
可与direction和unlockTo配合设置触发解锁。false时只播放一次,direction无效,
即不能触发解锁,unlockTo参数依旧有效,在小于unlockTo时点击屏幕加速递减回到首帧并停止,
若长按至unlockTo则停止在unlockTo;若大于等于unlockTo时点击屏幕则停止在当前帧;
若不点击则在to帧时停止。
direction数值选填0/1,如果需要使用帧动画解锁,direction设置为0,loop必须为true,unlockTo必须有值。
如果不需要解锁,设置direction为1,loop为true时,会正常从首帧到末帧循环播放。direction默认值1
unlockTo数值选填触发解锁的帧序号,(from,to)间正整数,如果需要使用帧动画解锁,必须设置触发解锁的帧序号。
触摸屏幕后,当当前图片序号大于等于这一帧序号-1时解锁。如果unlock直接设置为末帧或者超过末帧,
序号会直接增大到末帧并解锁。注意解锁功能需要与一个button区域结合使用,即需要一个button区域才能够触发。

 

应用示例

示例一:图片从aa/pic_0.png到aa/pic_30.png以时间间隔为500ms进行循环播放,在没有触摸操作时,图片顺序增大,当到末帧时图片从递增变为递减播放帧图片。当触摸屏幕的时候,如果当时播放帧数大于unlock帧-1则执行解锁操作,否则当前帧数以3帧每次的速度回退到首帧。使用一个全屏的button区域作为触发区域。

示例二:图片从aa/pic_0.png到aa/pic_30.png以时间间隔为500ms进行循环播放,在没有触摸操作时,图片顺序增大,当到末帧时图片从首帧开始循环播放帧图片。当触摸屏幕的时候,则当前帧数以3帧每次的速度回退到首帧。若长按屏幕,如果当前帧小于等于unlock帧则一直在首帧到unlock帧循环,若当前帧大于unlock帧则回到首帧开始循环。使用一个全屏的button区域作为触发区域。

示例三:图片从首帧aa/pic_0开始以时间间隔500ms播放到aa/pic_30帧之后停止播放,最后显示的为末帧。若在动画播放到第10帧前点击屏幕,则以3帧每次的速度退回到首帧;若在动画播放到第10帧前长按屏幕,则最终停止在第10帧;若在动画播放到第10帧或以后点击屏幕,则停止在当前帧。使用一个全屏的button区域作为触发区域。

 

遮罩-Mask

 

功能概述

该功能需要与Image共同使用,对Image标签中的图片(tgt.png)和mask标签中的图片(ori.png)进行混合,支持12种混合模式。例如,通过混合可起到遮罩效果,即按照ori图片对tgt图片进行裁剪,使tgt图片显示与ori图片重叠区域的内容。通过设置align参数,可以达到tgt图片移动但ori图片不移动的效果。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
src字符串必填src为遮罩图片的源地址
align字符串选填取值为absolute或relative。其中,absolute表示绝对位置,即ori图片不随着tgt图片移动而移动,
遮罩(Mask)x,y坐标为相对于屏幕左上角的坐标;如果为相对位置relative,则ori会随着tgt而移动,
遮罩(Mask)x,y坐标为相对于图片左上角的坐标。 默认情况下为relative。
xfermode字符串选填设置两张图片之间的混合模式,共提供12种混合模式供选择:clear(0),src(1),dst(2),src_over(3),
dst_over(4), src_in(5), dst_in(6), src_out(7),dst_out(8),src_atop(9), dst_atop(10), xor(11)。
可以通过输入字符串或者对应的数字编号来选择混合模式,默认为6

混合模式示例

 

 

应用示例

示例一:通过输入字符串来选择混合模式,同时采用绝对位置,当移动源图片时,遮罩图片不移动。

示例二:通过输入数字编号来选择混合模式,同时采用相对位置,当移动源图片时,遮罩图片跟随移动。

效果展示

 

图片混合-GroupImage

 

功能概述

基于Group标签,可以对组内的多张图片实现混合模式的效果。其中,Group作为容器,组内最后一张图片设置混合模式参数,用于对之前所有的图片进行一个混合操作(除最后一张图片外所有图片作为一个整体)。不支持Mask标签中的绝对位置方式。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
layered字符串必填true/false,是否开启图片混合功能;开启后会对Group中的图片进行混合操作
xfermode字符串必填图片混合模式,支持12种混合模式,具体参考Mask标签。

 

应用示例

示例一:该示例在Group标签种设置layered参数为true,开启了图片混合操作,并在最后一个Image标签中设置了xor混合模式。

 

几何图形-Geometrical figue

 

功能概述

在一些内存要求高的场景下,使用绘制几何图形的方式替代-Image以减小内存,目前支持矩形-Rectangle、圆角矩形-Rectangle、圆形-Circle、椭圆-Ellipse、扇形-Arc、弧线-Arc、直线-Line。

 

应用场景

 

XML规范

其余几何图形与Rectangle写法一致。

 

参数说明

通用属性

参 数类 型选 项注 释
x数值选填图形坐标点x坐标;Rectangle 为左上角坐标x坐标,直线为起点坐标x坐标,
其余的几何图形均为中心点坐标x坐标,默认为0,单位为像素,支持表达式
y数值选填图形坐标点y坐标;Rectangle 为左上角坐标y坐标,直线为起点坐标y坐标,
其余的几何图形均为中心点坐标y坐标,默认为0,单位为像素,支持表达式
strokeColor字符串选填描边颜色。支持6位或8位16进制颜色表示,如:#FFFFFF 、#FFFFFFFF,
8位中前两位表示透明度,后六位依次表示红、绿、蓝;支持函数argb(255,255,255,255)
(argb(透明度,红,绿,蓝),每个数值在[0-255]范围内);支持字符串变量,
如:@abc,字符串变量需为无#的6或8位16进制表示:"ffffff"、“ffffffff",或argb函数。默认黑色
fillColor字符串选填填充色,支持strokeColor中三种颜色表示。同时,支持通过变量动态改变填充颜色和
渐变填充色(FillGradient)。注意:在需要动态改变渐变填充色时需要先设置
@color="argb(0,0,0,0)+argb(15,5,5,5)+argb(25,3,10,0)",
并且此时FillGradient中颜色、位置依旧得设置,只是后期可以通过改变@color变量的值动态修改渐变色
weight数值选填描边宽度,自然数,默认0无描边,支持表达式
cap字符串选填线头形状,semicircle/square。semicircle(半圆), square(方形),不写表示无线头
dottedLine字符串选填虚线模式。格式“线长,间隔,线长,间隔….”。如dottedLine=”10,20,30,40”,表示10像素宽的线段,
20像素的间隔,30像素的线段,40像素的间隔,以上虚线重复出现构成几何图形描边。
注:至少两个参数

矩形与圆角矩形属性

参 数类 型选 项注 释
cornerRadius字符串选填矩形圆角半径,格式”x向半径,y向半径”,例如:"10,10",
半径为正整数,默认为0,单位为像素
w数值必填矩形宽,自然数,默认为0,单位为像素,支持表达式
h数值必填矩形高,自然数,默认为0,单位为像素,支持表达式

圆形属性

参 数类 型选 项注 释
r数值必填圆半径,自然数,默认为0,单位为像素,支持表达式

椭圆属性

参 数类 型选 项注 释
w数值必填椭圆宽,自然数,默认为0,单位为像素,支持表达式
h数值必填椭圆高,自然数,默认为0,单位为像素,支持表达式

扇形、圆弧属性

参 数类 型选 项注 释
w数值必填扇形所在椭圆的宽,自然数,支持表达式
h数值必填扇形所在椭圆的高,自然数,支持表达式
startAngle数值选填起始角,-360-360度,默认为0,时钟3点钟方向为0度,支持表达式
sweepAngle数值必填扫描角(扇形的角度),-360-360度,默认为0,起始角开始顺时针方向扫描角度,支持表达式
closure字符串选填true/false。true 表示闭合,绘制的是扇形;false 表示不闭合,绘制的是弧线。默认false

直线属性

参 数类 型选 项注 释
x1数值必填直线终点坐标x坐标,默认为0,单位为像素,支持表达式
y1数值必填直线终点坐标y坐标,默认为0,单位为像素,支持表达式

FillGradient 与 StrokeGradient

Linear

参 数类 型选 项注 释
x数值选填渐变轴线(x , y,x1 , y1),是参照图形的相对坐标x坐标,默认为0,单位为像素,支持表达式
y数值选填渐变轴线(x , y,x1 , y1),是参照图形的相对坐标y坐标,默认为0,单位为像素,支持表达式
x1数值选填渐变轴线(x , y,x1 , y1),是参照图形的相对坐标x1坐标,默认为0,单位为像素,支持表达式
y1数值选填渐变轴线(x , y,x1 , y1),是参照图形的相对坐标y1坐标,默认为0,单位为像素,支持表达式。
注意:x,y,x1,y1不可同时全为0
tileMode字符串选填线性渐变平铺模式。stretch :渐变色在几何图形中沿渐变轴拉伸渐变(默认);mirror :
渐变色以abbaab...镜像模式沿渐变轴渐变;loop:渐变色以ababab... 循环模式沿渐变轴渐变

Radial

参 数类 型选 项注 释
x数值选填圆心位置x坐标,是参照图形的相对坐标,默认为0,单位为像素,支持表达式
y数值选填圆心位置y坐标,是参照图形的相对坐标,默认为0,单位为像素,支持表达式
r数值选填半径,取值正整数,默认10,单位为像素,支持表达式
tileMode字符串选填放射渐变平铺模式。stretch :渐变色在几何图形中从圆心向外拉伸渐变(默认);
mirror :渐变色以abbaab...镜像模式从圆心向外重复渐变;
loop:渐变色以ababab... 循环模式从圆心向外渐变

Sweep

参 数类 型选 项注 释
x数值选填中心点坐标x坐标,是参照图形的相对坐标,默认为0,单位为像素,支持表达式
y数值选填中心点坐标y坐标,是参照图形的相对坐标,默认为0,单位为像素,支持表达式

GradientPoint

渐变子标签,用于设置渐变颜色和渐变位置。

参 数类 型选 项注 释
color字符串必填渐变点的颜色,支持6位或8位16进制颜色表示,如:#FFFFFF 、#FFFFFFFF,
8位中前两位表示透明度,后六位依次表示红、绿、蓝;
支持函数argb(255,255,255,255) (argb(透明度,红,绿,蓝),每个数值在[0-255]范围内);
支持字符串变量,如:@abc,字符串变量需为无#的6或8位16进制表示:"ffffff"、“ffffffff",或argb函数。
position数值必填渐变点位置,0~1.0的小数

注意:

1.有面积的几何图形可同时设置描边和填充的颜色或渐变,线条类几何图形只支持设置描边;

2.若fillColor/strokeColor与FillGradient/StrokeGradient同时存在,则绘制FillGradient/StrokeGradient;

3.位移、透明度等动画需要写在渐变方式之前,否则无法解析到。

 

应用示例

示例一:圆角矩形。圆角矩形左上角坐标为(10,20),宽100,高200,描边宽度为5,右下角坐标为(10+100+52, 20+200+52)=(120,230)。填充渐变以填充矩形的左上角为坐标原点,(0,0)->(100,200)即填充矩形左上角到右下角的直线为线性渐变轴实现颜色线性变化。

 

示例二:椭圆。椭圆圆心坐标为(100,400),x轴半径为rx=50,y轴半径为ry=100,描边宽度为weight=5。放射渐变的圆心坐标为(rx+weight, ry+weight) = (55,105),放射渐变的圆半径为60。

示例三:圆形。圆心坐标为(600,200),圆半径为50,描边宽度为weight=5,扫描渐变的中心坐标为(r+weight, r+weight)=(55,55)。

示例四:扇形。扇形所在椭圆的圆心为(400,200),x轴半径为100,y轴半径为200,closure设置为true。以时钟3点钟方向为起始0°角,角度小于0位逆时针方向,角度大于0位顺时针方向,所以startAngle=-10,sweepAngle=50为截取椭圆上逆时针10°开始扫描角度为50的扇形区域。渐变中心点计算与椭圆一致。(扇形描边宽度不宜设置过大)。

示例五:弧线。当closure设置为false时绘制的即为示例四中扇形的弧线边。

示例六:直线。

示例七:动态修改填充渐变色。首先声明@color变量,变量类型为string,@color变量中多个颜色以+号拼接,颜色个数需要与渐变颜色个数相等。动态修改渐变color需要先给fillColor参数设置为@color变量,并在GradientPoint中赋予初始渐变色。在运行过程中通过button改变@color值已达到动态修改填充。

 

路径解析-PathUtil

 

动效概述

路径解析工具是对一段命令描述的路径字符串进行解析,实际是解析SVG路径。跑马灯动效(标签Marquee)可以通过pathname调用该路径,实现按照路径跑马灯的效果,注意跑马灯标签应该在该标签之后。路径指令中大写字母表示绝对位置,小写字母表示相对位置。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
name字符串必填路径名称
path字符串必填路径的SVG指令描述,其中Path中以命令标志开头后接命令规定数量的参数。命令与参数之间可以用空格、
逗号也可以没有任何字符分割,参数与参数之间用空格、逗号或者换行来分割。

path svg指令说明

指 令参 数注 释
M,mx,y该命令将绘制点移动至(x,y)点开始绘制
L,lx,y从路径当前绘制点绘制直线到(x,y)点,并将绘制点移动到(x,y)点
H,hx从路径当前绘制点绘制横线到x位置,并将绘制点移动到(x,y)点
V,vy从路径当前绘制点绘制竖线到x位置,并将绘制点移动到(x,y)点
Z,z路径闭合参数,将当前绘制点与M指令的起始绘制点连接一条直线
Q,qx1,y1,x,y从路径当前绘制点绘制二次贝塞尔曲线至(x,y)点,控制点为(x1,y1),并移动绘制点至(x,y)
T,tx,y从路径当前绘制点绘制二次贝塞尔曲线至(x,y)点,并移动绘制点至(x,y)。
若前一个指令为Q或T,控制点为前一个控制点关于前一个指令终点的对称点,
若前一个指令不为Q或T,则控制点与终点相同
C,cx1,y1,x2,y2,x,y从路径当前绘制点绘制三次贝塞尔曲线至(x,y)点,控制点1为(x1,y1)控制点2为(x2,y2),
并移动绘制点至(x,y)
S,sx2,y2,x,y从路径当前绘制点绘制二次贝塞尔曲线至(x,y)点,并移动绘制点至(x,y)。若前一个指令为C或S,
控制点1为前一个控制点2关于前一个指令终点的对称点,若前一个指令不为C或S,则控制点1与控制点2相同
A,arx,ry,x-axis-rotation,
large-arc-flag,sweep-flag,x,y
弧形命令A的前两个参数分别是x轴半径和y轴半径,弧形命令A的第三个参数表示弧形的旋转情况,
large-arc-flag(角度大小) 和sweep-flag(弧线方向),large-arc-flag决定弧线是
大于还是小于180度,0表示小角度弧,1表示大角度弧。sweep-flag表示弧线的方向,
0表示从起点到终点沿逆时针画弧,1表示从起点到终点沿顺时针画弧

基础图形指令

在SVG指令基础上新增圆角矩形、弧线(椭圆)、圆形、爱心基础图形的解析,与上述指令不可同时使用:

指 令参 数注 释
Rectleft,top,right,
bottom,rx,ry,direction
绘制矩形,left,top,right,bottom表示矩形的左(x)、上(y)、右(x)、下(y);
rx,ry表示矩形圆角的x,y轴半径;direction为0表示路径为顺时针,1表示逆时针
Circlex,y,r,direction绘制圆形,x,y表示圆心坐标;r表半径;direction与矩形一致;
Arcleft,top,right,bottom,
startAngle,sweepAngle
绘制圆弧,left,top,right,bottom表示绘制的椭圆所在矩形的左(x)、上(y)、右(x)、下(y);
startAngle表示弧线绘制的起始角度;sweepAngle表示绘制弧线的角度。
起点为矩形右边中点位置,顺时针方向。
Love绘制爱心,爱心左上角坐标为(200,130),w=200,h=170

 

应用示例

示例一:生成左上角坐标为(200,130),w=200,h=170的爱心路径,路径的name为love,其中跑马灯可以用pathname属性来引用。

示例二:生成左边x坐标为0,顶部y坐标为0,右边x左边为100,底部y坐标为100,圆角的x和y的半径都为15的圆角矩形路径。

示例三:以x坐标100,y坐标100,生成一个半径为100的圆形路径。

示例四:以左边x坐标100,顶部y坐标100,右边x坐标300,底部y坐标400生成一个椭圆,其中椭圆的y方向轴为300,x方向轴为200。生成一个沿着椭圆,从最右边点开始,以矩形中点为旋转中心,顺时针360度的路径。

示例五:沿着Path的规划绘制相关的路径,其中c是按照三次贝塞尔曲线连接并移动绘制点,Z是封闭路径的绘制点和初始绘制点,M是移动绘制点并设置成初始绘制点。 该条路径是抠图后由GIMP软件生成路径得到的“新年快乐”四个字描边路径。

跑马灯-Marquee

动效概述

跑马灯功能,需要和路径解析-PathUtil联合使用,可实现屏幕跑马灯、心形、椭圆形等跑马灯效果。

 

XML规范

 

参数说明

参 数类 型选 项注 释
state数值选填是否开启跑马灯,当值等于1时可见,其余值为不可见状态,默认为1,支持数字表达式
showTime数值选填跑马灯执行一次旋转位移的时间间隔,单位毫秒(ms),正整数,默认20ms,支持数字表达式
deltaAngle数值选填跑马灯一次旋转位移的旋转角度,单位为度,范围建议为-360~360,其中正值为顺时针旋转,负值为逆时针旋转,可与showTime配合控制跑马灯跑动速度,默认为5°,支持数字表达式
pathname字符串必填路径名称,依赖于PathUtil,首先得通过PathUtil解析路径,跑马灯的路径为PathUtil中的路径,参数值为路径PathUtil的名称
scaleX数值选填对路径宽度进行缩放,scaleX是x轴的缩放倍数。缩放时以路径外接矩形的左上角为中心点,例如路径为一个宽高均为100的矩形,左上角坐标为(100,100),右下角坐标为(200,200),scaleX为2,则放大后矩形左上角仍为(100,100),右下角为(300,200)。取值为大于0的实数,默认1,支持表达式
scaleY数值选填对路径宽度进行缩放,scaleY是y轴的缩放倍数。缩放时以路径外接矩形的左上角为中心点,例如路径为一个宽高均为100的矩形,左上角坐标为(100,100),右下角坐标为(200,200),scaleY为2,则放大后矩形左上角仍为(100,100),右下角为(300,200)。取值为大于0的实数,默认1,支持表达式
translateX数值选填对path进行x轴偏移,单位为像素,默认0,支持表达式解析。大于0,向右移动;小于0,向左移动
translateY数值选填对path进行y轴偏移,单位为像素,默认0,支持表达式解析。大于0,向下移动;小于0,向上移动
rotate数值选填对PathUtil的path路径进行旋转的角度,以路径外接矩形的左上角点为旋转中心,单位为度,取值范围为-360~360
weight数值选填绘制路径的宽度,单位为像素,正整数,默认15像素,支持表达式
color字符串必填跑马灯渐变的背景颜色,支持6/8位十六进制颜色表示、变量、argb函数,如#ffffff,#ffffffff,@abc, argb(255, 255, 255, 255), 若@abc字符串为16进制颜色表示则不可包含#号,如ffffff
marqueeColor字符串必填跑马灯渐变的灯颜色,支持6/8位十六进制颜色表示,变量、argb函数。其中颜色渐变为设置的color的颜色到marqueeColor的颜色产生一个线性的颜色过渡
marqueePos数值选填跑马灯颜色渐变位置控制,颜色渐变点,其值为0~1之间的小数,表示color与marqueeColor颜色渐变位置,默认0.3,支持表达式

 

应用示例

示例一:心形跑马灯

示例二:圆形跑马灯

示例三:云朵形跑马灯

视图组-Group

 

功能概述

Group作为一个若干子控件元素的视图组,可以包住他元素,子控件元素比如图片Image、按钮Button、文字Text、时间DateTime等元素。 视图组内可以调整坐标以及宽与高,亦可以调整多个元素的位置和大小;此外Group可以添加各种基础动效动画,比如位移PositionAnimation、旋转RotationAnimation、透明度AlphaAnimation、缩放SizeAnimation等。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
name字符串选填组控件的名称
x数值选填相对于屏幕左上角的x坐标
y数值选填相对于屏幕左上角的y坐标
w数值选填容器宽
h数值选填容器高
alpha数值选填透明度,0-255,小于等于0不显示
rotation 或(angle)数值选填旋转角度,一周360度
visibility数值选填元素可见性,支持表达式<=0 不可见, >0可见,true为可见,false为不可见
clip字符串选填缺省为false;裁剪设置true则是测量整个Group长宽而不是测量元素的长宽,
会裁剪掉超出w h标注范围的内容,不给予显示;设置为false测量元素的大小。
layered字符串选填分层,设为true时,如可以对多图片进行混合处理,这个时候group中的最后一个Image
需要具有hybridMode属性,前面的view都不能有hybridMode属性
align字符串选填水平方向对齐方式,默认为left,可选参数为left,center,right;使用时如果子view有自身的x坐标,
则不会受Group设置的align参数影响,即子view的x坐标优先级大于Group的align参数。
alignV字符串选填垂直方向对齐方式,默认为top,可选参数为top,center,bottom;使用时如果子view有自身的Y坐标,
则不会受Group设置的alignV参数影响,即子view的y坐标优先级大于Group的alignV参数。

 

应用示例

示例一:将多张图片组合在一起同时控制展示。

示例二:将2张图片组合在一起进行位移和旋转的组合动画。

 

虚拟屏幕-VirtualScreen

 

功能概述

虚拟屏幕允许一系列的View的复用,虚拟屏幕给一系列的View提供了容器,减少设计师的工作量。

 

XML规范

 

参数说明

参 数类 型选 项注 释
name字符串必填虚拟屏幕的标注,Image的src属性调用的名称

注意其中Image标签的src属性的值是被调用的VirtualScreen的标签name的值,其可以将一系列的元素重复使用; 如果使用自定义宽高的虚拟屏幕,需要在使用虚拟屏幕的标签上同时填写宽高限制。

 

应用示例

示例一:将多张图片同时控制在虚拟屏幕中展示;注意:Image标签的宽、高会设置为虚拟屏幕的宽和高,绘制起点的坐标为Image标签的x和y。

 

控件

按钮-Button

 

功能概述

按钮标签,在锁屏界面有一块显示区域,能够触发Trigger等一系列的操作和命令,可以通过不同的状态标签来展现对应状态下设置的图片或者文字等。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
name字符串选填按钮的名称
visibility字符串选填元素可见性支持表达式<=0 不可见 >0可见
longTouchTime数值选填单位毫秒,设定时间,在长按时间超过一定时间的时候触发Trigger action="long"的命令,
默认1000ms
interceptButtonTouch字符串选填判断Button是否已经被触发,若interceptButtonTouch为true,则Button仅能够被触发一次
Trigger字符串必填用来定义按钮、Unlocker、Slider等动作引发相关的操作,可以控制某元素的属性。
其规定了触发的动作(action),并且触发了一系列命令(Command)的执行
Normal字符串选填表示按钮在正常状态时显示的内容,可加入Image,Text,SourceImage,Time,
DateTime,ImageNumber,Group
Pressed字符串选填表示按钮在按下状态时显示的内容,可加入内容与Normal相同,
区别是Button在正常状态的时候是非激活以及不可见状态。当按钮被按下的时候,
Normal状态下的元素都被设置非激活和不可见,而Pressed状态下的元素都设置为激活和可见

Trigger的属性

参 数类 型选 项注 释
action字符串必填按钮动作: down (按下), up (抬起), double (双击),resume(亮屏触发),pause(熄屏触发),
long(长按),click(点击)

 

应用示例

示例一:正常状态下显示白色normal文字和小太阳图片,按下时触发Pressed且显示白色pressed文字和红心图片状态,松开时又恢复正常状态。

示例二:没点击按钮之前,按钮可见、text文本框显示"可见性:visibility为false,按钮不变";单击之后,单击按钮不可见、text文本框显示"可见性:visibility为true,按钮消失"。

 

滑块-Slider

 

功能概述

通过滑动来激活某些操作,Slider是一个滑动的命令,其规定了滑动的起始点(StartPoint)和结束点(EndPoint),包括滑动时的速度和加速度等参数的值。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
name字符串必填滑动组件的名称
bounceInitSpeed数值选填回弹动画的初始速度(距离单位为像素,时间单位为秒),支持表达式,最小100,默认值为0
bounceAcceleration数值选填回弹动画的加速度(距离单位为像素,时间单位为秒),支持表达式,最小10,默认值为0
keyPoint数值选填回弹点,可实现回弹多次的效果;默认值“0,0”即触发完回到开始效果。
另外:如“0,0.7,0,0.5,0,0.2,0” 表示逐渐回弹到原点
always字符串选填当always的值变为true或1时,表示仅仅只显示这个滑块,其他的滑块全部隐藏 ;
当always的值变为false或0时,表示所有的滑块全部显示出来
StartPoint字符串必填起始点标签,包括了x, y, weight, height坐标长宽以及Normal、Pressed、reached等状态的View
集合和声音文件,也包括了Intent相关操作。注意:每个Slider仅能包括一个StartPoint
EndPoint字符串必填结束点标签,其与起始点标签相同,但是Slider中可以有多个EndPoint
参 数类 型选 项注 释
x数值必填起始点相对于屏幕左上角的x坐标
y数值必填起始点相对于屏幕左上角的y坐标
w数值选填起始点响应区域的大小,宽
h数值选填起始点响应区域的大小,高
NormalState字符串选填正常状态标签,表示在非触摸时的状态
PressedState字符串选填按下状态标签,表示在点击区域按下开始触发的状态信息
ReachedState字符串选填到达状态标签,表示到达目标区域时的状态信息
Path字符串选填定义了Slider滑动允许的范围,滑动的范围位于Position的连线上面,Path中给予了Position一个基础值,
可以简单的认为是从Path定义的x加上Position的x,Path的y加上Position的y的两个Position之间的连线
normalSound字符串选填普通状态下播放的音效
pressedSound字符串选填解锁控件在press状态播放的音效

 

应用示例

示例一:Slider起始点:起始点中包含的元素都会跟随当前操作的拖动移动位置。三个状态都可以不指定,可以使用变量来改变其他界面元素状态来表示触发过程。

示例二:Slider目标点:当起始点的x,y点落入EndPoint目标区域矩形时,达到触发位置,此时松开手指即可以有mp3音乐播放并执行Intent中指定的打开相机动作。

示例三:Slider,其中包括了一个StartPoint和一个EndPoint, 回弹的初速度为2000,加速度为1000。起始点的横坐标为30,纵坐标由表达式确定的屏幕高度-120,宽度90,高度90,其中NormalState显示一张图片;同理EndPoint的坐标解释同上,在PressedState显示另一张图片,同时在EndPoint包括了解锁路径;

Path标签定义了EndPoint可以移动的范围,当手指丛EndPoint往左滑的时候其坐标为 x=30 y = #screen_height-120,当往右滑的距离超过了 360 – 30时,其坐标为x = 360 y = #screen_height-120,而在往右滑距离在0-330中间值得时候,其x = 30 + delaX, y = #screen_height-120。

 

解锁-Unlocker

 

功能概述

Unlocker是一个滑动解锁的命令,与滑动组件Slider用法类似,当起始点(StartPoint)的x,y点随手指移动落入EndPoint目标矩形区域时,松开手指则触发解锁。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
name字符串必填解锁控件的变量名,通过[name].move_y可以得到解锁部件在y轴的偏移量
bounceInitSpeed数值选填回弹动画的初始速度(距离单位为像素,时间单位为秒),都支持表达式,最小100,默认值为0
bounceAcceleration数值选填回弹动画的加速度(距离单位为像素,时间单位为秒),都支持表达式,最小10,默认值为0

StartPoint (EndPoint)的属性说明

参 数类  型选 项注 释
x数值必填起始点相对于屏幕左上角的x坐标
y数值必填起始点相对于屏幕左上角的y坐标
w数值选填起始点响应区域的大小,宽
h数值选填起始点响应区域的大小,高
normalSound字符串选填普通状态下播放的音效
pressedSound字符串选填解锁控件在press状态播放的音效
reachedSound字符串选填到达EndPoint所在区域时播放的音效
Path字符串选填定义了Slider滑动允许的范围,滑动的范围位于Position的连线上面,
Path中给予了Position一个基础值,可以简单的认为是从Path定义的x加上Position的x,
Path的y加上Position的y的两个Position之间的连线

 

应用示例

示例一:y轴滑动解锁,当用户触发解锁操作并处于起始区域时,播放sound_pressed.mp3音乐,当到达目标区域时,播放sound_reached.mp3音乐。

示例二:滑动到目标区域解锁,如果未达到目标区域则回弹到起始区域。

示例三:演示任意上滑解锁,当上滑距离在100-150像素之间解锁。

 

变量

自定义变量-Var

 

功能概述

用户自定义变量,其标签为Var,用户指定变量名称、变量类型和变量值等,并被放入到全局变量中,供其他功能或者表达式调用。数组变量是放入到全局变量中的,其索引名字为 数组名+[索引值],例如当name = sss时index=1,取变量sss[1]的值, 数组索引从0开始。对于不是数组的普通变量,type 的属性值不为number[] 或者string[] 即可,如果type为空默认为数字变量。

 

XML规范

 

参数说明

参 数类 型选 项注 释
name字符串必填变量名,也是全局变量的调用索引名,在支持表达式的情况中使用#+变量名来调用该变量目前的值。
expression表达式选填变量对应的表达式或常量 注意:如果定义字符串常量需要多一套单引号: expression="'my string'"。
type字符串选填定义数值变量或字符串变量,数字为number,字符串为string,如果是数字数组为number[],
Unlocker字符串数组为string[], 默认为"number"。
threshold数值选填阈值,当变量值的变化超过阈值时,可以触发一些命令。
persist字符串选填变量持久化;默认为true,开启变量持久化之后,会优先读取本地同名变量是否有值,
如果没有则赋予expression或者默认值,如果有值则会忽略设置的expression值。
index字符串选填如果使用数组型的变量则需要添加该项,标识数组的索引,索引值从0开始,index等于0代表值name[0]的取值。
values字符串选填格式为values="val, val, val, ..."。该参数会写入所有需要赋的值,然后自动计算数组变量的大小,
并且给每一个变量赋值。type类型不同,输出的值的类型也不同,例如:values="10,20",
type为number时,输出的值为10.0,20.0;type为string时,输出的值为10,20。
const字符串选填true或者false,变量值是否为常量,表示该变量只要被赋值一次之后其值就不会再改变,默认:false。

 

应用示例

示例一:变量的变量动画,设置name等于sss的全局变量在0~300ms内值从#ani_begin_x变化到0,然后一直保持不变。

示例二:演示设置阈值,当expression的值大于或等于阈值threshold时,则执行Trigger中的命令,设置图片的visibility属性为toggle。

数组变量

数组变量通过声明能够在全局变量中生成数组变量,方便循环操作,能够节省大量的开发者的时间。由于与变量的功能大致相似,所以将其集成在了-Variable的标签之中。

数组变量声明方法:

①声明同时给一个变量赋值

通过name来定义数组变量的名字,通过size去声明数组变量的容量。在使用数组变量之前,一定要先声明数组变量的容量大小。

其中number[]表示的是数字数组,将其换成string[]能够容纳字符串数组变量。其中index表示数组变量的索引,expression的结果为该索引数组变量对应的值。

②只声明不赋值

其中声明了一个name为sss的数组变量,其大小为4,数组的类型为数字,声明了const为true,表明在给变量赋初值之后便不能再改变。

③声明同时全部赋值

利用values写入所有需要赋的值,该类会自动计算变量数组的大小,并且给每一个变量赋值。

 

全局变量-GlobalVariable

 

功能概述

全局变量是指在引擎中已经预置好的固定名字的变量,可供直接使用,全局变量为放置在项目VariableManager中的一系列全局变量,在整个项目的任意位置都能够调用获取最新的全局变量的值,使用#取数值,使用@取字符串。

 

应用场景

 

XML规范

变量说明

触摸

参 数注 释
touch_x当前触摸点的x坐标
touch_y当前触摸点的y坐标
touch_begin_x按下屏幕时的初始x坐标
touch_begin_y按下屏幕时的初始y坐标
touch_begin_time触摸开始的时间,单位ms,是当前时间与协调世界时 1970 年 1 月 1 日午夜之间的时间差
touch_pressure按屏幕的压力值【需要设备支持,和厂商适配】,该参数需要生效,必须在lockscreen标签下写入pressure="true"

解锁

参 数注 释
name.move_x解锁部件在x方向的偏移
name.move_y解锁部件在y方向的偏移
name.move_dist解锁部件移动的距离
name.state解锁部件的状态:NORMAL_STATE(0),PRESSED_STATE(1),REACHED_STATE(2),INVISIBLE_STATE(3)

时间/日期

参 数注 释
time当前时间毫秒值
year
month月(取值范围是0~11,0表示一月,1表示二月,以此类推)
date
day_of_week星期(1表示星期日,2表示星期一,等等)
hour当前小时,显示24小时制
hour1212小时制小时数,显示与系统时间制一致
hour2424小时制小时数,显示与系统时间制一致
minute分钟
second
ishour12字符串类型,是否是12小时制(true,false)
lunarYear农历年
lunarMonth农历月
lunarDay农历日
time_sys系统时间,时间格式为 yyyy-MM-dd hh:mm:ss:SSS
system.time.hour1小时的第一位,例如09:00显示0,时间在12小时制12点显示1,24点显示0
system.time.hour2小时的第二位,例如09:00显示9,时间在12小时制12点显示2,24点显示0
system.time.min1分钟的第一位,例如09:30显示3
system.time.min2分钟的第二位,例如09:30显示0
system.time.ampmampm显示,根据不同的区域和语言显示不同的结果。该值当ishour12为true时才有值显示,为false时显示为空
system.date日期格式化显示,根据不同的区域和语言显示不同的格式和语言的日期

电量

参 数类 型注 释
battery_level数值当前电量,1~100
battery_state数值电池的状态,“Normal”(0),“Charging”(1),“BatteryLow”(2),”BatteryFull“(3)

系统深色模式

仅支持获取系统深色模式设置状态,并根据该状态进行显示效果的适配,不支持通过命令改变系统深色模式设置状态。

参数类型注释
darkMode数值当前模式:1 浅色模式 ,2 深色模式 ,0 不支持任何模式

音乐时长/进度

参数类型注释
musicTotalDuration字符串获取当前播放音乐的总时长,形式为分:秒,如 04:52
musicPlayDuration字符串获取当前音乐播放进度,形式为分:秒,如 02:30
musicTotalSecond数值获取当前播放音乐的总时长,形式为秒,如 650
musicPlaySecond数值获取当前音乐播放进度,形式为秒,如 180

幕宽高

参 数类 型注 释
screen_width数值屏幕宽度
screen_height数值屏幕高度

图片宽高

参 数类 型注 释
name.actual_w数值图片实际宽度
name.actual_h数值图片实际高度

文本宽高

参 数类 型注 释
name.text_width数值文本的宽度,name为文本功能中指定的name,例如:-Text name="a" text="hahaha" size="50"/,可通过a.text_width取得a文本的文本宽度
name.text_height数值文本的高度

组件

其中的name都为组件的名字。

参 数类 型注 释
name.visibility数值组件的可见性,1为可见
name.actual_x/name.actual_y数值元素实际x/y坐标
name.actual_w/name.actual_h数值元素实际高度与宽度

日历基本数据

参 数类 型注 释
festival数值[0~21] ,国家法定节假日具体映射关系如下表。说明同一天是双节假日的,返回唯一假日那个值,
例如2020-10-01,中秋节 国庆节同时一天,返回中秋节,其他2号~8号返回国庆节。
is_work_day布尔值true:国家法定工作日;false: 国家法定休息日。

 

应用示例

示例一:触摸屏幕时会显示它的坐标、压力。

示例二:获取系统的日期、时间、一周中的第几天、12和24小时制、时分秒、是否为12小时制。

示例三:读取显示节假日和工作日、休息日。

 

变量数组-VarArray

 

功能概述

以数组的方式来保存变量;根据index值能够取相应索引的值并且显示。

 

应用场景

通过此功能获取月份、农历等信息,可以制作日历。

可用于在界面上显示英文月。

 

XML规范

 

参数说明

参 数类 型选 项注 释
type字符串选填定义数值变量number或字符串变量string,默认为number;
name字符串必填变量名,可以通过@name来返回字符串数组中index指定序号的变量值,返回为字符串无法用作计算
index表达式选填变量数组中的序号,从0开始,支持表达式。注意点:Item中的顺序决定了index的取值
value字符串选填变量数组的值,可以是字符串,也可以是数字

 

应用示例

示例:显示英文月份,建立一个名字为month_str的string数组,把十二个月份的英文加入到数组中,并把数组输出指定到全局变量month,这样使用@month_str得到 的就是当前月份的英文字符串。

 

控件数组-Array

 

功能概述

能够同样重复多条目的生成图片Image、文字Text等界面控件。

注意:在该控件中使用Text控件,需使用texEmp的方式获取数组中文本数据,如下面XML规范及用例中所写。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
indexFlag字符串必填代表索引的名称,能够在下方的元素中引用
frequency表达式必填表示重复生成元素的次数

上面的xml表示生成了一个TextView,其中内容还有x、y等位置都通过index来确定。

注意:indexFlag的数值从0开始到frequency-1 为止,其中#__i的值为目前循环的数值。

 

应用示例

示例一:元素数组能够与变量和周期命令结合共同调控。

声明了一个大小为100的变量数组但是并没有赋予初值,并且设置了参数const为true,代表变量只能被赋值一次。元素数组循环生成了100个不同的Text,其中textExp、x、y都是由其中的表达式和目前循环的次数计算得到。由于名字为find的数组没有赋予初值,所以目前没有任何显示。按下button之后,周期命令循环给find[index]变量赋值,并且通知到响应的Text,刷新最新的值。

 

表达式

数字表达式-Expression

 

功能概述

支持数值型表达式的解析,对写在参数中的表达式能够进行全局变量取值和计算,返回值是一个浮点型的数值。并且能够实时监听使用的全局变量,当全局变量变化的时候,能够实时修改该表达式的值。并且支持逻辑运算,数学计算,字符串操作等一系列的函数。数字表达式中参数只能够嵌套数字表达式中包含的函数、数值型变量、数值和其组成的表达式。当数值表达式解析的数值超过7位时会有精度问题,建议数值范围在7位及以内。其他功能点中类型为数值且支持表达式的参数可以调用数字表达式解析功能。

 

应用场景

可控制图片可见性,比如点击屏幕多少次,就切换壁纸;或者长轴图片的位移动效,制作出全景的效果等。

可实现视频的播放与停止,到一定的条件下,播放,否则停止。

 

XML规范

支持加减乘除取模括号和函数

表达式注 释
digit(x)取给定数字的第几位,顺序为倒序从右往左,并且索引从1开始。例如digit(12345, 2) = 4 ,digit(12345, 1) = 5
round(x)对输入的值四舍五入取整。负数时,小数点后<=0.5时向右取整,小数部分>0.5,则向左取整,例如round(4.5)=5, round(-4.5)=-4
int(x)舍弃掉小数部分,例如int(4.5)=4, int(-4.5)=-4
rand()取0到1之间的随机数,返回值为float。rand()在文本format属性中使用时,例如format="rand()=%d",rand()的值是0;rand()*10的值是0~9之间的随机整数,其中%d表示取整。
int(rand()*a+b)得到的是b到b+a之间的随机整数
eq(x,y)条件判断,x是否与y相等,当x、y相等时,此表达式值为1,否则为0。x,y都可以为表达式,下同。
ne(x,y)条件判断,x是否与y不相等,当x、y不相等时,此表达式值为1,否则为0
ge(x,y)条件判断,x是否大于等于y,当x大于等于y时,此表达式值为1,否则为0
gt(x,y)条件判断,x是否大于y,当x大于y时,此表达式值为1,否则为0
le(x,y)条件判断,x是否小于等于y,当x小于等于y时,此表达式值为1,否则为0
lt(x,y)条件判断,x是否小于y,当x小于y时,此表达式值为1,否则为0
isnull(x)条件判断,是否变量没有值,如果没有值返回1,有值返回0。x为全局变量,用于判断绑定的变量是否查到数据,例如:isnull(#var)或者isnull(@var)
not(x)条件判断,x是否等于0,若等于0则返回1,如果不等于0则返回0
ifelse(x,y,z)条件判断,如果x大于0,则返回值为y,否则返回值为z
ifelse(x1,y1,x2,y2,...,z)if x1 > 0 return y1; else if x2 > 0 return y2; ... ; else return z。循环条件判断,如果x1大于零则返回y1,否则判断如果x2大于零则返回y2,否则判断xn是否大于零,如果大于0返回yn,否则返回z。至少有三个值x1,y1,z来完成整个条件的判断。如果在前面的返回中没有返回值,则最终返回最后一个值。
pow(x,y)幂方函数,表示x的y次方的值,例如pow(2,3)=8
len(数字)给定数字的数字的个数,例如len(1234)=4,len(-123.123)=6
strIsEmpty(str)字符串是否为空,为空返回1,不为空返回0,支持字符串表达式
strIndexOf(str1,str2)字符串str2在字符串str1中第一次出现的位置,返回首次出现位置的索引,索引从0开始,不存在返回-1,支持字符串表达式
strLastIndexOf(str1,str2)字符串str2在字符串str1中最后一次出现的位置,返回末次出现位置的索引,索引从0开始,不存在返回-1,支持字符串表达式
strContains(str1,str2)str1中是否包含str2,包含返回1,不包含返回0,支持字符串表达式
sin(x)三角函数正弦值,x为弧度值,返回sin(x)的值
cos(x)三角函数余弦值,x为弧度值,返回cos(x)的值
asin(x)反三角函数,当x为[-1, 1]时返回区间为[-pi/2,pi/2]的值,如果输入的绝对值超过1,返回的是0
acos(x)反三角函数,当x为[-1, 1]时返回区间为[-pi/2,pi/2]的值,如果输入的绝对值超过1,返回的是0
tan(x)正切值,返回x的正切值,当x的绝对值趋近pi/2的倍数可能因为精度问题导致不正常值
atan(x)反正切值,返回x的反正切值
sqrt(x)开平方函数,x为正数,如果输入x为负数则返回结果是0
abs(x)返回一个数的绝对值
min(x, y)返回x和y中的最小值
max(x, y)返回x和y中的最大值

 

应用示例

示例一:表达式解析计算,t1变量值为3,计算公式为(10+2*3)/4,最终结果为4。

示例二:数学公式计算,返回数值1.5的正弦余弦正切值。

示例三:条件判断,判断是否1大于0,结果返回为1。

示例四:条件判断,判断1是否大于0,最终返回2。

示例五:字符串函数,寻找字符串hello中的第一个e的位置,索引是从0开始,所以返回值为1。

示例六:数字表达式中嵌套数字表达式,判断字符串变量a中e首次出现的位置是否小于3,此时返回值为1。

 

字符串表达式-StringExpression

 

功能概述

支持字符型表达式的解析,相比于数值型的表达式,其返回值为字符串型,不能够作为数值进行计算,只能作为字符串相关的函数的参数,字符串表达式的主要功能提供了不同的操作字符串的功能。字符串表达式内只能嵌套字符串表达式的函数、字符串、字符串变量、数值型变量。其他功能点中类型为字符串且支持表达式的参数可以调用字符串表达式解析能力。

 

应用场景

可实现不同的节日显示对应的图片。

 

XML规范

表达式注 释
substr(原字符串,字串开始位置,字串长度)返回字符串的子串,substr('你好呀',1,2) = '好呀'(注意:字符位置是从左至右,索引从0开始)
strIsEmpty(str)字符串是否为空,即“”,为空返回“true”字符串,否则返回“false”字符串。 例如:strIsEmpty(@abc) ,str可以是字符串、字符串变量、字符串函数,下同
strIndexOf(str1,str2)字符串str2在字符串str1中首次出现的位置,索引从0开始,例如:strIndexOf('hello','he')=0,返回“0”,如果目标字符串没有出现则返回“-1”
strLastIndexOf(str1, str2)字符串str2在字符串str1zhong 最后出现的位置,索引从0开始,例如:str_LastIndexOf('hello','l')=3,返回“3”,如果目标字符串没有出现则返回“-1”
strContains(str1,str2)字符串str1中是否包含字符串str2,包含则返回"true",否则返回"false"。例如: strContains('hello','he')=true ,返回"true"
strReplaceAll(str1,str2,str3)将str1中所有的str2替换为str3 ,例如(strReplaceAll('hello','e','i')=”hillo“
preciseeval(str,数值/数值型变量)计算str的值,其中第一位是字符串/字符串变量型/数字表达式函数的计算公式,第二位为数值/数值型变量标识保留的小数位数,例如: preciseeval('1/3',3)=0.333,返回数值字符串“0.333”。注意使用preciseeval运算符则其后不能使用其他的运算符和+连接符
formatDate('format',@time_sys)返回指定格式的时间字符串,时间为此刻的系统时间,如:formatDate('yyyy-MM-dd hh:mm:ss',@time_sys)=“2019-08-23 19:15:10”,具体能够转换的时间和日期的格式可以参考系统日期占位符
plus(a,b)返回a和b的和的整数值,其中a和b可以为字符串/字符串变量或者数值/数值变量/返回数值的字符串函数,例如:plus(3,3)=6,返回“6”
ifelse(x1,y1,x2,y2,...,xn,yn,z)if (x1!=0) return y1; elseif(x2 !=0) return y2;...; else return z。从x1开始判断,若存在xi不等于0,则返回yi,否则一直往后判断,都不满足条件则最终返回z。xi为数字表达式,yi、z为返回的字符串结果,可以是字符串/字符串变量/字符串函数
+用以拼接字符串,如#year+'/'+#month+'/'+#date,其中字符串必须使用单引号标明

 

应用示例

示例一:字符串与变量混合拼接,取数值和字符串变量值并且拼接,如果20191001,该文本输出为2019/10/01。

示例二:substr字符串函数使用,截取字符串子串。

示例三:preciseeval字符串函数使用,计算字符串的值并保留指定小数位数。

示例四:格式化日期,显示当前时间小时和分钟时间会根据12小时或者24小时调整,如果当前是12小时制下午九点整则会显示09:00,24小时制会显示21:00。

示例五:字符串包含,检测字符串a中是否包含字符串“10”,结果是不包含,返回字符串false。

示例六:argb函数使用,解析透明度和红绿蓝三原色的值,最终返回8位16进制颜色表示字符串。

示例七:strIsEmpty函数使用,判断字符串是否为空串。

示例八:ifelse函数使用,条件判断。

示例九:plus函数使用,实现加法功能。

 

命令

基础命令-Command

 

功能概述

基础命令,通过对象名和对应的属性来控制界面中的元素。常见是控制元素的可见性(visibility)和动画播放(animation)。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
target字符串必填对象name的名字(如控制对象-Image name="image1"/),
“.”后面跟的是属性(目前支持visibility和animation)
value字符串必填控制可见性visibility时,value为”true”, “false”或“toggle”,分别代表可见、
不可见以及反转可见性;控制动画animation时,value为”play”或”stop”,控制动画的播放和暂停
condition表达式选填条件判断,支持表达式。当condition里的条件判断为非0或者为true时,该命令执行,
为false或者0则不执行
delay数值选填延迟,以ms毫秒记。延迟delay毫秒后执行该命令
delayCondition表达式选填延迟判断,为真则delay命令生效,否则失效。默认为true或者1时,表示可以延迟启动命令,
如果false或者非1则不延迟执行

 

应用示例

示例一:控制动画播放、暂停或图片可见、不可见。

 

声音命令-SoundCommand

 

功能概述

声音命令,用来控制播放音频文件;注意:声音文件的大小要求不超过500kB,时长不超过10秒。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
sound字符串必填声音文件路径名
volume数值必填正浮点数,声音大小,0~1的一个浮点数。数值越大,音量越大,不支持表达式
loop字符串选填是否循环播放,true/false,默认是false,不支持表达式
keepCur字符串选填播放此音频时,是否保持当前正在播放的声音,true/false,默认false。
只有当同时播放的音频数量大于系统最大值时才暂停优先级低的音频数据

 

应用示例

示例:控制循环播放reached.mp3,同时不停掉正在播放的其他声音。

 

可见性命令-VisibilityCommand

 

功能概述

除了在基础命令command中通过target的visibility属性来控制对象的可见性外,还支持在图片、文本等对象中配置visibility参数来控制对象可见性。

 

应用场景

每次点击屏幕,可显示不同的图片,比如多壁纸切换,漫画连载等。

可根据时间,实现屏幕黑白模式。

 

XML规范

 

参数说明

参 数类 型选 项注 释
visibility表达式必填用于设置对象可见性,为true、>0则可见,为false、<=0不可见,支持表达式

 

应用示例

示例一:通过自定义变量控制文本或图片可见、不可见。

 

Intent命令-IntentCommand

 

功能概述

通过IntentCommand命令,可以跳转打开其他应用程序App。

说明:除安全相机外,其他要记得加上解锁命令,否则只是在后台打开了,还要解锁才能看到。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
action字符串必填intent的action(参考应用示例)
category字符串选填intent需要设置的category(参考应用示例)
package字符串必填intent需要设置的的包名(参考应用示例)
class字符串必填intent需要设置的类名(参考应用示例)
condition表达式选填条件判断,支持表达式。当condition里的条件判断为非0或者为true时,该命令执行,
为false或者0则不执行
delay数值选填延迟,以毫秒记。延迟delay毫秒后执行该命令
delayCondition表达式选填延迟判断,为真则delay命令生效,否则失效。默认为true或者1时,表示可以延迟启动命令,
如果false或者非1则不延迟执行

 

应用示例

示例:列举常见App启动的action、package、class、IntentCommand 。

 

视频命令-VideoCommand

 

功能概述

VideoCommand:控制视频的播放停止、替换视频源、控制视频播放声音等一系列功能;

注意:其中声音与播放只能同时实现一个,只有在没有控制声音的参数时,才能使用play参数。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
name字符串必填所控制的视频的标识
src字符串必填需要替换的视频的资源地址
play表达式必填控制视频的播放或者停止
sound表达式选填控制视频播放的声音,支持0~1的一个浮点数;数值越大,音量越大。
也支持有音量为true,无音量为false

 

应用示例

示例一:循环播放sp1视频,按钮按下视频播放暂停即播暂停,按下视频播放即播放。

 

变量命令-VariableCommand

 

功能概述

变量命令,用来控制变量(Var)的值。包括name、expression和type三个特殊属性(用expression中的数据对name中的变量进行赋值),condition、delay、delayCondition的用法与Command一致。

 

XML规范

 

参数说明

参 数类 型选 项注 释
name字符串必填变量名
expression表达式必填对变量进行赋值时使用的表达式,支持常量赋值;
变量定义的时候不能用表达式(如#countNum+5)
type字符串选填标识是string类型变量还是number类型变量,默认为number类型
condition表达式选填条件判断,支持表达式。当condition里的条件判断为非0或者为true时,
该命令执行,为false或者0则不执行
delay数值选填延迟,以毫秒记。延迟delay毫秒后执行该命令
delayCondition表达式选填延迟判断,为真则delay命令生效,否则失效。默认为true或者1时,
表示可以延迟启动命令,如果false或者非1则不延迟执行

 

应用示例

示例:执行变量赋值命令。

 

通用命令-ExternCommand

 

功能概述

通用命令ExternCommand,用来向外部程序发送命令。目前仅能够支持解锁命令(仅在锁屏中有效)用这个命令可以实现解锁操作;ExternalCommand,与ExternCommand相对,是用来接收外部命令的命令,ExternalCommand是一种特殊的Command,不集成在-Trigger标签之下而是直接写在-Lockscreen标签之下,作为监测开关屏的命令。

 

XML规范

ExternCommand

ExternalCommand

 

参数说明

参 数类 型选 项注 释
command字符串必填命令名,目前可以使用的一种命令是解锁命令unlock(仅在锁屏中有效)
condition表达式选填条件判断该Command是否执行,支持表达式。仅当值为非0或者为true时,
该命令执行。为false或者0则不执行
delay数值选填延迟,单位ms。延迟delay毫秒后执行该命令
delayCondition表达式选填延迟判断,为真则delay命令生效,否则失效。默认为true或者1时,
表示可以延迟启动命令,如果false或者非1则不延迟执行

 

应用示例

示例一:解锁命令,执行该命令能够直接解锁锁屏。

示例二:在锁屏中,接收开屏/关屏命令,从而执行一些命令;在桌面插件中,用来检测切屏从而执行命令resume表示开屏时执行的命令,pause表示关屏时执行的命令。该示例在接受开屏信号之后,将name等于target的组件的动画启动,在关屏了之后,将目前的时间记录在pause_time变量里面。

 

命令组-GroupCommands

 

功能概述

支持常用自定义一组命令组复用,方便与简化重复定义。

 

应用场景

可对不同的图片元素进行不同的动画展示,比如云朵被风吹动,鸟儿在天空飞翔,花草在地上晃动……

 

XML规范

 

参数说明

参 数类 型选 项注 释
method字符串必填执行动作,缺省值"perform",目前暂无其他选项
paramTypes表达式选填传入执行动作参数的类型,缺省值"String",目前暂无其他选项
params字符串必填传入命令组中具体Trigger action名称

 

应用示例

示例:通过变量命令控制命令组内选项,来切换不同旋转动画。

 

周期命令-CycleCommand

 

功能概述

CycleCommand主要和控件数组Array配合使用,旨在通过一行代码周期性地执行多条VariableCommand命令,实现对数组变量的赋值,可以降低代码量。

 

XML规范

周期命令根据frequency或begin、end确定周期循环范围[0,frequency-1]或[begin,end],在每次循环时对数组索引变量indexFlag进行赋值,同时执行VariableCommand命令来对数组变量赋值。

 

参数说明

参 数类 型选 项注 释
indexFlag字符串必填索引变量标识,用来表示循环次数的变量名,
在VariableCommand的expression中会被引用
frequency数值必填控制周期命令执行次数,indexFlag索引变量取值范围是[0,frequency-1];
若设置frequency,则begin,end参数无效
begin数值选填indexFlag索引变量从begin开始循环;通过begin,end参数确定循环范围为[begin,end],
实现对索引变量的赋值
end数值选填indexFlag指定的变量到达end时终止计算
cycleCondition数值选填周期命令执行条件,当cycleCondition不为0时执行VariableCommand命令,
支持数值表达式

 

应用示例

示例一:与数组Array组合使用,实现在屏幕上格式化展现0-99这100个数字。Var标签定义名为find的数组变量#find[],数组大小为100;Array标签中实现对100个文本的textExp和坐标等赋值;当点击按钮时CycleCommand循环100次,使得indexFlag中的索引变量#col从0增至99;在每次循环时,变量命令将expression中的#col变量的值赋值给#find[#col]变量(即find数组中的第#col个元素),最终通过Array中Text显示在屏幕上。注意:VariableCommand与Var中的type定义为number[],表示find数组是整数数组。

示例二:通过begin,end参数实现对数组find[0]=0到find[99]=99赋值,是示例一中使用frequency参数实现的周期命令的另一种写法。

示例三:通过设置cycleCondition使得在屏幕上显示除20以外的0-99数值。设置cycleCondition=ne(#col,20),当#col不等于20时,ne(#col,20)=1,执行变量赋值命令,当#col等于20时,ne(#col,20)=0,#find[20]=20该变量命令不会执行,所以#find[20]变量为空值,最终屏幕中只会显示除20以外的0-99数值。

 

多语言

文本多语言-TextMultiLanguage

 

功能概述

该功能根据不同的语言设置来显示不同的文本,当手机语言切换的时候,脚本中文字也能跟随系统变换。在锁屏脚本目录下创建strings文件夹,里面添加支持的语言文件,英文strings.xml,简体中文strings_zh_CN.xml,繁体中文strings_zh_TW.xml等等。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
text字符串选填文字表达式,当系统语言改变时对应匹配系统语言,刷新文字。示例:
写成text="'@charging+#battery_level",展示中文时”充电中99“,英文时”charging99“;
text与textExp两个参数必须填写一个;无法与textExp共存,当存在textExp值时,文字使用textExp。
textExp字符串选填文字表达式,当系统语言改变时对应匹配系统语言,刷新文字。
示例:写成textExp="'@charging+#battery_level",展示中文时”充电中99“,英文时”charging99“。

 

应用示例

示例:首先在strings文件夹下创建支持的xml语言文件,然后在manifest.xml脚本中使用变量。

步骤一:strings.xml文件中是系统语言为英文时显示的文字格式。

步骤二:strings_zh_CN.xml文件中是系统语言为中文时显示的文字格式。

步骤三:直接在脚本中使用变量@charging,在充电状态下显示匹配系统语言的文字格式。

 

图片多语言-PicMultiLanguage

 

功能概述

该功能根据不同的语言设置来显示相应的图片,当手机语言切换的时候,脚本中文字也能跟随系统变换。也可以把字符串写入string.xml文件中当做变量使用,这样手机语言切换的时候,变量也跟随切换,把这个变量绑定到图片中,图片也能跟着语言切换。在锁屏脚本目录下创建strings文件夹,里面添加支持的语言文件,英文strings.xml,简体中文strings_zh_CN.xml,繁体中文strings_zh_TW.xml。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
srcExp字符串必填图片源表达式,使用字符串变量,当系统语言改变时字符串改变即刷新图片。
示例:srcExp="t1+@lang",中文时展示t1_ch.png,英文时展示图片t1_en.png。

 

应用示例

步骤一:首先在strings文件夹下创建支持的xml语言文件,然后在manifest.xml脚本中使用变量。

strings.xml文件中是系统语言为英文时显示的图片格式。

步骤二:strings_zh_CN.xml文件中是系统语言为中文时显示的图片格式。

步骤三:根据对应的中文图片t1_ch.png、英文图片t1_en.png,直接在脚本中使用变量@lang,就能显示匹配系统语言的图片。

 

数学曲线

变速函数-VarSpeedFun

 

功能概述

变速函数提供了数值的非线性变化能力,主要用于基础动画中,控制缩放大小、透明度值等按照非线性进行变化。使用方法:在动画中设置varSpeedFlag属性,它作用于设置varSpeedFlag的帧以及下一帧,支持30种函数类型。例如,在位移动画中可以利用变速函数来控制图片从起始位置移动到结束位置过程中的移动速率。

目前变速函数已支持动画有AlphaAnimation、PositionAnimation、RotationAnimation、SizeAnimation、VariableAnimation。

 

应用场景

 

XML规范

结合位移动画展示典型应用的XML规范,其他AlphaAnimation、RotationAnimation类似,不再赘述。

 

可填充在varSpeedFlag中的变速函数类型:

参 数类 型选 项注 释
SineFun_In字符串选填按照正弦曲线图呈现的效果缓入
SineFun_Out字符串选填按照正弦曲线图呈现的效果缓出
SineFun_InOut字符串选填按照正弦曲线图呈现的效果缓入缓出
QuadFun_In字符串选填按照二次方曲线图呈现的效果缓入
QuadFun_Out字符串选填按照二次方曲线图呈现的效果缓出
QuadFun_InOut字符串选填按照二次方曲线图呈现的效果缓入缓出
CubicFun_In字符串选填按照三次方曲线图呈现的效果缓入
CubicFun_Out字符串选填按照三次方曲线图呈现的效果缓出
CubicFun_InOut字符串选填按照三次方曲线图呈现的效果缓入缓出
QuartFun_In字符串选填按照四次方曲线图呈现的效果缓入
QuartFun_Out字符串选填按照四次方曲线图呈现的效果缓出
QuartFun_InOut字符串选填按照四次方曲线图呈现的效果缓入缓出
QuintFun_In字符串选填按照五次方曲线图呈现的效果缓入
QuintFun_Out字符串选填按照五次方曲线图呈现的效果缓出
QuintFun_InOut字符串选填按照五次方曲线图呈现的效果缓入缓出
ExpoFun_In字符串选填按照指数曲线图呈现的效果缓入
ExpoFun_Out字符串选填按照指数曲线图呈现的效果缓出
ExpoFun_InOut字符串选填按照指数曲线图呈现的效果缓入缓出
CircFun_In字符串选填按照圆形曲线图呈现的效果缓入
CircFun_Out字符串选填按照圆形曲线图呈现的效果缓出
CircFun_InOut字符串选填按照圆形曲线图呈现的效果缓入缓出
BackFun_In字符串选填按照超过范围的三次方曲线图呈现的效果缓入
BackFun_Out字符串选填按照超过范围的三次方曲线图呈现的效果缓出
BackFun_InOut字符串选填按照超过范围的三次方曲线图呈现的效果缓入缓出
ElasticFun_In字符串选填按照指数衰减的正弦曲线图呈现的效果缓入
ElasticFun_Out字符串选填按照指数衰减的正弦曲线图呈现的效果缓出
ElasticFun_InOut字符串选填按照指数衰减的正弦曲线图呈现的效果缓入缓出
BounceFun_In字符串选填按照指数衰减的反弹曲线图呈现的效果缓入
BounceFun_Out字符串选填按照指数衰减的反弹曲线图呈现的效果缓出
BounceFun_InOut字符串选填按照指数衰减的反弹曲线图呈现的效果缓入缓出

 

应用示例

示例:下面示例展示了当图片ty.png从(0,0)移动到(500,0)过程中使用了SineFun_Out函数效果,整个动画历时4000ms。注意:当从(500,0)移动到(800,0)过程中由于未使用变速函数,因此移动速率是均匀的。

 

数据开放

天气数据开放-Weather

 

功能概述

开放天气App中天气相关数据:配置Weather标签后,在Weather标签中声明Var变量并使用指定的变量名,即可声明气象、空气质量指数、温度、湿度、风向、日出日落时间等天气数据对应的变量。变量支持默认值,如果获取到实际天气情况会更新该值。

说明:

  1. 目前该功能暂时只支持国内,且不支持昨天天气数据,只支持今天和明天天气数据。

  2. 天气类主题必须在description文件中写明天气相关设置的说明,包括以下内容:

    • 天气数据来源于荣耀天气app,使用前请确保荣耀天气app已使用,并有当前定位城市的天气信息。

    • 当前天气信息的更新频率为应用时立即更新一次,应用后5分钟左右更新一次。

       

XML规范

说明:只有在Weather标签中声明Var变量并使用指定的变量名,才能获取到实际的天气数据。Var用法参照 自定义变量-Var,天气变量名称参照 天气变量名称说明表。

 

天气变量名称说明表

说明:在此只列举今天的数据,明天的数据只需要将today改成tomorrow即可。

部分数据不支持明天,文档列表中已有详细说明

参 数类  型注 释
Weather.today.weatherIcon数值气象码。
0/9/10/27/28:未知; 1/33:晴; 2/34:大部晴天; 3:局部晴天; 4:局部多云; 5/37:霾; 6:
大部多云; 7:多云; 8/75:阴; 11:雾; 12:阵雨; 13:大部多云,伴有阵雨; 14:局部晴天,
伴有阵雨; 15:雷阵雨; 16:大部多云,伴有雷阵雨; 17:局部晴天,伴有雷阵雨; 18:雨;
19:阵雪; 20:大部多云,伴有阵雪; 21:局部晴天,伴有阵雪; 22:雪; 23:大部多云,伴有雪;
24:冰; 25/29:雨夹雪; 26:冻雨; 30:炎热; 31:寒冷; 32:有风; 35:局部多云,有阵雨;
36:局部多云; 38:大部多云; 39:局部多云,伴有阵雨; 40:大部多云,伴有阵雨;
41:局部多云,伴有雷阵雨; 42:大部多云,伴有雷阵雨; 43:大部多云,伴有阵雪;
44:大部多云,伴有雪; 45:雷阵雨,伴有冰雹; 46:小雨; 47:中雨; 48:大雨; 49:暴雨;
50:大暴雨; 51:特大暴雨; 52:小雪; 53:中雪;54:大雪; 55:暴雪; 56:沙尘暴; 57:小到中雨;
58:中到大雨; 59:大到暴雨; 60:暴雨到大暴雨; 61:大暴雨到特大暴雨; 62:小雪到中雪;
63:中雪到大雪; 64:大到暴雪; 65:浮尘; 66:扬沙; 67:强沙尘暴; 68:浓雾; 69:强浓雾;
70:中度霾; 71:重度霾; 72:严重霾; 73:大雾; 74:特强浓雾; 76:吹雪。
说明:实际使用中可对气象码进行分类展示,以提高制作效率
Weather.today.weatherIconDes字符串气象描述。
0/9/10/27/28:未知; 1/33:晴; 2/34:大部晴天; 3:局部晴天; 4:局部多云; 5/37:霾;
6:大部多云; 7:多云; 8/75:阴; 11:雾; 12:阵雨; 13:大部多云,伴有阵雨;
14:局部晴天,伴有阵雨; 15:雷阵雨; 16:大部多云,伴有雷阵雨; 17:局部晴天,伴有雷阵雨;
18:雨; 19:阵雪; 20:大部多云,伴有阵雪; 21:局部晴天,伴有阵雪; 22:雪;
23:大部多云,伴有雪; 24:冰; 25/29:雨夹雪; 26:冻雨; 30:炎热; 31:寒冷;
32:有风; 35:局部多云,有阵雨; 36:局部多云; 38:大部多云; 39:局部多云,伴有阵雨;
40:大部多云,伴有阵雨; 41:局部多云,伴有雷阵雨; 42:大部多云,伴有雷阵雨;
43:大部多云,伴有阵雪; 44:大部多云,伴有雪; 45:雷阵雨,伴有冰雹; 46:小雨;
47:中雨; 48:大雨; 49:暴雨; 50:大暴雨; 51:特大暴雨; 52:小雪; 53:中雪;
54:大雪; 55:暴雪; 56:沙尘暴; 57:小到中雨; 58:中到大雨; 59:大到暴雨;
60:暴雨到大暴雨; 61:大暴雨到特大暴雨; 62:小雪到中雪; 63:中雪到大雪;
64:大到暴雪; 65:浮尘; 66:扬沙; 67:强沙尘暴; 68:浓雾; 69:强浓雾;
70:中度霾; 71:重度霾; 72:严重霾; 73:大雾; 74:特强浓雾; 76:吹雪
Weather.today.aqivalue数值空气质量指数值:1. 优质;2. 良好;3. 轻度污染;4. 中度污染;5. 重度污染;6. 严重污染;0. 未知。
说明:无明天数据
Weather.today.aqivaluetext字符串空气质量等级划分枚举值:优质;良好;轻度污染; 中度污染;重度污染;严重污染。
说明:无明天数据
Weather.today.currentTem数值当前温度。
说明:无明天数据
Weather.today.maxtemp数值最高温度。
Weather.today.mintemp数值最低温度。
Weather.today.humidity字符串湿度。
无明天数据
Weather.today.winddir字符串风向枚举值:NE,E,SE, S,SW,W,N,NW。
Weather.today.winddirDes字符串风向枚举值:NE 东北风,E 东风,SE 东南风, S 南风,SW 西南风,W 西风,N 北风,NW 西北风。
Weather.today.sunRise字符串日出 HH:mm格式 06:05。
Weather.today.sunSet字符串日落 HH:mm格式 18:05

 

使用说明

1.可以搭配天气数据刷新命令RefreshWeatherCommand来刷新天气数据。参照 示例2:刷新天气数据。

2.如果使用了Weather标签并定义了天气变量,可以通过全局变量weatherRespCode的值,判断天气数据是网络返回值还是默认值:全局变量weatherRespCode的值为0表示默认值,1表示网络返回值。参照 示例1:展示天气状况并判断数据状态。

 

应用示例

示例一:展示天气状况并判断数据状态

示例二:刷新天气数据

示例三

获取天气气象码,根据不同的气象码值展示不同的天气图标。并将气象码分为以下11大类进行展示:

  1. 晴 sunny(1/33:晴;2/34:大部晴天;3:局部晴天)。
  2. 多云 cloudy(4:局部多云;6:大部多云;7:多云;8/75:阴;36:局部多云;38:大部多云)。
  3. 霾 haze(5/37:霾;70:中度霾;71:重度霾;72:严重霾)。
  4. 雾 fog(11:雾;68:浓雾;69:强浓雾;73:大雾;74:特强浓雾)。
  5. 雨 rain(12:阵雨;13:大部多云,伴有阵雨;14:局部晴天,伴有阵雨;18:雨;26:冻雨;35:局部多云,有阵雨;39:局部多云,伴有阵雨;40:大部多云,伴有阵雨;46:小雨;47:中雨;48:大雨;49:暴雨;50:大暴雨;51:特大暴雨;57:小到中雨;58:中到大雨;59:大到暴雨;60:暴雨到大暴雨;61:大暴雨到特大暴雨)。
  6. 雷阵雨 Storm(15:雷阵雨;16:大部多云,伴有雷阵雨;17:局部晴天,伴有雷阵雨;41:局部多云,伴有雷阵雨;42:大部多云,伴有雷阵雨;45:雷阵雨,伴有冰雹)。
  7. 雪 Snow(19:阵雪;20:大部多云,伴有阵雪;21:局部晴天,伴有阵雪;22:雪;23:大部多云,伴有雪;24:冰;25/29:雨夹雪;43:大部多云,伴有阵雪;44:大部多云,伴有雪;52:小雪;53:中雪;54:大雪;55:暴雪;62:小雪到中雪;63:中雪到大雪;64:大到暴雪;76:吹雪)。
  8. 沙尘暴 Thunder shower(56:沙尘暴;65:浮尘;66:扬沙;67:强沙尘暴)。
  9. 寒冷 cold(31:寒冷)。
  10. 炎热 hot(30:炎热)。
  11. 默认值 default(32:有风;0/9/10/27/28:未知)。

 

音乐数据开放-MediaControl

 

功能概述

开放以下音乐数据和播控功能,支持在锁屏、桌面中使用以制作创意主题。

音乐数据歌曲名称专辑封面艺术家名称歌词歌曲风格
音乐App××
播控功能暂停/播放音量调节切换歌曲歌词开关震动开关收藏/取消收藏播放模式进度条
音乐App××××

 

使用说明

 

音乐控制器-MediaControl

在使用音乐数据和播控功能时,需要先声明音乐控制器-MediaControl/。

 

XML规范

说明

  1. 同一个脚本中,声明一次-MediaControl/即可。

  2. 音乐控制器-MediaControl/需写在-Lockscreen或者-CommonWallpaper下一个层级。

     

音乐数据变量

使用音乐数据变量时,需要先声明音乐控制器-MediaContro /。

参数类型注释
media_play_status数值播放状态,1为停止,2为暂停,3为播放。
说明:停止:从头开始播。暂停:从当前进度开始播。
media_title字符串歌曲名称。
说明:当通过文本展示歌曲名称时,可设置文本内容超出文本框宽度后滚动/裁剪,
避免歌曲名称过长时自动换行,影响其他内容展示的情况。
media_subtitle字符串艺术家名称。
说明:当通过文本标签展示艺术家名称时,可设置文本内容超出文本框宽度后滚动/裁剪,
避免艺术家名称过长时自动换行,影响其他内容展示的情况。

 

音乐控制命令-MediaCommand

在使用音乐控制命令-MediaCommand时,需要先声明音乐控制器-MediaControl。

 

XML规范

 

参数说明

参数类型选项注释
command字符串必填command可以设置的值如下:
mediaPlay:音乐播放命令
mediaPause:音乐暂停命令
skipToPrevious:上一首
skipToNext:下一首
addVoice:增加音量
subVoice:减少音量
voiceStep100数值选填音量变化的步进值,默认为10,支持表达式。
condition数值选填触发条件,1为触发,支持表达式。

应用示例

说明:示例中的 -MediaControl/写在-CommonWallpaper标签下,如设计在锁屏中则写在-Lockscreen标签下。

 

音乐进度条-MediaProgressbar

在使用音乐进度条-MediaProgressbar时,需要先声明音乐控制器-MediaControl。

 

XML规范

 

参数说明

参数类型选项注释
topColor字符串必填已进行进度颜色,支持表达式。
bottomColor字符串必填未进行的进度颜色,支持表达式。
bgSrc字符串选填进度条的背景图。
iconSrc字符串选填跟随进度的小图标,支持表达式。
progressWidth数值选填进度条的高度,支持表达式。
iconWidth数值必填小图标的宽度,支持表达式。
iconHeight数值选填小图标的高度,支持表达式。
isRightAngle字符串选填表示进度条角度,值为true时进度条为直角,非true或不填为圆角。

x、 y、h和w这4个参数规定了-MediaProgressbar控件的位置和大小。progressWidth的值规定了实际显示出来的进度条的高度,当progressWidth的值≤h的值时,按照实际值居中显示;当progressWidth的值>h的值时,按照h的值显示。

应用示例

 

专辑封面-Medialcon

获取到音乐App中的专辑封面图片时,展示获取到的专辑封面。

未获取到音乐App中的专辑封面图片时,展示通过-MediaIcon设置的默认专辑封面。

在使用专辑封面-Medialcon时,需要先声明音乐控制器-MediaControl。

 

xml规范

 

参数说明

-Medialcon支持图片-Image的参数设置。

参数类型选项注释
src字符串必填没有歌曲封面时展示的默认图。

 

应用示例

 

运动健康数据开放-Healthy

 

功能概述

开放运动健康App的步数、距离、卡路里、实时心率和静息心率数据,设计师可以根据这些数据制作创意主题。

说明:

用户需打开运动健康App,同意用户协议并登录帐号,才能获取到步数、距离和卡路里数据。在此基础上,

还需绑定支持心率功能的智能穿戴设备,才能获取到实时心率和静息心率数据。

 

场景举例

 

XML规范

 

参数说明

参数类型选项注释
polling布尔值选填轮询开关,true为开启轮询,false为关闭轮询。默认是false。
time数值选填轮询时间间隔,单位(秒),最小值为1,仅在polling为true的时候有效。默认是5秒。
name字符串必填参照下面运动健康数据类型取值。

 

系统数据开放

功能概述

开放以下系统数据和控制功能,以制作创意主题。

 

系统数据:

 

控制功能:

支持范围

支持应用范围:锁屏、桌面。

支持设备类型:手机、平板、折叠屏。

 

系统数据全局变量

变量名称类型说明
systemVersion字符串设备版本。
storageFree字符串设备可用空间。结果四舍五入取整,单位:G。
storageFreeNum数值设备可用空间。结果四舍五入取整,单位:MB(不显示)。
storageTotal字符串设备总空间。结果四舍五入取整,单位:G。
storageTotalNum数值设备总空间。结果四舍五入取整,单位:MB(不显示)。
vibration数值声音模式。2:响铃;1:震动;0:静音。超出[0,2]取值范围不生效。
flashlight字符串手电筒开关状态。0:关闭;1:打开。
automaticRotary字符串自动旋转开关状态。0:关闭;1:打开。

 

系统数据自定义变量

设备开机时长获取 deviceTime

通过建立Var标签,设置name="deviceTime"获取设备开机时长数据。

 

XML规范

参数类型选项说明
assigning字符串必填设备开机时长的显示格式:dd天、dd天HH、dd天HH小时mm分钟。
格式中的文字字符会被替换,以dd天HH小时mm分钟这个格式为例,
也可以写为dd/HH/mm、dd-HH-mm等。

应用示例

 

设备开机时长轮询 pollingTime

设置轮询时间间隔后,将按照轮询时间间隔自动刷新设备开机时长数据。

 

XML规范

参数类型选项说明
time数值选填设备开机时长的轮询时间,单位:分钟,最小值为1,不填即不开启轮询。

 

应用示例

 

CPU使用率 processCpuRate

通过建立Var标签,设置name="processCpuRate"获取CPU使用率数据。

 

xml规范

参数类型选项说明
bit数值选填保留小数的位数。
说明:
1.CPU空闲率的小数位数和CPU使用率的小数位数保持一致。
2.如果不设置此参数,则默认显示整数

 

应用示例

 

CPU空闲率 processCpuFree

通过建立Var标签,设置name="processCpuFree"获取CPU空闲率数据。

 

XML规范

 

应用示例

 

系统数据控制命令

声音模式改变命令

声音模式正常使用的必要条件:在设置页面打开主题对应的免打扰权限。

声音模式共3种(详见全局变量vibration),支持通过VariableCommand命令改变声音模式。

 

XML规范

 

应用示例

 

手电筒开关命令

手电筒开关状态共2种(详见全局变量flashlight),支持通过VariableCommand命令控制手电筒开关。

 

XML规范

 

应用示例

创建固定变量flashlightValue,每次点击flashlightValue的值+1,同时为变量flashlight重新赋值:如果flashlight的值为0,则重新为其赋值为1;如果flashlight的值为1,则重新为其赋值为0。

 

自动旋转开关命令

自动旋转开关状态共2种(详见全局变量automaticRotary),支持通过VariableCommand命令控制手机是否自动旋转屏幕

 

XML规范

 

应用示例

创建固定变量automaticRotaryValue,每次点击automaticRotaryValue的值+1,同时为变量automaticRotary重新赋值:如果automaticRotary的值为0,则重新为其赋值为1;如果automaticRotary的值为1,则重新为其赋值为0。

 

音量/亮度进度条加减命令

支持通过音量/亮度进度条加减命令ProgressCommand,进行音量/亮度的加减。

 

XML规范

参数类型选项说明
mode数值必填音量或屏幕亮度模式。0:通话音量;1:屏幕亮度;2:来电信息通知音量;
3:音乐/视频/游戏音量;4:闹钟音量。
change数值必填进度条加减。0:减;1:加。
amplitude数值必填进度条加减的步进值。参照以下范围进行取值。
通话音量:1-15。
屏幕亮度:4-255。
来电信息通知音量:0-15。
音乐/视频/游戏音量:0-15。
闹钟音量:1-15。
说明:
1.步进值是指单次调节进度条时增加或减少的值。
2. 不同系统的亮度范围可能会有所差异,以上亮度范围仅为参考。

 

应用示例

 

综合用例

示例一:获取手机版本、手机可用空间、手机总空间数据,同时使用进度条展示手机可用空间占比。

示例二:获取手机版本、开机时长、CPU使用率、获取CPU空闲率、手机可用空间、手机总空间等系统数据,

支持控制手电筒开关和自动旋转开关,并支持调节音乐/视频/游戏音量。

 

步数-StepCount

功能概述

步数功能是根据全局变量#steps_value实现的。可以通过Text文本调用全局变量#steps_value显示步数。

 

应用场景

 

应用示例

使用format、paras显示当前步数。

 

适配功能

传感器-SensorBinder

 

功能概述

支持获取四种类型的传感器数据,即加速传感器(accelerometer)、重力传感器(gravity)、线性加速传感器(linearAccelerometer)和陀螺仪(gyroscope)。其中,加速传感器获取的值是线性加速度传感器与重力传感器相加得到的结果,即:加速度(accelerometer) = 线性加速度(linearAccelerometer)+ 重力加速度(gravity)。基于传感器功能,可实现重力感应和摇一摇等效果。

注意:manifest.xml文件中只能有一个VariableBinders和SensorBinder。需要根据应用场景来选择合适的传感器类型,例如:实现重力感应效果时推荐使用accelerometer。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
type字符串必填支持:accelerometer,gravity,linearAccelerometer,gyroscope四种类型
vibrate数值选填摇一摇是否触发震动,取值0/1。0表示不触发震动,1表示触发震动。默认为0,支持表达式
shakeTime数值选填摇一摇触发震动的震动时长,单位为ms,默认为0,支持表达式
delay数值选填摇一摇触发震动的延时时间,单位为ms,默认为0,支持表达式
index数值必填用于标识传感器某个特定方向,取值为0,1,2;具体含义参考下文表格中的解释说明
name字符串必填变量名,用于记录传感器在对应index方向上的值,在使用时可通过#name获取该变量的值

不同类型传感器index解释说明:

传感器类型index取值注释
accelerometer0,1,2index=0、1、2分别表示x、y、z方向的加速度
gravity0,1,2index=0、1、2分别表示x、y、z方向的重力加速度
linearAccelerometer0,1,2index=0、1、2分别表示x、y、z方向的线性加速度
gyroscope0,1,2index=0、1、2分别表示x、y、z方向的角速度

 

应用示例

示例一:用获取的重力传感器值来控制DropPhysicalView中雪花飘落的方向和速度。由于重力传感器x轴正方向为水平向左,与手机屏幕x轴正方向相反,所以x_gra的值需要设置负号,使其与手机偏移方向一致。当手机偏移的时候,雪花下落会朝向重力传感器的方向。

示例二:基于加速传感器实现重力感应,type设置为accelerometer加速传感器类型。在SensorBinder中获取各个方向的加速度值后,在Image中使用x_acc和y_acc来控制图片的x和y坐标,进而达到重力感应效果。注意:可以调节x_acc和y_acc的符号以及相乘系数来控制图片移动方向和移动幅度大小。

 

摇一摇-Shake

 

功能概述

当声明了传感器VariableBinders后,会生成一个系统全局变量shake,当摇一摇手机的时候,这个变量的值就会加一,可以通过使用这个变量制作想要的效果,摇一摇数值变化的间隔为1000ms。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
shake数值必填全局变量,直接使用#shake引用数字,
每当摇一摇幅度超过阈值则全局变量shake的增值加一

 

应用示例

示例一:每当摇一摇超过阈值则shake值加1,srcid的值在0,1,2中轮换,实现3张图片通过摇一摇轮播的效果。

示例二:摇一摇触发手机震动,同时通过#shake变量控制动画的可见性。

 

充电状态-BatteryCharging

 

功能概述

充电状态功能可以获取当前手机电量状态,并根据文本Text中的category属性来决定是否展示该文本。category中可包括"Normal", "Charging", "BatteryLow", "BatteryFull"四种状态,分别表示电量正常,正在充电,电量不足和电量充满。如果Text中category属性中的电量状态与当前手机状态匹配,则显示该条文本信息;匹配不上,则不显示。

 

应用场景

 

XML规范

充电状态典型用法是在Text标签中设置category属性。

 

参数说明

参 数类 型选 项注 释
category字符串必填设置电量状态,当手机电量状态与category中设置的值匹配时,
则显示该条文本信息。支持四种状态:BatteryFull(电量充满)、
Charging(正在充电)、BatteryLow(电量不足)、Normal(电量正常)。具体解释,参考下文
text字符串选填当手机电量状态与category中设置的值匹配时,则显示该text内容。
注意:除了text属性,还支持Text标签中其他属性,例如:format、paras等。
此处,省略其他属性描述,请参考Text标签

注意:四种电量状态解释说明

  1. 如果电量为100%,则为BatteryFull;
  2. 如果处于充电状态,且电量<100%,则为Charging;
  3. 如果不处于充电状态,且电量<15%,则为BatteryLow;
  4. 如果不处于充电状态,且电量>=15%,则为Normal。

 

应用示例

示例一:通常情况下,在xml脚本中需要写多条Text语句,分别对应手机电量在不同状态下的情况。某一时刻,只有category属性与当前手机电量状态匹配的Text文本信息才被显示出来,其他文本信息则不显示。

 

震动设置-Vibrate

 

功能概述

通过-Vibrate参数,控制slider,unlocker和externCommand三种组件在达到一定条件时是否触发震动。使用时有一些限制:

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
vibrate字符串选填震动的开关,只支持true/false字段,不设置的情况下,默认是false

 

支持组件

组件名触发时机
Slider1. 当Slider的StartPoint区域被触摸到的时候,StartPoint和EndPoint区域状态都被设置为Pressed_state,并且有50ms的震动
2. 当Slider的触摸进入一个EndPoint区域的时候,产生50ms的震动
3. 当触摸区域在StartPoint区域,而抬手操作在EndPoint区域之外时,产生50ms的震动
Unlocker与Slider相同
ExternCommand当ExternCommand的command等于unlock时,触发ExternCommand时产生50ms的震动

 

应用示例

示例:开启项目的震动开关,在以上支持组件中达到相应的条件会产生震动的效果。

 

恒定帧率-FrameRate

 

功能概述

指定引擎的帧率为固定值,在效果与功耗之间寻求平衡。

 

XML规范

 

参数说明

参 数类 型选 项注 释
frameRate数值选填屏幕刷新的帧率,数值越大,效果越好,功耗相对较高。默认60,推荐使用30

 

应用示例

示例:演示屏幕刷新的帧率为固定值30时的示例。

 

可变帧率-VariableFramerate

 

功能概述

根据时间线指定不同帧率,可以指定在规定的时间内使用某一种帧率,实现不同帧率切换。目前只支持改变一次帧率。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
frameRate数值必填屏幕刷新的帧率,数值越大,效果越好,功耗相对较高。默认60,推荐使用30
time数值必填循环时间,单位为ms毫秒

 

应用示例

示例:演示屏幕刷新帧率在5和30之间的动态切换的示例。设置了切换时间,先显示帧率为5的效果,然后10秒后切换到帧率30展示动效。

 

多屏幕展示-MultiScreens

 

功能概述

支持三屏幕内容切换,三屏划动切换控制动画。屏幕绘制可以通过Rectangle矩形图形和Image图片标签来实现。

 

应用场景

 

XML规范

 

参数说明

参 数类 型选 项注 释
Group表达式必填元素组集合,当中的x属性为屏幕开始的x坐标位置
Rectangle表达式选填矩形类型,可以用来绘制屏幕内容,相关的参数说明可以参照1.14几何图形
Image表达式选填图片类型,可以用来绘制屏幕内容,相关的参数说明可以参照1.2图片

 

应用示例

示例一:演示用Rectangle矩形类型来绘制屏幕,fillColor填充颜色来区别三个不同的屏幕,dottedLine和cornerRadius可以指定虚线模式和矩形的圆角半径,具体的可以参照1.14几何图形的参数说明。通过左右滑动可以实现三屏幕的切换的效果。

示例二:演示用三个不同的Image来做屏幕,通过左右滑动实现三屏幕切换的效果。

 

2D基础动效

主要涉及透明度动画、位移动画、旋转动画、缩放动画、帧动画、变量动画、时间动画,除时间动画外,

其他动画默认循环播放。支持设置动画循环次数,循环结束,动画会回到开始位置。

 

透明度动画-AlphaAnimation

 

动效概述

针对某个元素或组-Group,实现透明度变化效果。

 

XML规范

 

参数说明

参 数类 型选 项注 释
delay数值选填延迟,以ms毫秒记。延迟delay毫秒后执行动画播放。
repeat数值选填动画重复播放次数,N表示重复N次,0表示无限次循环。
N大于0时,循环次数结束后透明度为动画起始帧透明度值或者0
a数值必填[0-255],透明度0-255,小于等于0不显示,正数值。
time数值必填[0-~],相对于起始帧的间隔时间(毫秒),不小于0。

 

示例

 

位移动画-PositionAnimation

 

动效概述

针对某个元素或组-Group,可以实现位移动画效果。

 

XML规范

 

参数说明

参 数类 型选 项注 释
delay数值选填延迟,以ms毫秒记。延迟delay毫秒后执行动画播放。
repeat数值选填动画重复播放次数,N表示重复N次,0表示无限次循环。
N大于0时,循环次数结束后位移为动画起始帧值或者0
x数值必填相对于图片初始位置的x坐标,整数。
y数值必填相对于图片初始位置的y坐标,整数。
time数值数值必填必填[0-~],相对于起始帧的间隔时间(毫秒),不小于0。

 

示例

 

透明度、位移动画效果展示

 

旋转动画-RotationAnimation

 

动效概述

针对某个元素或组-Group,可以实现旋转动画效果。

 

XML规范

 

参数说明

参 数类 型选 项注 释
delay数值选填延迟,以ms毫秒记。延迟delay毫秒后执行动画播放。
repeat数值选填动画重复播放次数,N表示重复N次,0表示无限次循环。
N大于0时,循环次数结束后旋转角度为动画起始帧值或者0
angle数值必填旋转角度。
time数值必填[0-~],相对于起始帧的间隔时间(毫秒),不小于0。

 

示例

效果展示

 

缩放动画-SizeAnimation

 

动效概述

针对某个元素或组-Group,实现缩放动画效果。

 

XML规范

 

参数说明

参 数类 型选 项注 释
delay数值选填延迟,以ms毫秒记。延迟delay毫秒后执行动画播放。
repeat数值选填动画重复播放次数,N表示重复N次,0表示无限次循环。
N大于0时,循环次数结束后缩放比例为动画起始帧值或者0
w数值必填图片的大小宽,正整数。
h数值必填图片的大小高,正整数。
time数值必填[0-~],相对于起始帧的间隔时间(毫秒),不小于0。

效果和代码展示

 

帧动画-SourcesAnimation

 

动效概述

只有图片支持帧动画,图片帧动画稍有不同,无插值。可以设置图片播放之间的间隔时间。

 

XML规范

 

参数说明

参 数类 型选 项注 释
delay数值选填延迟,以ms毫秒记。延迟delay毫秒后执行动画播放。
repeat数值选填动画重复播放次数,N表示重复N次,0表示无限次循环。
N大于0时,循环次数结束后停留在起始帧位置
src字符串必填每一帧图片的文件名,该src值不可为空。
time数值必填[0-~],相对于起始帧的间隔时间(毫秒),也是动画持续时间,帧图片人肉眼能识别时间延时为300ms左右,不小于0。

效果和代码展示

 

变量动画-VariableAnimation

 

动效概述

只针对变量-Var,让一个变量在规定时间内变化。

 

XML规范

 

参数说明

参 数类 型选 项注 释
delay数值选填延迟,以ms毫秒记。延迟delay毫秒后执行动画播放。
repeat数值选填动画重复播放次数,N表示重复N次,0表示无限次循环。
N大于0时,动画结束后变量值为起始帧值或0
value数值必填这一刻时间变量的数值。
time数值必填[0-~],相对于起始帧的间隔时间(毫秒),不小于0。

 

效果和代码展示

 

时间动画-TimeAnimation

 

动效概述

时间元素刷新,当有用到time全局变量,会启动变量的刷新,time的值会按帧率进行刷新。

 

XML规范

参 数类 型选 项注 释
time数值必填值范围[0-3600000),当前系统时间毫秒数对1小时的毫秒数3600000取模。
按帧率进行刷新,默认大概30ms(毫秒)刷新一次,可用于时钟秒针动画等

效果和代码展示

 

2D高级动效

旋涡解锁-RotateView

 

动效概述

将图片分成网格,手指触摸屏幕时图片呈向心收缩的动画(如水池排水时的旋涡效果),且旋涡中心随手指移动移动。当图片收缩距离小于一定距离时触发解锁或设定的Trigger操作,触发Trigger需要收缩到一定距离时旋涡中心在Trigger范围内,如果不在指定的Trigger区域内则执行解锁操作。若在未达到解锁收缩范围时手指离开屏幕则图片恢复原样。适用范围为全屏,不支持width、height、alpha等通用属性。

 

场景举例

 

XML规范

 

参 数类 型选 项注 释
meshx数值选填x方向网格数量,范围为[2,屏幕宽度的二分之一]的整数,默认为100。建议不要设置过大,会消耗很多计算资源
meshy数值选填y方向网格数量,范围为[2,屏幕高度的二分之一]的整数,默认为100。建议不要设置过大,会消耗很多计算资源
speedofDistance数值选填旋涡向心收缩的最大速度,范围为[1,100]的实数,默认为20
speedofAngel数值选填旋涡旋转的最大速度,范围为[1,100]的实数,默认为20
delayTime数值选填旋涡向心收缩和旋转速度达到最大速度的延迟时间,范围为[0,30000]的实数,默认为100
src字符串必填图片资源名称,支持变量,如@abc
useVirtualScreen字符串选填是否使用虚拟屏幕,若为true则src为虚拟屏幕名称,默认false
参 数-Trigger类 型选 项注 释
x数值选填矩形区域左上角x值,默认为0,支持表达式
y数值选填矩形区域左上角y值,默认为0,支持表达式
w数值选填矩形宽度值,默认为0,支持表达式
h数值选填矩形高度值,默认为0,支持表达式
子标签能够层叠Trigger以在不同的旋涡结束区域触发不同的命令,
在没有设置区域Trigger时为解锁命令其中
x、y、w、h分别表示区域的位置和宽高,以屏幕左上角为原点。
   

说明

效果和代码展示

旋涡解锁示例

 

网格化-MeshImage

通过控制图片像素点运动实现图片变形、抖动、拉伸等效果,网格划分示意图

 

网格化-位移-MeshImage-Translation

 

动效概述

可实现局部区域抖动效果,如果需要响应加速度传感器,需要设置sensor="true",否则不会响应。局部区域根据参数center_point、no_move_distance_x和no_move_distance_y计算。例如:图片w=1080,h=1920,meshx=6,meshy=6,则每个网格区域的宽为180,高为320,若center_point=25,no_move_distance_x=180,no_move_distance_y=320,则x轴方向上距离中心点25距离小于等于180,且y轴方向上距离中心点25距离小于等于320的所有网格顶点17、18、19、24、26、31、32、33组成的区域为可移动区域,当手指滑动图片时可移动区域与9,13,37,41组成的外圈有位移拉伸效果。

 

场景举例

 

XML规范

 

参数说明

参 数类 型选 项注 释
duration数值选填单次动画持续时间(毫秒),取值正整数,默认为2000,支持表达式。
repeat数值选填动画重复次数,-1表示无限循环,0表示不重复,n表示重复n+1次,默认为0,支持表达式。
delay数值选填动画延迟执行的毫秒数,即触发动画后需要delay毫秒才开始执行动画,取值正整数,
默认为0,支持表达式。
factor数值选填动画回弹因子,取值0~1之间,值越大回弹幅度越小,默认为0.2,支持表达式。
values字符串必填由多个0-1之间的实数构成的运动参数列表,实数个数最少2个,最多5个。
示例:“1.0,0,1.0”表示从当前位置运动到初始位置,然后又运动到当前位置,
实数值越大移动距离越大,但受限于max_distance_x和max_distance_y。
max_distance_x数值选填x轴最大运动距离,单位为像素,取值为(0,每个网格宽度),默认为一个网格宽度,支持表达式。
max_distance_y数值选填y轴最大运动距离,单位为像素,取值为(0,每个网格高度),默认为一个网格高度,支持表达式。
no_move_distance_x数值选填x轴方向不动的点,离中心点大于no_move_distance_x距离的点不动。设置的值需大于0,
如果为0值则被认为是图片宽度,默认为图片宽度,单位为像素,支持表达式。
no_move_distance_y数值选填y轴方向不动的点,离中心点大于no_move_distance_y距离的点不动。设置的值需大于0,
如果为0值则被认为是图片高度,默认为图片高度,单位为像素,支持表达式。

 

效果和代码展示

将宽339、高388的图片分成横20格、竖20格,共400个网格,每个网格宽16.95,高19.4。values设为1,0表示局部图片随手指或传感器产生位移抖动效果后恢复原位,位移大小与手指移动距离或手机加速度大小成正比,max_distance_x/y设为30,使得位移动画的x,y轴最大位移为30像素,动画过程持续2s。no_move_distance_x/y设置为121、138,根据每个网格的宽高可以算出中心点左右共14列和上下共14排相交的区域为局部移动区域,可以通过手指滑动该区域,滑动时该区域与包裹着该区域的网格顶点间有拉伸变形。

网格化-旋转-MeshImage-Rotate

 

动效概述

可实现图片局部旋转动画,旋转区域与位移区域计算方法一致。

 

场景举例

 

XML规范

 

参数说明

参 数类 型选 项注 释
duration数值选填单次动画持续时间(毫秒),取值正整数,默认为2000,支持表达式。
repeat数值选填动画重复次数,-1表示无限循环,0表示不重复,n表示重复n+1次,默认为0,
支持表达式。
delay数值选填动画延迟执行的毫秒数,即触发动画后需要delay毫秒才开始执行动画,
取值正整数,默认为0,支持表达式。
values字符串必填由多个0-360之间的实数构成的旋转参数列表,实数个数最少2个,最多5个。
示例:”0,360,0“表示从当前位置顺时针旋转360度,然后再逆时针旋转到当前位置。
no_move_distance_x数值选填x轴方向不动的点,离中心点大于no_move_distance_x距离的点无旋转。
设置的值需大于0,如果为0值则被认为是图片宽度,默认为图片宽度,单位为像素,支持表达式。
no_move_distance_y数值选填y轴方向不动的点,离中心点大于no_move_distance_y距离的点无旋转。
设置的值需大于0,如果为0值则被认为是图片高度,默认为图片高度,单位为像素,支持表达式。

 

效果和代码展示

在该示例中,设置循环播放旋转动画,每次持续2.5s,点击图片后,局部区域开始由当前位置顺时针旋转360度,然后再逆时针旋转到180度后,再进一步旋转回到当前位置。

网格化-缩放-MeshImage-Scale

 

动效概述

实现图片局部区域缩放动画,缩放区域计算方式与局部位移动画一致。

 

场景举例

 

XML规范

 

参数说明

参 数类 型选 项注 释
duration数值选填单次动画持续时间(毫秒),取值正整数,默认为2000,支持表达式。
repeat数值选填动画重复次数,-1表示无限循环,0表示不重复,n表示重复n+1次,默认为0,支持表达式。
delay数值选填动画延迟执行的毫秒数,即触发动画后需要delay毫秒才开始执行动画,取值正整数,默认为0,支持表达式。
values数值必填由多个0-1之间的实数构成的缩放参数列表,实数个数最少2个,最多5个。示例:”1,0,1“表示从最大缩小到0,然后再放大到最大。1表示原始大小,缩放数值是原始大小的倍数。
no_move_distance_x数值选填x轴方向不动的点,离中心点大于no_move_distance_x距离的点无缩放效果。设置的值需大于0,如果为0值则被认为是图片宽度,默认为图片宽度,单位为像素,支持表达式。
no_move_distance_y数值选填y轴方向不动的点,离中心点大于no_move_distance_y距离的点无缩放效果。设置的值需大于0,如果为0值则被认为是图片高度,默认为图片高度,单位为像素,支持表达式。

 

代码和效果展示

在该示例中,设置values为1,0,1,点击图片后,局部区域从当前大小缩小到0,再从0放大至原局部区域大小。动画时长为2s,只播放1次。

 

 

网格化-透明度-MeshImage-Alpha

 

动效概述

实现整张图片透明度动画,不支持局部透明度变换。可以与旋转、位移以及缩放动画进行组合。

 

场景举例

可对大雾的图层进行设置透明度,可制作大雾散去的视觉。

点击河水,立马清澈,可看到鱼儿游玩。

可实现天空的星星闪烁。

 

XML规范

 

参数说明

参 数类 型选 项注 释
duration数值选填单次动画持续时间(毫秒),取值正实数,默认为2000,支持表达式。
repeat数值选填动画重复次数,-1表示无限循环,0表示不重复,n表示重复n+1次,默认为0,支持表达式。
delay数值选填动画延迟执行的毫秒数,即触发动画后需要delay毫秒才开始执行动画,默认为0,支持表达式。
values数值必填由多个0-1之间的实数构成的透明度参数列表,实数个数最少2个,最多5个。
示例:”1,0,1“表示从完全不透明到透明度为0,再变为完成不透明。

 

效果和代码展示

网格化-透明度示例一

透明度动画。点击图片后,图片从不透明变为透明,再渐变为半透明状态,时长为2s,只播放1次,再次点击可以继续播放。

 

网格化-透明度示例二

透明度和旋转动画。设置为循环播放,点击图片后,局部图片循环进行0°到360°的旋转动画,整张图片同时循环进行不透明到透明的透明度动画。

 

网格化-水波纹-MeshImage-SinMotion

 

动效概述

可实现局部水波荡漾、迎风飘舞等效果。

 

场景举例

 

XML规范

 

参数说明

参 数类 型选 项注 释
a数值选填水波幅度(振幅),取实数,单位为像素,默认为20,支持表达式。
factor_k数值选填相位,k值可以产生水波移动,值越大运动越快,值越小运动越缓,默认0.2,支持表达式。
no_move_distance_x数值选填x轴方向不动的点,离中心点大于no_move_distance_x距离的点无水波荡漾。
设置的值需大于0,如果为0值则被认为是图片宽度,默认为图片宽度,单位为像素,支持表达式。
no_move_distance_y数值选填y轴方向不动的点,离中心点大于no_move_distance_y距离的点无水波荡漾。
设置的值需大于0,如果为0值则被认为是图片高度,默认为图片高度,单位为像素,支持表达式。

 

效果和代码示例

不用点击图片,局部区域循进行水波荡漾动画。

 

跑马灯- Marquee

 

动效概述

跑马灯有:文字跑灯,文字的色彩循环渐变;文本路径跑马灯,文字的色彩循环渐变。同时文字可根据特定的路径进行排布,SVG跑马灯;SVG跑马灯,实现按照路径循环渐变跑马灯的功能,需要与路径解析功能联合使用,当路径为屏幕大小矩形时即实现屏幕跑马灯功能。

 

场景举例

 

XML规范

 

参数说明

参 数类 型选 项注 释
state数值选填是否开启跑马灯,当值等于1时可见,其余值为不可见状态,默认为1,支持数字表达式。
showTime数值选填跑马灯执行一次旋转位移的时间间隔,单位为ms,正整数,默认20ms,支持数字表达式。
deltaAngle数值选填跑马灯一次旋转位移的旋转角度,单位为度,范围建议选为-360-360,其中正值为顺时针旋转,
负值为逆时针旋转,可与showTime配合控制跑马灯跑动速度,默认5°,支持数字表达式。
pathname字符串必填路径名称,依赖于PathUtil,首先得通过PathUtil解析路径,跑马灯的路径为PathUtil中的路径,
参数值为路径PathUtil的名称。
scaleX数值选填对路径宽度进行缩放,scaleX是x轴的缩放倍数。缩放时以路径外接矩形的左上角为中心点,
例如路径为一个宽高均为100矩形,左上角坐标为(100,100),右下角坐标为(200,200),scaleX为2,
则放大后矩形左上角仍为(100,100),右下角为(300,200)。取值为大于0的实数,默认1,支持表达式。
scaleY数值选填对路径高度进行缩放,scaleY是y轴的缩放倍数。缩放时以路径外接矩形的左上角为中心点,
例如路径为一个宽高均为100矩形,左上角坐标为(100,100),右下角坐标为(200,200),scaleY为2,
则放大后矩形左上角仍为(100,100),右下角为(200,300)。取值为大于0的实数,默认1,支持表达式。
translateX数值选填对path进行x轴偏移,单位为像素,默认0,支持表达式解析。大于0,向右移动;小于0,向左移动。
translateY数值选填对path进行y轴偏移,单位为像素,默认0,支持表达式解析。大于0,向下移动;小于0,向上移动。
rotate数值选填对PathUtil的到的path路径进行旋转的角度,以路径外接矩形的左上角点为旋转中心,单位为度,
取值范围为-360~360,默认0°,支持表达式。
weight数值选填绘制路径的宽度,单位为像素,正整数,默认15像素,支持表达式。
color字符串必填跑马灯渐变的背景颜色,支持6/8位十六进制颜色表示、变量、argb函数,
如#ffffff,#ffffffff,@abc,argb(255,255,255,255),
若@abc字符串为16进制颜色表示则不可包含#号,如ffffff。
marqueeColor字符串必填跑马灯渐变的灯颜色,支持6/8位十六进制颜色表示、变量、argb函数。
其中颜色渐变为设置的color的颜色到marqueeColor的颜色产生一个线性的颜色过渡。
marqueePos数值选填跑马灯颜色渐变位置控制,颜色渐变点,其值为0~1之间的小数,表示color与marqueeColor颜色渐变位置,
默认0.3,支持表达式。

 

效果和代码展示

 

粒子散落-ParticleScatter

 

动效概述

粒子散落动效提供了图片粒子化散落和粒子图片散落两种不同的动效模式,其中图片粒子化是将图片转换成粒子并实现不同的散落动效,而粒子图片散落是按照一定的轨迹散落一定数量的图片,类似于散花的效果。不支持width、height、alpha等通用属性。

 

场景举例

 

XML规范

模式1:图片粒子化散落,提供点击后对一张图片粒子化并且粒子散落的动效。

 

参数说明

参 数类 型选 项注 释
x数值选填图片左上角相对于屏幕左上角的位置的x轴坐标,屏幕向右为正,单位为像素,
默认为0,支持表达式。
y数值选填图片左上角相对于屏幕左上角的位置的y轴坐标,屏幕向下为正,单位为像素,
默认为屏幕的左上角0,支持表达式。
w数值选填设置显示图片的宽度,单位为像素。如果与图片的宽高不一致会对图片有一个缩放的效果,
默认图片原始宽度。若图片宽度小于20,则设置为20,支持表达式。
h数值选填设置显示图片的高度,单位为像素。如果与图片的宽高不一致会对图片有一个缩放的效果,
默认图片原始高度。若图片宽高小于20,则设置为20,支持表达式。
src字符串必填粒子化图片的源地址,支持字符串变量,当设置useVirtualScreen等于true时,
src需要填写虚拟屏幕的名称。
useVirtualScreen字符串选填是否支持虚拟屏幕,true/false,默认false,
若为true支持虚拟屏幕则src参数必须为虚拟屏幕的名称。
style数值选填粒子散落效果,1-9整数,1:向上爆炸;2:向下坠落;3:从左向右坠落;
4:从右向左坠落;5:从上向下坠落;6从下向上坠落;7:向四周散开爆炸;
8:向两边扩散;9:向上抖动。默认为1,支持表达式。
duration数值选填动画持续时间(ms),为大于200 的整数,默认1000,支持表达式。
shaketime数值选填粒子散落前动画抖动时间 (ms),为大于等于0 的整数,默认150。
当style等于1,7,8,9时建议为0。支持表达式。
translateX数值选填粒子x轴移动的幅度,整数,默认3,支持表达式。当粒子半径较小时建议该值也相应较小。
translateY数值选填粒子y轴移动的幅度,整数,默认4,支持表达式。
shape数值选填动画中粒子形状,0:只有圆形;1:只有方形;2:圆形和方形混合,默认0,支持表达式。
radius数值选填粒子基础半径,为大于4 的整数,默认5,支持表达式。
需要在图片宽度和高度较小值的1/6以内。
reverse字符串选填动画是否倒放标识,即点击之后图片在散落之后会在duration时间结束之后产生一个反向的动画,
还原成原来的图片,值为true或者false,true为开启倒放,可继续点击出现动画效果,
false为不倒放,默认false。
unlock字符串选填是否解锁标识,true/false,true标识动画结束后直接解锁,false动画结束后不解锁,
默认false。unlock与reverse不可同时为true。

模式2:粒子图片散落,将图片作为粒子,产生一定的散落动画效果,例如烟花爆炸效果。

参数说明

参 数类 型选 项注 释
duration数值选填粒子散落的动画持续时间(ms),为大于200 的整数,默认1000,支持表达式。
style数值选填其效果与图片粒子化的效果一致,推荐使用1,2,7,默认为1,支持表达式。
translateX数值选填粒子x轴移动的幅度,取值为整数,默认3,支持表达式。该值越大,x轴粒子位移幅度越大。
translateY数值选填粒子y轴移动的幅度,取值为整数,默认4,支持表达式。该值越大,y轴粒子位移幅度越大。
参 数-Item类 型选 项注 释
src字符串必填粒子图片源名称。
number数值选填点击产生的粒子数量,大于4 的整数,默认10。
width数值选填粒子图片宽,单位为像素,取值大于0 的整数,默认40,支持表达式。
height数值选填粒子图片高,单位为像素,取值大于0 的整数,默认40,支持表达式。

 

效果和代码展示

图片粒子化:提供多种参数的设置,在点击的时候将图片转换成粒子,并且根据震动的时间和不同的style,有一个抖动的效果和不同的粒子散落轨迹。

加载bz_icon.png图片其左上角位置为(100,100),长宽都缩放为100像素,并且转换成图片粒子,粒子的半径为5像素,圆形和方形混合,当点击的时候会有150ms的抖动并实现1000ms向上爆炸的特效。

 

 

笔刷-Paint

 

动效概述

笔刷需要与image标签共同使用,当手指滑动屏幕时可以擦除覆盖图片或覆盖颜色所在的图层,显示出背景图片所在图层。若color值不为空,则覆盖图层用颜色来填充,否则用Image图片来填充。注意,用image图片填充时,需要保证背景图片与笔刷覆盖层图片宽高相同(实际图片资源的宽高),以保证笔刷图片完全覆盖背景图。

 

场景举例

 

XML规范

 

参数说明

参 数类 型选 项注 释
x数值选填笔刷覆盖图层左上角相对于屏幕的x轴坐标,单位为像素,默认为0,支持表达式。
y数值选填笔刷覆盖图层左上角相对于屏幕的y轴坐标,单位为像素,默认为0,支持表达式。
w数值选填笔刷覆盖图层宽度,单位为像素。如果覆盖图层是图片,w无效,实际w为图片的宽度;
如果是颜色覆盖则必须填写w,否则默认为0,支持表达式。
h数值选填笔刷覆盖图层高度,单位为像素。如果覆盖图层是图片,h无效,实际h为图片的高度;
如果是颜色覆盖则必须填写h,否则默认为0,支持表达式。
src字符串选填笔刷覆盖层图片名称,若覆盖层为颜色填充则该值可不填写。
weight数值必填笔刷的粗细,单位为像素,值越大,笔刷越粗,值越小,笔刷越细,取正实数,默认为0,支持表达式。
color字符串选填如果覆盖图层想用颜色进行覆盖,则填写6或8位16进制颜色,如#afffffff。
clear_percent数值选填当覆盖图层被笔刷刷掉这个比例后,整个覆盖图层自动清除,显示背景图层。取值范围为1-100,
默认60,支持表达式。

 

效果和代码展示

笔刷动效示例一

覆盖图层是用颜色进行填充。可以看到笔刷功能中的Image未设置src,但是设置了color。

 

笔刷动效示例二

覆盖图层用图片进行填充。可以看到笔刷功能中的Image设置了src,但是未设置color。

 

下落动效-DropPhysicalView

 

动效概览

下落动效提供了一系列物体移动、旋转、透明度设置、移动区域设置的组合动效。对单张图片进行复用,减小相关内存的消耗。其中下落的动效符合物理规律,提供重力以及空气密度的设置项,能够随着物体大小和重力传感器的数值改变物体的运动轨迹。可以通过参数设置实现2D的下雨下雪、流星等动效。可以与传感器结合使用实现动效随手机移动的效果。

 

场景举例

 

XML规范

下落动效的总体框架是-DropPhysicalView,其主要属性是定义了整个视图中所有粒子元素的下落状态,其中gravity能够填写表达式,例如数值或者传感器数值等。

参 数类 型选 项注 释
gravityX数值选填x方向的重力数值,可以用数值表达式,默认值为0。该值大于0物体向右移动,小于0物体向左移动,为0时无x轴位移效果。
gravityY数值选填y方向的重力数值,可以用数值表达式,默认值为0。该值大于0物体向下移动,小于0物体向上移动,为0时无y轴位移效果。
airDensity数值选填空气密度,影响空气阻力的大小,值越大导致空气阻力越大,范围为正实数,默认值为12.93。面积较大的物体下落时所受的空气阻力较大,所以实际动效中w,h较小的物体比w,h大的物体移动速度略快一些。

-ItemGroup提供了整个粒子组的运行范围和透明度限定等,限定了粒子的运动轨迹以及表现形式。

参 数类 型选 项注 释
x数值选填运行范围的x起点,默认为0,支持数值表达式。
y数值选填运行范围的y起点,默认为0,支持数值表达式。
width数值选填运行范围的宽度,默认为屏幕宽度,支持数值表达式。
height数值选填运行范围的高度,默认为屏幕高度,支持数值表达式。

-Alpha是-ItemGroup的子标签,定义了粒子运行的透明度区域,默认透明度为255,即不透明,可以增加多个区域的透明度。

-Alpha参 数类 型选 项注 释
x数值选填透明度限制范围的x起点,默认为0,支持表达式。
y数值选填透明度限制范围的y起点,默认为0,支持表达式。
width数值选填透明度限制范围的宽度,默认为屏幕宽度,支持表达式。
height数值选填透明度限制范围的高度,默认为屏幕高度,支持表达式。
alphaStart数值选填透明度值,0~255,默认值为255,支持表达式。
alphaEnd数值选填透明度值,0~255,默认值为255,支持表达式。
direction字符串选填透明度变化方向,在区域内根据粒子的位置对物体透明度进行线性的变化,
值为(left, right, up, down)分别是向左. 右. 上. 下,物体透明度从alphaStart
根据位置和方向线性变化到alphaEnd。默认方向向上。

-Size标签定义了粒子运行的尺寸变化区域,在区域内的粒子尺寸由系数控制,可以增加多个区域的尺寸变化,如果不设置该区域则粒子保持其设置的尺寸。

-Size参 数类 型选 项注 释
x数值选填尺寸变化区域的x起点,默认为0,支持表达式。
y数值选填尺寸变化区域的y起点,默认为0,支持表达式。
width数值选填尺寸变化区域的宽度,默认为屏幕宽度,支持表达式。
height数值选填尺寸变化区域的高度,默认为屏幕高度,支持表达式。
sizeStart数值选填尺寸变化系数,0~1,默认值为0,支持表达式。
sizeEnd数值选填尺寸变化系数,0~1,默认值为1,支持表达式。
direction字符串选填尺寸变化方向,在区域内根据粒子的位置对物体尺寸进行线性的变化,
值为(left, right, up, down)分别是向左. 右. 上. 下,物体尺寸系数
从sizeStart根据位置和方向线性变化到sizeEnd。默认方向向上。

-Item定义了实际显示和运行的物体的参数和效果,能够通过不同的标签对物体进行修饰,影响物体的运行轨迹。

-Item参 数类 型选 项注 释
src字符串必填图片的源路径。
count数值选填物体的数量,正整数,默认为0。

说明

以下4个标签-Velocity,-Angle,-Position,-AngleVelocity为-Item的子标签,如果不设置,默认为随机。

-Velocity影响粒子的初始速度,能够设置随机,随机默认低点为0,如果不随机需要设置isRandom="false"。

-Velocity参 数类 型选 项注 释
isRandom字符串必填初始速度是否随机,true/false。
velocityX数值选填x方向初始速度,默认为0,支持表达式。不随机则x轴初始速度为该值,
随机则x轴初始速度为lowestVelocityX+[(0,velocityX)间随机值]。
velocityY数值选填y方向初始速度,默认为0,支持表达式.不随机则y轴初始速度为该值,
随机则x轴初始速度为lowestVelocityY+[(0,velocityY)间随机值]。
lowestVelocityX数值选填isRandom等于true时生效,为x轴随机初始速度最低值,默认为0,支持表达式。
lowestVelocityY数值选填isRandom等于true时生效,为y轴随机初始速度最低值,默认为0,支持表达式。

-Angle为物体的初始旋转角度,不设置则随机角度,如果禁止随机角度必须设置isRandom="false"。

-Angle参 数类 型选 项注 释
isRandom字符串必填初始旋转角度是否随机,true/false。
angle数值选填-360-360整数,不随机时生效,给每个粒子统一赋予同一个角度的旋转,默认为0。

-Position表示物体的初始位置,如果不设置则在ItemGroup的运行范围内随机生成,如果指定则初始位置为指定位置。

-Position 参 数类 型选 项注 释
isRandom字符串选填位置是否随机,true/false,默认false。
x数值选填初始位置的x坐标,不随机时有效,默认为0,支持表达式。
y数值选填初始位置的y坐标,不随机时有效,默认为0,支持表达式。

-AngleVelocity表示物体的旋转角速度,控制物体旋转速度的快慢,能够显示的设置物体随机旋转速度的大小。如果不写此标签则旋转速度的范围为0-30度。

-AngleVelocity 参 数类 型选 项注 释
isRandom字符串选填角速度是否随机,true/false,默认false。
angleVelocity数值选填物体旋转角速度,范围为-360-360,默认为0,支持表达式。不随机则物体的旋转角度为该值,如果随机则物体旋转角度为lowestAngleVelocity+[(0,angleVelocity)间随机值]。
lowestAngleVelocity数值选填物体最低旋转角速度,范围为-360-360,默认为0,支持表达式。仅当isRandom等于true时生效,为随机速度的最小值。

-weight为物体的大小设置,根据设置的值能够对生成的图大小进行缩放。如果不设置为不随机,则大小在0~1之间随机。

-weight参 数类 型选 项注 释
isRandom字符串选填是否随机缩放粒子,true/false,默认false。
value数值选填粒子图片的缩放比例,默认为1,支持表达式。如果不随机则统一设置物体缩放比例为该值,
随机则缩放比例是lowestWeight+[(0,value)间随机值]。
lowestWeight数值选填仅当isRandom等于true的时候才生效,为随机尺寸的最小值,默认为0.1。

-Trigger能够在标签Item中添加Trigger标签,同一个Item组的粒子在被点击时能够产生响应,并且执行Item中设置的所有命令。

 

效果和代码展示

下落动效示例一

雪花飘落效果,并能根据手机晃动实现粒子随手机摇摆运动。首先设置加速度传感器,得到x,y,z轴的加速度全局变量;在DropPhysicalview标签中使用x,y轴加速度作为x,y轴重力;在ItemGroup中设置粒子的作用范围为整个屏幕(0,0,screen_width,screen_height);设置了Alpha和Size两个渐变区域,在屏幕五分之一处开始到屏幕最下方结束,物体的透明度从255渐变到50,尺寸系数从1渐变到0.2;设置多个Item,xuehua.png图片的粒子个数为40,以5的速度下落,粒子的初始位置进行随机,雪花在下落过程中以10°的角速度进行旋转,图片在(0.1~0.6)范围内进行随机缩放;lingdang.png图片粒子个数为20,以5的速度下落,初始位置随机,下落时角度不变换,因为没有设置Angle标签,所以粒子的初始旋转角度是随机的,图片在(0.1~0.5)范围内进行缩放。对于xuehua.png这张图片来说,其中40个图片能够响应点击操作,点击将名称为test变量的值加一。

 

 

下落动效示例二

流星动效。设置DropPhysicalView的x轴重力为10,y轴重力为6;ItemGroup中设置流星动效范围为整个屏幕;设置两个Alpha区域,第一个Alpha区域使得流星在屏幕左上角为(700,0),右下角为(1080,#screen_height-1500)的矩形区域内透明度为100,第二个Alpha区域使得流星在在屏幕下方高为#screen_height-1500,宽为屏幕宽度的矩形区域内透明度为0;流星的x轴速度为10,y轴速度为6,初始位置随机,旋转角度AngleVelocity 和初始角度Angle 需要显式设置为0;流星图片在(0.1~0.3)范围内缩放。

 

全景锁屏-VR

 

动效概述

全景图片的360度全景功能。支持柱状和球状全景图的解析,支持根据手动或传感器方式改变全景视角。注意全景图片的显示会占满屏幕,与时间等其他功能叠加时需要至于底层避免遮挡;全局只支持一个全景功能,若脚本中编写多个全景功能,只识别第一个。

 

场景举例

 

XML规范

 

参数说明

参 数类 型选 项注 释
src字符串必填全景图片名称,目前仅支持jpg和png格式图片。
srcid数值选填全景图片序号,如src="vr.jpg",srcid="0",最终全景图片名称为"vr_0.jpg"。默认为0,支持变量,
可通过设置变量动态修改全景图片资源。注意全景图片的imageType需保持一致。
touchType数值选填改变全景视角方式,取值为0,1,2。0表示通过用户滑动屏幕动作改变全景视角,
1表示根据传感器数值改变全景视角,2表示混合模式,滑动和传感器可同时作用改变全景视角。
默认为0,支持表达式,可以使用变量切换改变全景视角方式。

说明

球状全景图宽高比需为2:1,建议大小为80004000,不能大于163848192及5M,不能小于3960*1980。柱状全景图宽高比需大于等于4:1,小于等于8:1,宽度不能大于16384,高度不能小于1980,图片不能大于5M。

 

效果和代码展示

全景锁屏示例一

全景功能中传入全景图vr06.jpg,通过变量#touchType动态切换控制全景视角改变方式(点击屏幕左上角切换)。锁屏界面中会显示全景图片,在全景图片上层会显示时间、日期等。滑动屏幕可以切换全景视角,也可以通过手势放大、缩小全景图片。

 

全景锁屏示例二

通过srcid切换全景图。准备vr_0.jpg、vr_1.jpg、vr_2.jpg三张全景图,注意这三张全景图需要有相同的imageType。当点击按钮0、1、2是可切换全景图片。不解锁熄屏再亮屏时显示熄屏前全景图;解锁后再次亮屏显示的是vr_0.jpg全景图。

 

延时解锁-DelayUnlock

 

动效概述

延时解锁基于Slider和ExternCommand功能实现,允许用户在执行解锁操作一定时间后(延迟时间)执行系统解锁命令。关键在于执行ExternCommand命令时增加延时参数delay,用于控制延迟解锁的时间。

 

场景举例

 

XML规范

 

参数说明

参数类 型选 项注释
command字符串必填通用命令标签,用于向外部程序发生解锁命令。
delay数值必填通用命令标签,用于向外部程序发生解锁命令,delay表明延迟解锁时间,单位为ms。

 

效果和代码展示

 

水波纹-WaterWallpaper

 

动效概述

点击屏幕产生全屏水波纹效果,网格分的越多,水波效果越细腻。不建议分太多网格,会消耗过多资源。

 

场景举例

背景为水或者与水相关的场景,皆可用水波纹动效。添加音效和震动,可使场景更加逼真。比如:

 

XML规范

 

参数说明

参 数类 型选 项注 释
xmesh数值选填x方向上分成多少网格,取值范围为1~100,默认值为27,支持数值表达式。
ymesh数值选填y方向上分成多少网格,取值范围为1~100,默认值为48,支持数值表达式。
src字符串选填图片资源名称,支持变量,如@abc。如果该参数为空,则会从lockscreen目录中取"default_lock_wallpaper.jpg"或”background.jpg",优先取前者。
torsion数值选填扭曲度,值越大,图片扭曲变形越大,水波纹效果越明显;取值范围1~10,
默认值为2,支持数值表达式。
color字符串选填触摸处顶点颜色,支持6位16进制颜色表示,如#0000ff。颜色透明度较小,
无特殊需求,建议不设置。

效果和代码展示

 

跟手粒子-ParticleView

 

动效概述

当手指在锁屏上滑动时,在滑动轨迹处会生成跟手粒子。粒子形状、颜色由输入的粒子图片控制,而粒子数量和大小等可通过参数进行设置。此外,还可以通过Range子标签来设置跟手粒子响应区域,即只有当手指滑动处于Range区域时,才生成跟手粒子。

 

场景举例

 

XML规范

 

参数说明

参 数类 型选 项注 释
w数值选填粒子宽度,取值正实数,默为60,支持数值表达式。
h数值选填粒子高度,宽高比例建议1:1,取值正实数,默为60,
支持数值表达式。
count数值选填每次滑动产生的粒子数量,取值为正整数,建议范围[1,30],
默认为6;数值太大会造成卡顿现象。
move_radius数值选填粒子在手指运动轨迹的基础上随机运动半径的反比例系数;
数值越大,粒子随机运动半径越小;取值范围为(1,屏幕宽度),
默认为16,支持数值表达式。
speek_sec数值选填单位时间粒子运动的距离,该值越大粒子消失越快。
取值正实数,默认为2.5,支持数值表达式。
reduce_size数值选填每次运动时粒子宽高缩小的尺寸,
取值正实数(设置过大会导致粒子消失太快),
取值范围[0.1,5],默认为3,支持数值表达式。
set_path字符串选填是否设置跟手粒子响应区域,true/false;true表示设置,
false表示不设置,默认false;如果为true,
需要在PathData标签中设置矩形区域。
src字符串必填粒子图片资源名称,生成跟手粒子时使用。
rect(副标签PathData用于解析输入的特定Range矩形区域)数值选填指定在该矩形区域内可生成跟手粒子,
示例:rect="left,top,right,bottom",
表示矩形左上右下对应的x、y坐标,
支持在PathData中设置多个区域。

说明

如果指定区域,只在特定的区域内才产生跟手粒子。矩形区域坐标信息用Rect(left,top,right,bottom)表示,其中left、top相当于矩形左上角坐标<x1,y1>; right,bottom相当于矩形右下角坐标<x2,y2>;那么矩形的x轴范围为x1-x2,y轴范围为y1-y2。

 

效果和代码展示

跟手粒子示例

该示例中未设置跟手粒子响应区域,默认全屏都可以产生跟手粒子。其中,生成的跟手粒子宽高为60像素,每次手指滑动产生6个粒子,运动轨迹上的粒子大小以3像素递减直至粒子宽高小于0时消失。

 

3D高级动效

3D旋转视图-StereoView

 

功能概述

StereoView作为3D旋转视图的根标签,可以包含若干个StereoGroup元素,StereoGroup为组的概念,并且只支持StereoGroup标签,其余无效,StereoGroup数量限制为 3 - 10个。

 

场景举例

 

XML规范

参 数类 型选 项注 释
sAngle数值选填旋转时两个页面的夹角,范围为0至180度
can3D数值选填是否支持3D旋转模式 1是3D旋转模式,0是非3D旋转模式
resistance数值选填旋转时的阻力效果,默认1.8,范围为0.1至10
fixed数值选填是否固定图片大小,默认为固定,填写1为取消固定。取消固定后,可在一个旋转的扇面上自由设置图片大小及位置

说明

-StereoGroup为组的概念,可以将多个标签组合起来,它所支持的标签有Image、Text、Button。

 

效果和脚本展示

 

立体图层-MultiLayer

 

动效概述

立体图层动效可以实现多个图层叠加的效果。根据设置的不同z值,展示图层的不同空间位置。与传感器标签结合使用,左右上下晃动手机时呈现相机角度变换的效果;或者通过左右上下滑动屏幕来改变相机的角度。交互方式可以通过自定义的方式来设计长按或者点击,来实现左右浏览或者调节图层远近。

说明

  1. 因该动效使用透视投影,坐标位置和大小与设置的z值有关。比如设置全屏展示的图片,在远处时展示的位置为屏幕的中心位置;当图片靠近贴近相机时就会全屏展示,若需要开始展示时图层全屏展示,图层需要设置超过屏幕宽高的值。
  2. 因OpenGL需要从远到近的顺序绘制图层,设计Layer标签时需要注意,详情见下面z值属性注释。
  3. 图层边缘与背景图的颜色处理一致,效果会更好。

 

场景举例

 

XML规范

MultiLayer的属性

参 数类  型选 项注 释
gravityX数值选填x方向的重力数值。使用表达式,与传感器标签-VariableBinders结合使用。
应用于模式0和2
gravityY数值选填y方向的重力数值。使用表达式,与传感器标签-VariableBinders标签结合使用。
应用于模式0和2
touchType数值选填图层交互模式,数值为0-3,支持表达式,默认值为0。目前共有4种模式:0,
重力感应模式;1,上下左右滑动改变相机角度模式;2,重力感应和滑动改变角度模式;
3,调节相机远近和左右浏览模式。
pitchAngle字符串选填俯视和仰视角度的最大值,通过上下滑动切换角度。取值为“top,-up”,top为正数,
up为正数,中间以英文逗号隔开。例如:"8,-8"。应用于模式1和2
sidesAngle字符串选填左侧和右侧角度的最大值,通过左右滑动切换角度。取值为“left,-right”,left为正数,
right为正数,中间以英文逗号隔开。例如:"8,-8"。应用于模式1和2
stepX数值选填图层左右浏览的步长,使用表达式计算累加/减,例如:#stepX+0.1。应用于模式3。
stepZ数值选填图层靠近远离的步长,使用表达式计算累加/减,例如:#stepZ+0.1。应用于模式3。
blur数值选填点击图层靠近时,渐变模糊程度,范围是[0,10],默认为0清晰。
visibility数值选填控制可见性,0 不可见 1可见,默认为1。

Layer的属性:

由于图片距离越远(即z值越小),图片则越小且x和y值也有偏差。若需要在远处也达到图片原始大小和位置一样的效果,需要对x和y以及宽高进行换算。关系换算如下:

例如图片原始属性:x=X,y=Y,w=W,h=H。空间各位置的图片属性如下:

设z=Z,z值范围[-10,7]

x=X*((10-Z)/3)-#screen_width/(6/(7-Z));

y=Y*((10-Z)/3)-#screen_height/(6/(7-Z));

w=W*((10-Z)/3);

h=H*((10-Z)/3);

说明

当z值为7时,不需要进行换算,可以直接显示图片大小和位置。

参 数类 型选 项注 释
x数值选填相对于屏幕左上角的x坐标,支持表达式,默认值为0。因透视投影的影响,
当在远处时显示的位置也不同,跟z值有关。
y数值选填相对于屏幕左上角的y坐标,支持表达式,默认值为0。因透视投影的影响,
当在远处时显示的位置也不同,跟z值有关。
z数值选填图层的空间位置,相机视野内的取值范围为[-10,7]之间的浮点数,支持表达式,
默认值为0。屏幕向外为正方向。因使用透视投影,物体显示效果为远小近大。
设计图层Layer标签时,需要根据z值从小到大赋值,即图层从远到近的顺序绘制。
w数值必填图片的宽,支持表达式,w和width写法都可以。
h数值必填图片的高,支持表达式,h和height写法都可以。
src字符串必填图片的资源,例如:bj.png
staticCondition字符串选填图层是否静态,不随相机位置改变,取值为true和false。为true时表示图层静态,
不发送改变。默认为false。
delay数值选填帧动画延迟播放属性,默认不延迟。
repeat数值选填帧动画重复次数,默认为无限重复。

Source的属性

参 数类 型选 项注 释
frame字符串必填帧动画图片资源,例如:zhen_1.png
time数值必填[0-~],相对于起始帧的间隔时间(毫秒),也是动画持续时间,帧图片人肉眼能识别时间延时为300ms左右,不小于0;

 

效果和代码展示

示例:该示例中通过按钮切换控制不同的交互模式,重力感应模式跟VariableBinders标签结合使用;设置角度变换模式的俯视仰视和左右侧角度的最大值;通过长按按钮控制图层靠近,抬起时图层远离,左右滑动控制图层左右浏览效果;近处的图层实现帧动画效果。

 

窗口视差-WindowParallax

 

动效概述

窗口视差动效需要窗口和底层2张图片,通过设置底层图片z轴深度,结合手机传感器,旋转手机时实现窗口望向底层图片的景深效果。

注意:使用视差动效时,wallpaper目录下默认壁纸需为纯色图片;在云主题中与缩放视差不可以紧挨着排列,即索引不能相接,中间必须有别的主题否则会有动效失效的情况,建议同一云主题不要同时含有这两种动效的主题。

 

场景举例

通过摇晃手机,可体验立体的视觉效果,比如:

 

XML规范

参 数类 型选 项注 释
posZ数值选填2层图片z值坐标,例如:“-3;-1.5”,第一个数值-3表示底层图片z值,
第二个数值-1.5表示上层图片z值,以“;”分隔。每层z值取值范围为(-5~0),
数值越小,底层距离屏幕越远,随手机晃动幅度越大,0表示不移动。默认值为“-3;0”。
参 数(LayerInfo)类 型选 项注 释
src字符串必填输入图片的名称。
x数值选填图片相对于屏幕左上角的x坐标,单位为px,默认为0。
y数值选填图片相对于屏幕左上角的y坐标,单位为px,默认为0。
w数值必填图片显示在屏幕上的宽,单位为px,支持表达式。
h数值必填图片显示在屏幕上的高,单位为px,支持表达式。

 

效果和代码展示

该示例中设置背景图片beijing.png的z轴深度为-1,因背景图片产生视差效果时会有上下左右的偏移,所以背景图片大小需超过屏幕大小。在晃动手机时有从窗口转换视角看向底层图片效果。

 

缩放视差-ScaleParallax

 

动效概述

缩放视差动效需要3层图片,与传感器结合,左右晃动手机时呈现视差效果。最底层图片随手机晃动呈中心旋转效果,中间与上层图根据设置的缩放与偏移参数晃动。

注意:wallpaper目录下默认壁纸需为纯色图片;在云主题中与窗口视差不可以紧挨着排列,即索引不能相接,中间必须有别的主题否则会有动效失效的情况,建议同一云主题不要同时含有这两种动效的主题。

 

场景举例

通过晃动手机,可使画面造成立体的感觉,比如:

 

XML规范

参 数类 型选 项注 释
radius数值选填底层图片可旋转部分半径,以屏幕中心为原点,半径取值范围为(0~1),默认为0.5,支持表达式。
rotateRate数值选填晃动手机时背景旋转幅度系数,默认为5,支持表达式。
translation数值选填中间和上层图片x轴位移幅度系数,中间层与上层以“;”分开,前一个数值表示中间层位移,第二个数值为上层图片位移。数值大于0表示向右旋转手机时图片向右移动,向左旋转手机时图片向左移动。数值小于0表示反向。默认为“1.3;-1”。
scale数值选填中间和上层图片x轴缩放幅度系数,中间层与上层以“;”分开,前一个数值表示中间层缩放系数,第二个数值为上层图片缩放系数。数值大于0表示向右旋转手机时图片放大,向左旋转手机时图片缩小。数值小于0表示相反。默认为“-1.2;1.2”。
blur数值必填上层图片模糊程度,取值范围为(0-24),默认为0。

 

效果和代码展示

该示例中设置旋转半径为0.5,旋转幅度系数为5,中间层位移和缩放系数分别为2和2,上层图片位移和缩放系数为-2和-2。向右旋转手机时,底层图片中间部分呈顺时针扭曲旋转,中间层图片随旋转角度增加而向右偏移并放大,上层图片随角度增大向左偏移并缩小。向左旋转手机时,底层图片中间部分呈逆时针扭曲旋转,中间层图片随旋转角度增加而向左偏移并缩小,上层图片随角度增大向右偏移并增大。

 

性能优化

制作主题时,除视觉效果外,还需考虑性能优化,以提供流畅的使用体验。

以下为一些性能优化经验,供您参考:

性能优化建议

 

脚本规模

xml脚本行数建议不要超过2000行。脚本量过大,加载解析所用时间可能过长,在CPU资源不足的情况下有可能出现亮屏时黑屏的情况。

 

文本视图

部分情况下,使用文本替代图片。例如:展示步数值时,用文本替代图片。

 

图片资源

  1. 动效中,单张图片尽可能小,大小不要超过1M。

  2. 在清晰度可行的条件下,不带透明像素的图片,建议使用jpg格式代替png格式。

  3. 图片尺寸尽量与显示尺寸一致:图片的尺寸不要大于显示的尺寸,即尺寸设计为可以看到的大小。

    正确示例:要显示的尺寸为400400px,则图片建议设计为400400px,不建议设计为800*800px。

 

视频/帧动画

  1. 尽量少用全屏帧动画,可使用视频-Video或者动态图片-APNG替代,或者将不需要动的部分抽取出来用静态图展示,需要动的部分制作为帧动画。

    使用视频时,为避免视频加载中出现黑屏问题,需配置一个image在视频加载完成前显示,图片为视频第一帧,以实现比较平滑的过渡效果。注意图片的位置和适配方式与视频保持一致,否则会出现首帧图片跳帧的问题。

  2. 视频被覆盖状态下不会停止播放,隐藏时才会停止播放。如需降低功耗,在视频不需要显示时,建议手动设置visibility参数,控制视频隐藏。

    正确示例:锁屏上设置视频播放,通过visibility的值隐藏当前不需要展示的视频。

  3. 帧动画被覆盖状态下不会停止播放,隐藏时才会停止播放。如需降低功耗,在视频不需要显示时,建议手动设置visibility参数,控制帧动画隐藏。

    正确示例:锁屏上共设置3组帧动画,通过visibility的值隐藏当前不需要展示的帧动画。

变量定义

  1. 变量先定义后使用。

    正确示例:先定义变量bl,然后再在Button中使用该变量。

     

  2. 不使用的变量不要定义,更不要做无意义的变量更新和赋值,减少内存和CPU的损耗。

     

  3. 不在亮屏或灭屏时做耗时性的变量计算,如调用

    周期命令-CycleCommand或命令组-GroupCommands执行脚本,否则会引起动画卡顿。

    错误示例:灭屏时调用周期命令,计算量大,耗时长,可能引起动画卡顿。

     

  4. 刷新频率较高的变量(如时间变量time/second、步数变量steps_value等)不要做持久化,否则可能有一定延迟,造成数据更新不及时。

    正确示例:步数变量steps_value未开启持久化,直接读取数据源的值。

    错误示例1:变量step,设置persist="true",开启持久化,将优先读取本地同名变量的值,而非直接读取数据源的值,前者可能有一定延迟,造成数据更新不及时。详见自定义变量的persist参数说明。

     

  5. 不重复使用表达式,以减少计算量。

    正确示例:先定义变量ratio的计算表达式ratio=max(1,#h/2536),后直接引用变量ratio的值。

    错误示例:重复使用表达式max(1,#h/2536),多次重复计算,增加内存损耗。

动画设计

1.利用单张图片实现基础动画,或者变量动画代替帧动画。

正确示例:四种基础动画在场景或者画面的过渡中使用。

正确示例:变量动画使用。

  1. 画面切换时添加过渡动画,提升用户体验。

正确示例:滑动切换图片,两层图片透明度变化,上层图渐变消失,底部图片渐变出现。

命令触发

  1. 当变量的值超过阈值时,触发命令(详见自定义变量的threshold参数说明),此时不要使用变化频率过高的全局变量(例:全局变量time/second)为变量赋值,否则将频繁触发命令,造成卡顿,无响应。

错误示例:定义一个变量kongzhi111,引用全局变量time(当前时间毫秒值)为其赋值,同时变量kongzhi111的值超过阈值1时,触发执行trigger中的多条复杂命令:给一系列变量进行运算和赋值。由于全局变量time的值变化频率高,频繁超过阈值1,导致trigger中的多条复杂命令执行频率高,造成卡顿,无响应的情况。

 

创意场景

趣味按压

 

动效概述

按压屏幕的某个位置超过一定时间,在该位置对动画进行展开播放,松手时会停止/倒放。

 

效果和代码展示

 

双粒子互动

 

动效概述

A区域或者物体可以影响B区域或者物体的状态。比如点击A,可以引起B爆炸。

 

素材准备

 

效果和代码展示

 

VR全景

 

动效概述

根据手动或传感器方式改变锁屏壁纸视角,实现全景图片的360度全景功能。

 

效果和代码展示

 

 

穿越动效

 

动效概述 通过长按或者点击的交互方式,来实现左右浏览或者调节图层远近,实现多个图层叠加的立体效果。

 

效果和代码展示

 

重力感应

 

动效概述 通过转动手机改变锁屏壁纸的视角。

 

效果和代码展示

 

摇一摇

 

动效概述 摇一摇触发手机动效,同时通过#shake变量控制动画的可见性。

 

效果和代码展示

 

时间感知

 

动效概述

通过主题中的多场景、全局化的时间变量,让用户感知时间的流逝。

 

效果和代码展示

 

返回顶部