API
Return to top
Image
编辑

界面 / Image

Image Class
​

图片

Hierarchy ​

Table of contents ​

Properties
​

click

Properties
​

onCustomPropertyChange: Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> client
监听自定义属性同步事件

Accessors
​

currentCamera(): Camera client
获取当前渲染的摄像机
imageColor(): Readonly<LinearColor> client
获取图片的颜色
imageDrawType(): Readonly<SlateBrushDrawType> client
获取图片绘制类型
imageGuid(): string client
获取图片id
imageInfo(): ImageInfo
图片资源信息
imageSize(): Readonly<Vector2> client
获取图片大小
margin(): Readonly<Margin>
获取图片边距
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
​

asyncExportBlendBrush(): Promise<string> client
将融合的图片导出为一张
getImageAssetIconData(): Readonly<AssetIconData> client
获取显示资源的ICON
setImageByBlendMode(backgroundPic: string, foregroundPic: string): void client
将两张图片融合叠加显示在图片组件上
setImageByBlendModeWithGUID(GUID: string, foregroundPic: string): void client
将两张图片融合叠加显示在图片组件上
setImageByFile(absPath: string, bRefreshCache?: boolean): void client
设置图片样式为本地图片文件
setImageColorByHex(inHexString: string): void client
设置图片颜色。
setImageColorDecimal(R: number, G: number, B: number, A: number): void client
设置图片颜色
newObject(parent?: Canvas, inName?: string): Image client
创建 Image 控件
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
立刻触发重新渲染的和排布计算
isValid(): boolean 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 ​

currentCamera
​

• get currentCamera(): Camera client

• set currentCamera(camera): void client

获取当前渲染的摄像机

Returns ​

Camera新的摄像机对象

设置当前渲染的摄像机

Parameters ​

camera string Camera新的摄像机对象

imageColor
​

• get imageColor(): Readonly<LinearColor> client

• set imageColor(inColor): void client

获取图片的颜色

Returns ​

Readonly<LinearColor>图片的颜色，Type.LinearColor类型，数据范围0~1

设置图片颜色

Parameters ​

inColor LinearColor图片颜色，Type.LinearColor类型，数据范围0~1

颜色

imageDrawType
​

• get imageDrawType(): Readonly<SlateBrushDrawType> client

• set imageDrawType(inDrawType): void client

获取图片绘制类型

Returns ​

Readonly<SlateBrushDrawType>图片绘制类型

设置图片绘制类型

Parameters ​

inDrawType SlateBrushDrawType绘制类型

imageGuid
​

• get imageGuid(): string client

• set imageGuid(inGUID): void client

获取图片id

Returns ​

string图片id

设置图片id

Parameters ​

inGUID string新的图片样式

imageInfo
​

• get imageInfo(): ImageInfo

图片资源信息 @effect只在客户端调用生效

Returns ​

ImageInfo

imageSize
​

• get imageSize(): Readonly<Vector2> client

• set imageSize(inSize): void

获取图片大小

Returns ​

Readonly<Vector2>图片大小

设置图片大小 @effect只在客户端调用生效

Parameters ​

inSize Vector2size

margin
​

• get margin(): Readonly<Margin>

• set margin(inMargin): void

获取图片边距 @effect只在客户端调用生效

Returns ​

Readonly<Margin>图片边距

设置图片的边距 @effect只在客户端调用生效

Parameters ​

inMargin Margin图片边距

Methods ​

asyncExportBlendBrush
​

• asyncExportBlendBrush(): Promise<string> client

将融合的图片导出为一张

Returns ​

Promise<string>导出的图片的本地路径

Precautions

必须调用过 setImageByBlendMode 后才会生效，高消耗操作注意

getImageAssetIconData
​

• getImageAssetIconData(): Readonly<AssetIconData> client

获取显示资源的ICON

Returns ​

Readonly<AssetIconData>资源的ICON信息

setImageByBlendMode
​

• setImageByBlendMode(backgroundPic, foregroundPic): void client

将两张图片融合叠加显示在图片组件上

Parameters ​

backgroundPic string背景图片绝对路径 range:路径长度
foregroundPic string前景图片绝对路径 range:路径长度

setImageByBlendModeWithGUID
​

• setImageByBlendModeWithGUID(GUID, foregroundPic): void client

将两张图片融合叠加显示在图片组件上

Parameters ​

GUID string背景图片 GUID range: 依据资源 ID 长度而定
foregroundPic string前景图片绝对路径 range: 路径长度

setImageByFile
​

• setImageByFile(absPath, bRefreshCache?): void client

设置图片样式为本地图片文件

Parameters ​

absPath string图片绝对路径 range: 路径长度
bRefreshCache? boolean默认为 true 将重新创建并刷新缓存，为 false 则使用缓存
default: true

Precautions

  1. 建议设置 bRefreshCache = false 以提升性能 2. 该接口主要配合 setImageByBlendMode 和 asyncExportBlendBrush 来为移动编辑器服务的

setImageColorByHex
​

• setImageColorByHex(inHexString): void client

设置图片颜色。

Parameters ​

inHexString stringHex 颜色字符串。
range: 符合 Hex 特点的字符串类型

指定 Hex 的颜色文本设定颜色 例如: #05050505

setImageColorDecimal
​

• setImageColorDecimal(R, G, B, A): void client

设置图片颜色

Parameters ​

R number图片 R 值。
range:[0, 255] type: 整形
G number图片 G 值。
range:[0, 255] type: 整形
B number图片 B 值。
range:[0, 255] type: 整形
A number图片 透明度。
range:[0, 255] type: 整形

newObject
​

• Static newObject(parent?, inName?): Image client

创建 Image 控件

Parameters ​

parent? Canvas创建控件的外parent对象 default:null
inName? string创建控件的名称 default:null range:设置合理的名称即可

Returns ​

Image返回创建的对象

当parent和inName与已有的对象相同时，旧的对象会被销毁