3D 内容处理函数
setViewProperties
配置视图级渲染选项。
|
名称
|
类型
|
说明
|
必需/可选
|
默认
|
|---|---|---|---|---|
|
params
|
对象
|
包含要配置的视图属性的对象。
|
必需
|
|
|
params.dropshadow
|
布尔型
|
启用或禁用阴影。
|
可选
|
true
|
|
successCallback
|
函数
|
当操作成功完成时调用。
|
可选
|
|
|
errorCallback
|
函数
|
当操作失败时调用。
|
可选
|
 |
目前，params 对象仅支持背后阴影。
|
addPVS
在体验中添加 3D 模型。
|
名称
|
类型
|
说明
|
必需/可选
|
|---|---|---|---|
|
trackerName
|
字符串
|
此模型关联的追踪器 ID 。
|
必需
|
|
name
|
字符串
|
模型小组件的 Studio ID。
|
必需
|
|
url
|
字符串
|
加载 3D 模型的 URI。
|
可选
|
|
successCallback
|
函数
|
当操作成功完成时调用。
|
可选
|
|
errorCallback
|
函数
|
当操作失败时调用。
|
可选
|
|
|
如果 url 留空或未定义，则创建一个空的模型占位符。
|
setModelURL
为模型设置新的模型 URL 并加载模型。
|
名称
|
类型
|
说明
|
必需/可选
|
|---|---|---|---|
|
params
|
对象
|
包含模型参考和 URI 的对象。
|
必需
|
|
params.modelID
|
字符串
|
要更新的模型元素的 Studio ID 。
|
必需
|
|
params.modelURL
|
字符串
|
加载 3D 模型的 URI。
|
必需
|
|
successCallback
|
函数
|
当操作成功完成时调用。
|
可选
|
|
errorCallback
|
函数
|
当操作失败时调用。
|
可选
|
|
|
必须事先使用 addPVS 初始化模型元素。
|
setProperties
为特定元素设置视觉和渲染相关的效果属性。
|
名称
|
类型
|
说明
|
必需/可选
|
默认
|
|---|---|---|---|---|
|
name
|
字符串
|
要更新的元素的 Studio ID 。
|
必需
|
|
|
params
|
对象
|
包含要应用的渲染属性的对象。
|
必需
|
|
|
params.occlude
|
布尔型
|
启用或禁用模型对其他对象的遮蔽。
|
可选
|
true
|
|
params.billboard
|
布尔型
|
启用或禁用广告牌 (仅适用于 3D 图像小组件，包括 3D 图像、3D 仪表和 3D 标签)。
|
可选
|
true
|
|
params.hidden
|
布尔型
|
启用或禁用元素的隐藏 (适用于所有非 3D 模型小组件；主要是子装配)。
|
可选
|
true
|
|
params.opacity
|
数字
|
设置元素的不透明度 (0.0 = 透明，1.0 = 不透明)。
|
可选
|
1.0
|
|
params.decal
|
布尔型
|
启用或禁用贴花/始终在顶部渲染模式。
|
可选
|
true
|
|
params.shader
|
字符串
|
由着色器名称和可选参数组成的着色器定义字符串 (用分号分隔)。示例："highlight; r f 1; g f 0; b f 0; a f 1"
|
可选
|
""
|
|
params.phantom
|
布尔型
|
启用或禁用元素的半透明 (仅适用于“3D 模型”小组件)。
|
可选
|
true
|
|
params.forceHidden
|
布尔型
|
启用或禁用元素的强制隐藏 (仅适用于“3D 模型”小组件)。
|
可选
|
true
|
|
successCallback
|
函数
|
当操作成功完成时调用。
|
可选
|
|
|
errorCallback
|
函数
|
当操作失败时调用。
|
可选
|
|
|
• 通过将多个属性组合到 params 对象中，可以一次应用多个属性。
• 未指定的属性将设置为默认值。
|
loadPVI
|
名称
|
类型
|
说明
|
必需/可选
|
|---|---|---|---|
|
params
|
对象
|
包含模型参考和 PVI 文件 URI 的对象。
|
必需
|
|
params.modelID
|
字符串
|
要加载 PVI 的模型的 Studio ID。
|
必需
|
|
params.url
|
字符串
|
用于加载动画数据的 PVI 文件的 URI。如果省略，将取消加载先前为模型加载的动画数据。
|
必需
|
|
successCallback
|
函数
|
当操作成功完成时调用。
|
可选
|
|
errorCallback
|
函数
|
当操作失败时调用。
|
可选
|
|
|
• 如果提供了 url，则从指定文件加载动画。
• 如果 url 被省略或为空字符串，则之前加载的所有 PVI 数据都将从模型中移除。
|
playStep
|
名称
|
类型
|
说明
|
必需/可选
|
|---|---|---|---|
|
params
|
对象
|
包含模型和步骤信息的对象。
|
必需
|
|
params.modelID
|
字符串
|
要播放动画步骤的模型的 Studio ID。
|
必需
|
|
params.stepNumber
|
数字
|
要播放的步骤编号。
|
必需
|
|
successCallback
|
函数
|
当操作成功完成时调用。
|
可选
|
|
errorCallback
|
函数
|
当操作失败时调用。
|
可选
|
|
|
模型必须具有已加载的 PVI 文件，且包含有效的动画步骤 (请参阅 loadPVI)。
|
gotoStep
跳转到给定模型的特定动画步骤，并将其设置到给定位置。
|
名称
|
类型
|
说明
|
必需/可选
|
|---|---|---|---|
|
params
|
对象
|
包含模型和步骤信息的对象。
|
必需
|
|
params.modelID
|
字符串
|
要播放动画步骤的模型的 Studio ID。
|
必需
|
|
params.stepNumber
|
数字
|
要转至的步骤编号。
|
必需
|
|
params.position
|
字符串
|
在步骤中的位置: "start" 或 "end"。
|
必需
|
|
successCallback
|
函数
|
当操作成功完成时调用。
|
可选
|
|
errorCallback
|
函数
|
当操作失败时调用。
|
可选
|
|
|
要求模型已载入 PVI 动画数据 (请参阅 loadPVI)。
|
add3DImage
在 3D 空间中添加图像。
|
名称
|
类型
|
说明
|
必需/可选
|
默认
|
|---|---|---|---|---|
|
params
|
对象
|
包含图像放置和显示信息的对象。
|
必需
|
|
|
params.tracker
|
字符串
|
此图像关联的追踪器 ID。
|
必需
|
|
|
params.id
|
字符串
|
小组件的 Studio ID 。
|
必需
|
|
|
params.src
|
字符串
|
要显示的图像的 URI 或 Base64 字符串。
|
必需
|
|
|
params.width
|
数字
|
图像在 3D 空间中的宽度 (米)。
|
可选
|
NaN
|
|
params.height
|
数字
|
图像在 3D 空间中的高度 (米)。
|
可选
|
NaN
|
|
params.pivot
|
数字
|
用于定位的枢轴点。枢轴值如下所示：
• 1 - 左上角枢轴
• 2 - 顶部居中枢轴
• 3 - 右上角枢轴
• 4 - 中部左侧枢轴
• 5 - 中心枢轴 (默认)
• 6 - 中部右侧枢轴
• 7 - 左下角枢轴
• 8 - 底部居中枢轴
• 9 - 右下角枢轴
|
可选
|
5
|
|
successCallback
|
函数
|
当操作成功完成时调用。
|
可选
|
|
|
errorCallback
|
函数
|
当操作失败时调用。
|
可选
|
|
|
• 如果宽度或高度被省略，或设置为 NaN，则在保持原始长宽比的前提下，根据另一个提供的值计算缺失的值。
• 如果宽度和高度同时被省略，或设置为 NaN，则将自动根据图像的原始尺寸确定尺寸。
|
setWayfinderProperties
设置“寻路器”小组件的属性。需要在之后调用 setWaypoint 以开始导航。
|
名称
|
类型
|
说明
|
必需/可选
|
默认
|
|---|---|---|---|---|
|
params
|
对象
|
包含“寻路器”配置设置的对象。
|
必需
|
|
|
params.widgetId
|
字符串
|
要配置的“寻路器”小组件的 Studio ID。
|
必需
|
|
|
params.active
|
布尔型
|
启用或禁用“寻路器”。
|
可选
|
true
|
|
params.showReticle
|
布尔型
|
启用或禁用十字线的显示。
|
可选
|
true
|
|
params.showRibbon
|
布尔型
|
启用或禁用指向路标的功能区路径的显示。
|
可选
|
true
|
|
params.showWaypoints
|
布尔型
|
启用或禁用路标显示。
|
可选
|
true
|
|
params.showLabels
|
布尔型
|
启用或禁用路标标签的显示。
|
可选
|
true
|
|
params.labelsOnTop
|
布尔型
|
启用或禁用在其他场景元素之上的标签渲染。
|
可选
|
true
|
|
successCallback
|
函数
|
当操作成功完成时调用。
|
可选
|
|
|
errorCallback
|
函数
|
当操作失败时调用。
|
可选
|
setWaypoint
设置或更新当前启用路标的属性，包括位置和视觉外观。需要事先调用 setWayfinderProperties。
|
名称
|
类型
|
说明
|
必需/可选
|
默认
|
|---|---|---|---|---|
|
params
|
对象
|
包含路标配置的对象。
|
必需
|
|
|
params.position
|
字符串
|
作为具有 x、y、z 属性的对象，路标的 3D 位置。例如：{"x": 0.1995, "y": 0.0617, "z": 0.2545}
|
必需
|
|
|
params.gaze
|
字符串
|
作为具有 x、y、z 属性的对象，凝视方向的 3D 向量。例如：{"x": 0, "y": 0, "z": -1}
|
必需
|
|
|
params.eventRadius
|
数字
|
触发事件 (例如，自动前进) 的距离 (米)。
|
可选
|
0
|
|
params.wayfinderDisplayBoundary
|
数字
|
“寻路器”变为隐藏状态的半径 (米)。
|
可选
|
0
|
|
params.color
|
字符串
|
路标和点带的颜色。必须为以下预定义 rgba 值之一：橙色、红色、绿色、蓝色、黄色、粉色、青色、黑色、白色。任何不受支持的颜色都将改为默认的橙色。示例："rgba(255, 165, 0, 1)")以下是支持的值：
• 橙色 - rgba(255, 165, 0, 1)
• 红色 - rgba(255, 0, 0, 1)
• 绿色 - rgba(0, 255, 0, 1)
• 蓝色 - rgba(0, 0, 255, 1)
• 黄色 - rgba(255, 255, 0, 1)
• 粉色 -rgba(255, 0, 255, 1)
• 青色 -rgba(0, 255, 255, 1)
• 黑色 - rgba(0, 0, 0, 1)
• 白色 - rgba(255, 255, 255, 1)
如果传递了任何其他颜色，将自动使用默认颜色橙色：rgba(255, 165, 0, 1)。
|
可选
|
black
|
|
params.label
|
字符串
|
在路标旁边显示的文本标签。
|
可选
|
""
|
|
successCallback
|
函数
|
当操作成功完成时调用。
|
可选
|
|
|
errorCallback
|
函数
|
当操作失败时调用。
|
可选
|
|
|
位置和凝视参数必须为 3D 向量对象 (例如 {"x": 0.1995, "y": 0.0617, "z": 0.2545})。
|