大网数据广告活动
OpenHarmony 设备与应用开发

空间效果

· 52CE 我爱测

# 空间效果 用于为组件设置空间效果参数。 > **说明:** > > 空间效果仅作用于DepthComponent的子组件,且仅当DepthComponent相关参数设置正确才能生效。 > > 空间效果不支持Web、XComponent、RichEditor、RichText、Video、Component3D、EmbeddedComponent组件。 **起始版本:** 26.0.0 ## spatialEffect spatial

空间效果

用于为组件设置空间效果参数。

说明:

空间效果仅作用于DepthComponent的子组件,且仅当DepthComponent相关参数设置正确才能生效。

空间效果不支持Web、XComponent、RichEditor、RichText、Video、Component3D、EmbeddedComponent组件。

起始版本: 26.0.0

spatialEffect

spatialEffect(params: SpatialEffectParams | undefined): T

为组件设置空间效果。

起始版本: 26.0.0

模型约束: 此接口仅可在Stage模型下使用。

原子化服务API: 从API版本26.0.0开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
params SpatialEffectParams | undefined 是 空间效果参数。参数为undefined时,移除空间效果。

返回值:

类型 说明
T 返回当前组件。

SpatialEffectParams

空间效果参数。

起始版本: 26.0.0

模型约束: 此接口仅可在Stage模型下使用。

原子化服务API: 从API版本26.0.0开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 只读 可选 说明
position SpatialPosition 否 否 由四个角点定义的空间位置。
occlusionWeight number 否 是 空间效果的遮挡权重。取值范围:[0, 1],默认值:0。
0表示不会被遮挡,1表示会被完全遮挡,中间值表示部分遮挡。

SpatialPosition

三维空间中的四角位置。

起始版本: 26.0.0

模型约束: 此接口仅可在Stage模型下使用。

原子化服务API: 从API版本26.0.0开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 只读 可选 说明
leftTop DepthVector3 否 否 左上角在三维空间中的位置。无单位,其值表示3D空间中的坐标。
rightTop DepthVector3 否 否 右上角在三维空间中的位置。无单位,其值表示3D空间中的坐标。
leftBottom DepthVector3 否 否 左下角在三维空间中的位置。无单位,其值表示3D空间中的坐标。
rightBottom DepthVector3 否 否 右下角在三维空间中的位置。无单位,其值表示3D空间中的坐标。

DepthVector3

景深空间中的三维向量。

起始版本: 26.0.0

模型约束: 此接口仅可在Stage模型下使用。

原子化服务API: 从API版本26.0.0开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 只读 可选 说明
x number 否 否 X分量。无单位,其值表示3D空间中的坐标。
y number 否 否 Y分量。无单位,其值表示3D空间中的坐标。
z number 否 否 Z分量。无单位,其值表示3D空间中的坐标。

DepthVector4

景深空间中的四维向量。

起始版本: 26.0.0

模型约束: 此接口仅可在Stage模型下使用。

原子化服务API: 从API版本26.0.0开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 只读 可选 说明
x number 否 否 X分量。无单位,其值表示3D空间中的坐标。
y number 否 否 Y分量。无单位,其值表示3D空间中的坐标。
z number 否 否 Z分量。无单位,其值表示3D空间中的坐标。
w number 否 否 W分量。无单位,其值表示3D空间中的坐标。

DepthColorRGB

景深空间中的RGB颜色。

起始版本: 26.0.0

模型约束: 此接口仅可在Stage模型下使用。

原子化服务API: 从API版本26.0.0开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

名称 类型 只读 可选 说明
red number 否 否 红色分量,取值范围:[0, 255]。
green number 否 否 绿色分量,取值范围:[0, 255]。
blue number 否 否 蓝色分量,取值范围:[0, 255]。

示例

见DepthComponent示例。

本文来自 OpenHarmony 文档贡献者,按 CC BY 4.0 整理版式与相对链接,保留正文与代码。图示请参阅原文。作者与贡献记录。

资料来源与适用范围

资料来源
OpenHarmony 文档贡献者
适用范围
master 文档快照(2026-11-16)
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-16
授权说明
CC BY 4.0

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。