Class Rect

用于记录素材在视频或画布中的空间属性：位置、大小、旋转

并提供控制点位置，支持用户在画布中缩放、旋转素材

一般由内部 WebAV SDK 内部创建维护

See

Implements

IRectBaseProps

Index

Constructors

constructor

new Rect(x?, y?, w?, h?, master?): Rect
Parameters
- Optional x: number
- Optional y: number
- Optional w: number
- Optional h: number
- Optional master: null | Rect
Returns Rect
- Defined in packages/av-cliper/src/sprite/rect.ts:157

Properties

`Private` #angle

#angle: number = 0

`Private` #evtTool

#evtTool: EventTool<{
propsChange: ((props) => void);
}> = ...

Type declaration

propsChange: ((props) => void)
- - (props): void
  - Parameters
    - props: Partial<IRectBaseProps>
    Returns void

`Private` #h

#h: number = 0

`Private` #w

#w: number = 0

`Private` #x

#x: number = 0

`Private` #y

#y: number = 0

fixedAspectRatio

fixedAspectRatio: boolean = false

是否保持固定宽高比例，禁止变形缩放

值为 true 时，Rect.ctrls 将缺少上下左右四个控制点

master

master: null | Rect = null

如果当前实例是 Rect 控制点（Rect.ctrls）之一，master 将指向该 Rect

控制点的坐标是相对于它的 master 定位到

on

on: (<Type>(type, listener) => (() => void)) = ...

监听属性变更事件

Type declaration

- <Type>(type, listener): (() => void)
- Type Parameters
  - Type extends "propsChange"
  Parameters
  - type: Type
  - listener: {
    propsChange: ((props) => void);
    }[Type]
  Returns (() => void)
  - - (): void
    - Returns void

Example

rect.on('propsChange', (changedProps) => {})

`Static` `Readonly` CTRL_KEYS

CTRL_KEYS: readonly ["t", "b", "l", "r", "lt", "lb", "rt", "rb", "rotate"] = ...

控制点：上、下、左、右，左上、左下、右上、右下、旋转

`Static` CTRL_SIZE

CTRL_SIZE: number = 16

统一设置所有 Rect.ctrls 的边长

⚠️ 交给 AVCanvas 设置，不要随意改变它的值

Accessors

angle

get angle(): number
旋转角度

Returns number
See
MDN Canvas rotate
Implementation of IRectBaseProps.angle
- Defined in packages/av-cliper/src/sprite/rect.ts:111
set angle(v): void
Parameters
- v: number
Returns void
Implementation of IRectBaseProps.angle
- Defined in packages/av-cliper/src/sprite/rect.ts:114

center

get center(): IPoint
根据坐标、宽高计算出来的矩形中心点

Returns IPoint
- Defined in packages/av-cliper/src/sprite/rect.ts:174

ctrls

get ctrls(): {
    b?: undefined;
    l?: undefined;
    lb: Rect;
    lt: Rect;
    r?: undefined;
    rb: Rect;
    rotate: Rect;
    rt: Rect;
    t?: undefined;
} | {
    b: Rect;
    l: Rect;
    lb: Rect;
    lt: Rect;
    r: Rect;
    rb: Rect;
    rotate: Rect;
    rt: Rect;
    t: Rect;
}
根据坐标、宽高计算出来的矩形控制点

Rect.fixedAspectRatio = true 时，将缺少上下左右(t,b,l,r)四个控制点

Returns {
    b?: undefined;
    l?: undefined;
    lb: Rect;
    lt: Rect;
    r?: undefined;
    rb: Rect;
    rotate: Rect;
    rt: Rect;
    t?: undefined;
} | {
    b: Rect;
    l: Rect;
    lb: Rect;
    lt: Rect;
    r: Rect;
    rb: Rect;
    rotate: Rect;
    rt: Rect;
    t: Rect;
}
- Defined in packages/av-cliper/src/sprite/rect.ts:191

h

get h(): number
高

Returns number
Implementation of IRectBaseProps.h
- Defined in packages/av-cliper/src/sprite/rect.ts:100
set h(v): void
Parameters
- v: number
Returns void
Implementation of IRectBaseProps.h
- Defined in packages/av-cliper/src/sprite/rect.ts:103

w

get w(): number
宽

Returns number
Implementation of IRectBaseProps.w
- Defined in packages/av-cliper/src/sprite/rect.ts:90
set w(v): void
Parameters
- v: number
Returns void
Implementation of IRectBaseProps.w
- Defined in packages/av-cliper/src/sprite/rect.ts:93

x

get x(): number
x 坐标

Returns number
Implementation of IRectBaseProps.x
- Defined in packages/av-cliper/src/sprite/rect.ts:70
set x(v): void
Parameters
- v: number
Returns void
Implementation of IRectBaseProps.x
- Defined in packages/av-cliper/src/sprite/rect.ts:73

y

get y(): number
Returns number
Implementation of IRectBaseProps.y
- Defined in packages/av-cliper/src/sprite/rect.ts:77
set y(v): void
y 坐标
Parameters
- v: number
Returns void
Implementation of IRectBaseProps.y
- Defined in packages/av-cliper/src/sprite/rect.ts:83

Methods

`Private` #setBaseProps

#setBaseProps(prop, v): void
Parameters
- prop: keyof IRectBaseProps
- v: number
Returns void
- Defined in packages/av-cliper/src/sprite/rect.ts:118

checkHit

checkHit(tx, ty): boolean
检测目标坐标是否命中当前实例
Parameters
- tx: number
  目标点 x 坐标
- ty: number
  目标点 y 坐标
Returns boolean
- Defined in packages/av-cliper/src/sprite/rect.ts:234

clone

clone(): Rect
Returns Rect
- Defined in packages/av-cliper/src/sprite/rect.ts:221

Class Rect

See

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Rect

Properties

Private #angle

Private #evtTool

Type declaration

propsChange: ((props) => void)

Parameters

Returns void

Private #h

Private #w

Private #x

Private #y

fixedAspectRatio

master

on

Type declaration

Type Parameters

Parameters

Returns (() => void)

Returns void

Example

Static Readonly CTRL_KEYS

Static CTRL_SIZE

Accessors

angle

Returns number

See

Parameters

Returns void

center

Returns IPoint

ctrls

Returns { b?: undefined; l?: undefined; lb: Rect; lt: Rect; r?: undefined; rb: Rect; rotate: Rect; rt: Rect; t?: undefined; } | { b: Rect; l: Rect; lb: Rect; lt: Rect; r: Rect; rb: Rect; rotate: Rect; rt: Rect; t: Rect; }

h

Returns number

Parameters

Returns void

w

Returns number

Parameters

Returns void

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

Methods

Private #setBaseProps

Parameters

Returns void

checkHit

Parameters

Returns boolean

clone

Returns Rect

Settings

Member Visibility

Theme

On This Page

`Private` #angle

`Private` #evtTool

`Private` #h

`Private` #w

`Private` #x

`Private` #y

`Static` `Readonly` CTRL_KEYS

`Static` CTRL_SIZE

Returns {
b?: undefined;
l?: undefined;
lb: Rect;
lt: Rect;
r?: undefined;
rb: Rect;
rotate: Rect;
rt: Rect;
t?: undefined;
} | {
b: Rect;
l: Rect;
lb: Rect;
lt: Rect;
r: Rect;
rb: Rect;
rotate: Rect;
rt: Rect;
t: Rect;
}

`Private` #setBaseProps