API界面 / FlipBook
FlipBook Class
帧动画控件
Hierarchy
↳
FlipBook
Table of contents
Properties
click
Properties
onCustomPropertyChange: Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> client |
|---|
| 监听自定义属性同步事件 |
Accessors
columns(): number client |
|---|
| 帧图片有效分割列数 >=1 |
currentFrameIndex(): number client |
| 帧动画当前播放到第几帧 |
framesPerSecond(): number client |
| 帧动画每秒播放多少张帧图片 >0 |
imageInfo(): ImageInfo client |
| 图片资源信息 |
isLoop(): boolean client |
| 帧动画是否循环播放 |
onFinish(): MulticastDelegate<() => void> client |
| 帧动画完整播放完回调，触发条件，播放到最后一帧，并且播放状态是Playing |
rows(): number client |
| 帧图片有效分割行数 >=1 |
status(): PlayStatus client |
| 帧动画播放状态 |
totalFrames(): number client |
| 帧图片最大分割的有效播放帧数,大于0并且小于（行数X列数） |
click
Accessors
alignPosition(): Readonly<Vector2> client |
|---|
| 获取控件的对齐位置,在对齐方式为靠右对齐、靠下对齐、中心对齐时，alignPosition的值与positon不同； |
autoSizeHorizontalEnable(): boolean client |
| 获取是否自动水平设置大小 |
autoSizeVerticalEnable(): boolean client |
| 获取是否自动垂直设置大小 |
cachedGeometry(): Geometry client |
| 获取上一次的GetTickSpaceGeometry |
constraints(): Readonly<UIConstraintAnchors> client |
| 获取控件的布局 |
desiredSize(): Vector2 client |
| 获取期望大小 |
enable(): boolean client |
| 是否可用 |
guid(): string client |
| 获取控件GUID |
isHovered(): boolean client |
| 是否是hovered |
mouseCursor(): MouseCursor client |
| 获取控件上光标类型 |
name(): string client |
| 获取名字 |
paintSpaceGeometry(): Geometry client |
| 获取最后一次用于渲染Widget的几何信息 |
parent(): Widget client |
| 获取父节点 |
pivot(): Vector2 client |
| 获取控件锚点位置,这个属性决定了控件图形与锚点的相对位置；(0,0)时，锚点位于控件左上角；(0.5,0.5)时，锚点位于控件正中心 |
position(): Readonly<Vector2> client |
| 获取控件的位置 |
renderOpacity(): number client |
| 获取渲染透明度 |
renderScale(): Vector2 client |
| 获取渲染缩放 |
renderShear(): Vector2 client |
| 获取渲染错切形变 |
renderTransformAngle(): number client |
| 获取渲染的角度 |
renderTransformPivot(): Vector2 client |
| 获取渲染锚点 |
size(): Vector2 client |
| 获取大小 |
tickSpaceGeometry(): Geometry client |
| 获取最后一次用于驱动Widget Tick的几何信息 |
transform(): Readonly<UITransform> client |
| 得到控件的大小和位置 |
visibility(): SlateVisibility client |
| 获取可见性 |
visible(): boolean client |
| 是否可见 |
zOrder(): number client |
| 获取zorder |
Methods
pause(): void client |
|---|
| 帧动画播放暂停 |
play(): void client |
| 帧动画播放 |
resume(): void client |
| 帧动画播放恢复暂停，继续播放 |
stop(): void client |
| 帧动画播放停止 |
newObject(parent?: Canvas, inName?: string): FlipBook client |
| 创建 FlipBook 控件 |
click
Methods
addChild(child: Widget): void client |
|---|
| 添加子节点 |
clone(position: Vector2, Parent?: Widget): Widget client |
| 克隆UI控件及其子节点到指定父控件位置（默认到其父节点） |
destroyObject(): void client |
| 立刻移除并销毁 不可以在使用 |
equal(that: Widget): boolean client |
| 判断是不是同一个对象 |
findChildByPath(inPath: string): Widget client |
| 通过相对路径查找节点 |
getChildAt(index: number): Widget client |
| 获取第几位子节点 |
getChildByName<T: extends Widget<T>>(name: string): T: extends Widget<T> client |
| 通过名字查找节点 |
getChildrenCount(): number client |
| 获取子节点数量 |
getCustomProperties(): string[] client |
| 获取所有自定义属性 |
getCustomProperty<T: extends CustomPropertyType>(propertyName: string): T: extends CustomPropertyType client |
| 获取自定义属性 |
getCustomPropertyChangeDelegate(property): Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> client |
| 给定对象属性修改时触发的事件代理 |
invalidateLayoutAndVolatility(): void client |
| 立刻触发重新渲染的和排布计算 |
removeAllChildren(): void client |
| 清除所有子节点,会销毁UI无法再使用 |
removeChild(child: Widget): void client |
| 移除节点,会销毁UI无法在使用 |
removeChildAt(index: number): void client |
| 移除第几个节点,会销毁UI无法再使用 |
removeObject(): void client |
| 立刻移除并添加到根节点 可以再使用 |
serialize(): string client |
| 序列化UI控件 |
setCustomProperty(propertyName: string, value: undefined CustomPropertyType): void client |
| 设置自定义属性 |
deserialize(Data: string, Parent?: Widget): Widget client |
| 反序列化UI |
Properties
Accessors
columns
• | • | ||||
|---|---|---|---|---|---|
帧图片有效分割列数 >=1 Returns
| 帧图片有效分割列数 >=1 Parameters
|
currentFrameIndex
• | • | ||||
|---|---|---|---|---|---|
帧动画当前播放到第几帧 Returns
| 设置帧动画当前播放到第几帧,小于最大有效帧图片数 Parameters
|
framesPerSecond
• | • | ||||
|---|---|---|---|---|---|
帧动画每秒播放多少张帧图片 >0 Returns
| 帧动画每秒播放多少张帧图片 > 0 Parameters
|
imageInfo
• | ||
|---|---|---|
图片资源信息 Returns
|
isLoop
• | • | ||||
|---|---|---|---|---|---|
帧动画是否循环播放 Returns
| 帧动画是否循环播放 Parameters
|
onFinish
• | ||
|---|---|---|
帧动画完整播放完回调，触发条件，播放到最后一帧，并且播放状态是Playing Returns
|
rows
• | • | ||||
|---|---|---|---|---|---|
帧图片有效分割行数 >=1 Returns
| 帧图片有效分割行数 >=1 Parameters
|
status
• | ||
|---|---|---|
帧动画播放状态 Returns
|
totalFrames
• | • | ||||
|---|---|---|---|---|---|
帧图片最大分割的有效播放帧数,大于0并且小于（行数X列数） Returns
| 帧图片最大分割的有效播放帧数,大于0并且小于（行数X列数） Parameters
|
Methods
pause
• pause(): void client
帧动画播放暂停
play
• play(): void client
帧动画播放
resume
• resume(): void client
帧动画播放恢复暂停，继续播放
stop
• stop(): void client
帧动画播放停止
newObject
• Static newObject(parent?, inName?): FlipBook client
创建 FlipBook 控件
Parameters
parent? Canvas | 创建控件的外parent对象 default:null |
|---|---|
inName? string | 创建控件的名称 default:null |
Returns
FlipBook | 返回创建的对象 |
|---|
当parent和inName与已有的对象相同时，旧的对象会被销毁