test/awtk
1
0
Fork 0
mirror of https://gitee.com/zlgopen/awtk.git synced 2024-12-01 11:39:01 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
78d61c12c1
awtk/docs/manual/image_animation_t.md
xianjimli c831bfed8b update docs
2019-12-14 13:25:56 +08:00

542 lines
17 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## image\_animation\_t
### 概述
![image](images/image_animation_t_0.png)
图片动画控件，指定一个图片前缀，依次显示指定序列的图片，从而形成动画效果。
图片序列可以用sequence指定，也可以用start\_index和end\_index指定一个范围。
image\_animation\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于image\_animation\_t控件。
在xml中使用"image\_animation"标签创建图片动画控件。如：
```xml
<image_animation image="ani" start_index="1" end_index="9" auto_play="true" interval="50"
delay="100"/>
```
> 更多用法请参考：
[image_animation.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/default/raw/ui/image_animation.xml)
在c代码中使用函数image\_animation\_create创建图片动画控件。如：
```c
image_animation = image_animation_create(win, 10, 10, 200, 200);
image_animation_set_image(image_animation, "ani");
image_animation_set_interval(image_animation, 50);
image_animation_set_range_sequence(image_animation, 1, 9);
image_animation_play(image_animation);
```
> 完整示例请参考：
[image_animation
demo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/image_animation.c)
可用通过style来设置控件的显示风格，如背景颜色和边框等等，不过一般情况并不需要。
----------------------------------
### 函数
<p id="image_animation_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#image_animation_t_image_animation_cast">image\_animation\_cast</a> | 转换为image_animation对象(供脚本语言使用)。 |
| <a href="#image_animation_t_image_animation_create">image\_animation\_create</a> | 创建image_animation对象 |
| <a href="#image_animation_t_image_animation_next">image\_animation\_next</a> | 手动切换到下一张图片。 |
| <a href="#image_animation_t_image_animation_pause">image\_animation\_pause</a> | 暂停。 |
| <a href="#image_animation_t_image_animation_play">image\_animation\_play</a> | 播放。 |
| <a href="#image_animation_t_image_animation_set_auto_play">image\_animation\_set\_auto\_play</a> | 设置是否自动播放。 |
| <a href="#image_animation_t_image_animation_set_delay">image\_animation\_set\_delay</a> | 设置延迟播放时间(仅适用于自动播放)。 |
| <a href="#image_animation_t_image_animation_set_format">image\_animation\_set\_format</a> | 设置生成图片名的格式。 |
| <a href="#image_animation_t_image_animation_set_image">image\_animation\_set\_image</a> | 设置图片前缀。 |
| <a href="#image_animation_t_image_animation_set_interval">image\_animation\_set\_interval</a> | 设置播放间隔时间。 |
| <a href="#image_animation_t_image_animation_set_loop">image\_animation\_set\_loop</a> | 设置是否循环播放。 |
| <a href="#image_animation_t_image_animation_set_range_sequence">image\_animation\_set\_range\_sequence</a> | 设置播放序列。比如image为"fire"，start_index为0, end_index为99, 将依次播放"fire0", ..., |
| <a href="#image_animation_t_image_animation_set_sequence">image\_animation\_set\_sequence</a> | 设置播放序列。比如image为"fire"，sequence为"12223", 将依次播放"fire1", "fire2", "fire2", "fire2", |
| <a href="#image_animation_t_image_animation_set_unload_after_paint">image\_animation\_set\_unload\_after\_paint</a> | 设置绘制完成后unload图片，以释放内存空间。 |
| <a href="#image_animation_t_image_animation_stop">image\_animation\_stop</a> | 停止(并重置index为-1)。 |
### 属性
<p id="image_animation_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#image_animation_t_auto_play">auto\_play</a> | bool\_t | 是否自动播放。 |
| <a href="#image_animation_t_delay">delay</a> | uint32\_t | 自动播放时延迟播放的时间(毫秒)。 |
| <a href="#image_animation_t_end_index">end\_index</a> | uint32\_t | 图片结束序数。 |
| <a href="#image_animation_t_format">format</a> | char* | 索引到图片名转换时的格式，缺省为"%s%d"。 |
| <a href="#image_animation_t_image">image</a> | char* | 图片名称的前缀。 |
| <a href="#image_animation_t_interval">interval</a> | uint32\_t | 每张图片播放的时间(毫秒)。 |
| <a href="#image_animation_t_loop">loop</a> | bool\_t | 是否循环播放。 |
| <a href="#image_animation_t_sequence">sequence</a> | char* | 播放的序列，字符可选值为数字和英文大小写字母，字符可以重复。如：0123456789或者123123abcd。 |
| <a href="#image_animation_t_start_index">start\_index</a> | uint32\_t | 图片起始序数。 |
| <a href="#image_animation_t_unload_after_paint">unload\_after\_paint</a> | bool\_t | 绘制完成后unload图片，以释放内存空间。 |
#### image\_animation\_cast 函数
-----------------------
* 函数功能：
> <p id="image_animation_t_image_animation_cast">转换为image_animation对象(供脚本语言使用)。
* 函数原型：
```
widget_t* image_animation_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | image\_animation对象。 |
| widget | widget\_t* | image\_animation对象。 |
#### image\_animation\_create 函数
-----------------------
* 函数功能：
> <p id="image_animation_t_image_animation_create">创建image_animation对象
* 函数原型：
```
widget_t* image_animation_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | 对象。 |
| parent | widget\_t* | 父控件 |
| x | xy\_t | x坐标 |
| y | xy\_t | y坐标 |
| w | wh\_t | 宽度 |
| h | wh\_t | 高度 |
#### image\_animation\_next 函数
-----------------------
* 函数功能：
> <p id="image_animation_t_image_animation_next">手动切换到下一张图片。
* 函数原型：
```
ret_t image_animation_next (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image\_animation对象。 |
#### image\_animation\_pause 函数
-----------------------
* 函数功能：
> <p id="image_animation_t_image_animation_pause">暂停。
* 函数原型：
```
ret_t image_animation_pause (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image\_animation对象。 |
#### image\_animation\_play 函数
-----------------------
* 函数功能：
> <p id="image_animation_t_image_animation_play">播放。
* 函数原型：
```
ret_t image_animation_play (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image\_animation对象。 |
#### image\_animation\_set\_auto\_play 函数
-----------------------
* 函数功能：
> <p id="image_animation_t_image_animation_set_auto_play">设置是否自动播放。
* 函数原型：
```
ret_t image_animation_set_auto_play (widget_t* widget, bool_t auto_play);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image\_animation对象。 |
| auto\_play | bool\_t | 是否自动播放。 |
#### image\_animation\_set\_delay 函数
-----------------------
* 函数功能：
> <p id="image_animation_t_image_animation_set_delay">设置延迟播放时间(仅适用于自动播放)。
* 函数原型：
```
ret_t image_animation_set_delay (widget_t* widget, uint32_t delay);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image\_animation对象。 |
| delay | uint32\_t | 延迟播放时间(毫秒)。 |
#### image\_animation\_set\_format 函数
-----------------------
* 函数功能：
> <p id="image_animation_t_image_animation_set_format">设置生成图片名的格式。
XXX:生成图片名时，第一个参数是图片名前缀，第二个是序数，只能在此前提下设置格式。
```
const char* format = image_animation->format ? image_animation->format : "%s%d";
tk_snprintf(name, TK_NAME_LEN, format, image_animation->image, image_animation->index);
```
* 函数原型：
```
ret_t image_animation_set_format (widget_t* widget, const char* format);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image\_animation对象。 |
| format | const char* | 格式。 |
#### image\_animation\_set\_image 函数
-----------------------
* 函数功能：
> <p id="image_animation_t_image_animation_set_image">设置图片前缀。
* 函数原型：
```
ret_t image_animation_set_image (widget_t* widget, const char* image);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image\_animation对象。 |
| image | const char* | 图片前缀。 |
#### image\_animation\_set\_interval 函数
-----------------------
* 函数功能：
> <p id="image_animation_t_image_animation_set_interval">设置播放间隔时间。
* 函数原型：
```
ret_t image_animation_set_interval (widget_t* widget, uint32_t interval);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image\_animation对象。 |
| interval | uint32\_t | 间隔时间(毫秒)。 |
#### image\_animation\_set\_loop 函数
-----------------------
* 函数功能：
> <p id="image_animation_t_image_animation_set_loop">设置是否循环播放。
* 函数原型：
```
ret_t image_animation_set_loop (widget_t* widget, bool_t loop);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image\_animation对象。 |
| loop | bool\_t | 是否循环播放。 |
#### image\_animation\_set\_range\_sequence 函数
-----------------------
* 函数功能：
> <p id="image_animation_t_image_animation_set_range_sequence">设置播放序列。比如image为"fire"，start_index为0, end_index为99, 将依次播放"fire0", ...,
"fire99"。
若指定的图片不存在，则重复上一张图片。
* 函数原型：
```
ret_t image_animation_set_range_sequence (widget_t* widget, uint32_t start_index, uint32_t end_index);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image\_animation对象。 |
| start\_index | uint32\_t | 图片起始序数。 |
| end\_index | uint32\_t | 图片结束序数。 |
#### image\_animation\_set\_sequence 函数
-----------------------
* 函数功能：
> <p id="image_animation_t_image_animation_set_sequence">设置播放序列。比如image为"fire"，sequence为"12223", 将依次播放"fire1", "fire2", "fire2", "fire2",
"fire3"。
* 函数原型：
```
ret_t image_animation_set_sequence (widget_t* widget, const char* sequence);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image\_animation对象。 |
| sequence | const char* | 播放序列。 |
#### image\_animation\_set\_unload\_after\_paint 函数
-----------------------
* 函数功能：
> <p id="image_animation_t_image_animation_set_unload_after_paint">设置绘制完成后unload图片，以释放内存空间。
* 函数原型：
```
ret_t image_animation_set_unload_after_paint (widget_t* widget, bool_t unload_after_paint);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image\_animation对象。 |
| unload\_after\_paint | bool\_t | 是否绘制完成后unload图片。 |
#### image\_animation\_stop 函数
-----------------------
* 函数功能：
> <p id="image_animation_t_image_animation_stop">停止(并重置index为-1)。
* 函数原型：
```
ret_t image_animation_stop (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image\_animation对象。 |
#### auto\_play 属性
-----------------------
> <p id="image_animation_t_auto_play">是否自动播放。
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### delay 属性
-----------------------
> <p id="image_animation_t_delay">自动播放时延迟播放的时间(毫秒)。
* 类型：uint32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### end\_index 属性
-----------------------
> <p id="image_animation_t_end_index">图片结束序数。
* 类型：uint32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### format 属性
-----------------------
> <p id="image_animation_t_format">索引到图片名转换时的格式，缺省为"%s%d"。
* 类型：char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### image 属性
-----------------------
> <p id="image_animation_t_image">图片名称的前缀。
* 类型：char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### interval 属性
-----------------------
> <p id="image_animation_t_interval">每张图片播放的时间(毫秒)。
* 类型：uint32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### loop 属性
-----------------------
> <p id="image_animation_t_loop">是否循环播放。
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### sequence 属性
-----------------------
> <p id="image_animation_t_sequence">播放的序列，字符可选值为数字和英文大小写字母，字符可以重复。如：0123456789或者123123abcd。
* 类型：char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### start\_index 属性
-----------------------
> <p id="image_animation_t_start_index">图片起始序数。
* 类型：uint32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### unload\_after\_paint 属性
-----------------------
> <p id="image_animation_t_unload_after_paint">绘制完成后unload图片，以释放内存空间。
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
Reference in New Issue View Git Blame Copy Permalink