aardio 文档

builtin.struct 库模块帮助文档

结构体定义

aardio 已默认定义以下结构体：

class ::POINT {
   ctor(x=0,y=0){
      this.x = x;
      this.y = y;
   } 
   int x ; 
   int y ;
}

class ::SIZE {
    ctor(cx=0,cy=0){
      this.cx = cx;
      this.cy = cy;
    }
    int cx;
    int cy;
} 

class ::RECT {
    ctor(left=0,top=0,right=0,bottom=0){
        this.left = left;
        this.top = top;
        this.right = right;
        this.bottom = bottom; 
    } 
    int left;
    int top;
    int right;
    int bottom;
    @_meta;
}

pointObject 成员列表

::POINT 结构体对象，包含用于表示坐标的数值字段 x,y

pointObject.x

x坐标

pointObject.y

y坐标

rectObject 成员列表

::RECT 结构体对象，包含用于表示区块位置的数值字段 left,top,right,bottom

rectObject.bottom

下

rectObject.contains(x,y)

检测指定的 x,y 坐标是否位于矩形区块内

rectObject.copy

复制并返回新的矩形区块结构体

rectObject.copy()

返回对象:rectObject

rectObject.copy(width,height)

可选在参数中指定新的宽度、高度
所有参数都可以省略

rectObject.expand

扩展或缩小右下角坐标

rectObject.expand()

返回对象:rectObject

rectObject.expand(dx,dy)

dx指定正数扩展右边,负数缩小右边,
dy指定正数扩展底边,负数缩小底边
左上角不变,
返回自身

rectObject.float()

无参数时转换为 ::RECTF 结构体并返回该结构体
如果参数中指定::RECTF结构体,则使用参数更新位区块自身,
指定参数则此函数无返回值

返回对象:rectfObject

rectObject.height()

高度

rectObject.inflate

扩大区块并返回矩形区块自身

rectObject.inflate()

返回对象:rectObject

rectObject.inflate(左右单位,上下单位)

扩大区块并返回矩形区块自身
忽略参数请传入0,不可省略
上,下,左,右分别扩大指定的单位
负数为缩小

rectObject.intersect

检测与参数指定的矩形区块相交

rectObject.intersect(rc)

检测与参数指定的矩形区块相交
成功修改当前区块并返回自身,失败返回空

rectObject.intersectsWith

检测两个矩形区块是否碰撞相交

rectObject.intersectsWith(rc)

检测两个矩形区块是否碰撞相交

rectObject.left

左

rectObject.ltrb

用于将 x,y,width,height 转换为 left,top,right.bottom 并返回

rectObject.ltrb()

返回结构体的 left,top,right,bottom 等4个值

rectObject.ltrb(x,y,width,height)

使用传入参数修改左、上坐标,以及宽度、高度,
返回结构体的left,top,right,bottom等4个值

rectObject.move

移动左上角坐标

rectObject.move()

返回对象:rectObject

rectObject.move(dx,dy)

使用参数指定的x,y坐标偏移量移动左上角坐标,
正数向右下移动,负数向左上移动,
右下角位置不变
返回自身
如果需要移动坐标且大小不变请改用offset函数
移动到指定坐标而不是偏移量请改用setPos函数

rectObject.offset

移动矩形框并返回自身

rectObject.offset()

返回对象:rectObject

rectObject.offset(横偏移,纵偏移)

移动矩形框并返回自身,矩形大小不变,
左上移使用负坐标,右下移使用正坐标
忽略参数请传入0,不可省略

rectObject.right

右

rectObject.setPos

重新调整坐标与大小,
返回结构体自身

rectObject.setPos()

返回对象:rectObject

rectObject.setPos(x,y,cx,cy)

移动到x,y指定的坐标,
可选用cx,cy重新指定宽度和高度,
所有参数可选,不指定则保持旧值

rectObject.top

上

rectObject.width()

宽度

rectObject.xywh

用于将left,top,right.bottom转换为 x,y,width,height 并返回

rectObject.xywh()

返回结构体的左上角坐标x,y 以及宽度width,高度height等4个值

rectObject.xywh(left,top,right,bottom)

修改左、上、右、下的值,
返回结构体的左上角坐标x,y 以及宽度width,高度height等4个值

sizeObject 成员列表

::SIZE 结构体对象，包含用于表示大小的数值字段 cx,cy

sizeObject.cx

宽

sizeObject.cy

高

全局常量

::OffsetRect(rc,dx,dy)

移动矩形框，
此函数已废弃，请直接调用 rc.offset 函数

::POINT

整型坐标结构体
此结构体通过标准库 builtin.struct 默认加载

::POINT()

返回对象:pointObject

::POINT(x,y)

创建整型坐标结构体
可选在参数中指定 x,y 坐标初始值

::RECT

表示矩形区块的结构体
此结构体通过标准库 builtin.struct 默认加载

::RECT()

返回对象:rectObject

::RECT(left,top,right,bottom)

创建矩形区块结构体
可选在参数中指定左,上,右,下初始值

::SIZE

整型尺寸结构体
此结构体通过标准库 builtin.struct 默认加载

::SIZE()

返回对象:sizeObject

::SIZE(cx,cy)

创建整型尺寸结构体
可选在参数中指定宽高 cx,cy 初始值

Markdown 格式