awtk/docs/manual/rect_t.md

183 lines
3.3 KiB
Markdown
Raw Normal View History

2018-12-20 17:33:31 +08:00
## rect\_t
### 概述
矩形。包括一个x坐标、y坐标、宽度和高度。
2019-08-24 10:35:53 +08:00
2019-01-15 14:34:05 +08:00
----------------------------------
2019-01-12 11:52:46 +08:00
### 函数
<p id="rect_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
2019-01-14 11:38:31 +08:00
| <a href="#rect_t_rect_cast">rect\_cast</a> | 转换为rect对象。 |
2019-01-12 11:52:46 +08:00
| <a href="#rect_t_rect_create">rect\_create</a> | 创建rect对象。 |
| <a href="#rect_t_rect_destroy">rect\_destroy</a> | |
2019-01-14 11:38:31 +08:00
| <a href="#rect_t_rect_set">rect\_set</a> | 设置rect对象的xywh。 |
2018-12-20 17:33:31 +08:00
### 属性
<p id="rect_t_properties">
2019-01-17 15:56:15 +08:00
| 属性名称 | 类型 | 说明 |
2018-12-20 17:33:31 +08:00
| -------- | ----- | ------------ |
2018-12-21 18:29:29 +08:00
| <a href="#rect_t_h">h</a> | wh\_t | 高度。 |
| <a href="#rect_t_w">w</a> | wh\_t | 宽度。 |
| <a href="#rect_t_x">x</a> | xy\_t | x坐标。 |
| <a href="#rect_t_y">y</a> | xy\_t | y坐标。 |
2019-01-14 11:38:31 +08:00
#### rect\_cast 函数
-----------------------
* 函数功能:
> <p id="rect_t_rect_cast"> 转换为rect对象。
> 供脚本语言使用。
2019-08-24 10:35:53 +08:00
2019-01-14 11:38:31 +08:00
* 函数原型:
```
rect_t* rect_cast (rect_t* rect);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | rect\_t* | rect对象。 |
| rect | rect\_t* | rect对象。 |
2019-01-12 11:52:46 +08:00
#### rect\_create 函数
-----------------------
* 函数功能:
> <p id="rect_t_rect_create"> 创建rect对象。
> 主要供脚本语言使用。
2019-08-24 10:35:53 +08:00
2019-01-12 11:52:46 +08:00
* 函数原型:
```
rect_t* rect_create (xy_t x, xy_t y, wh_t w, wh_t h);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | rect\_t* | rect对象。 |
| x | xy\_t | x坐标。 |
| y | xy\_t | y坐标。 |
| w | wh\_t | 宽度。 |
| h | wh\_t | 高度。 |
#### rect\_destroy 函数
-----------------------
* 函数功能:
> <p id="rect_t_rect_destroy">
销毁rect对象。
> 主要供脚本语言使用。
2019-08-24 10:35:53 +08:00
2019-01-12 11:52:46 +08:00
* 函数原型:
```
ret_t rect_destroy (rect_t* r);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| r | rect\_t* | rect对象。 |
2019-01-14 11:38:31 +08:00
#### rect\_set 函数
-----------------------
* 函数功能:
> <p id="rect_t_rect_set"> 设置rect对象的xywh。
> 主要供脚本语言使用。
2019-08-24 10:35:53 +08:00
2019-01-14 11:38:31 +08:00
* 函数原型:
```
rect_t* rect_set (rect_t* rect, xy_t x, xy_t y, wh_t w, wh_t h);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | rect\_t* | rect对象。 |
| rect | rect\_t* | rect对象。 |
| x | xy\_t | x坐标。 |
| y | xy\_t | y坐标。 |
| w | wh\_t | 宽度。 |
| h | wh\_t | 高度。 |
2018-12-20 17:33:31 +08:00
#### h 属性
-----------------------
2018-12-21 11:39:05 +08:00
> <p id="rect_t_h"> 高度。
2018-12-20 17:33:31 +08:00
2019-08-24 10:35:53 +08:00
2018-12-20 17:33:31 +08:00
* 类型wh\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
2019-01-14 11:38:31 +08:00
| 可脚本化 | 是 |
2018-12-20 17:33:31 +08:00
#### w 属性
-----------------------
2018-12-21 11:39:05 +08:00
> <p id="rect_t_w"> 宽度。
2018-12-20 17:33:31 +08:00
2019-08-24 10:35:53 +08:00
2018-12-20 17:33:31 +08:00
* 类型wh\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
2019-01-14 11:38:31 +08:00
| 可脚本化 | 是 |
2018-12-20 17:33:31 +08:00
#### x 属性
-----------------------
2018-12-21 11:39:05 +08:00
> <p id="rect_t_x"> x坐标。
2018-12-20 17:33:31 +08:00
2019-08-24 10:35:53 +08:00
2018-12-20 17:33:31 +08:00
* 类型xy\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
2019-01-14 11:38:31 +08:00
| 可脚本化 | 是 |
2018-12-20 17:33:31 +08:00
#### y 属性
-----------------------
2018-12-21 11:39:05 +08:00
> <p id="rect_t_y"> y坐标。
2018-12-20 17:33:31 +08:00
2019-08-24 10:35:53 +08:00
2018-12-20 17:33:31 +08:00
* 类型xy\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
2019-01-14 11:38:31 +08:00
| 可脚本化 | 是 |