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 或 URL 字串空白，則會從模型中移除先前載入的所有 PVI 資料。
|
playStep
|
名稱
|
類型
|
描述
|
必要/選用
|
|---|---|---|---|
|
params
|
物件
|
物件包含了模型和步驟資訊。
|
必要
|
|
params.modelID
|
字串
|
用以播放動畫步驟的模型 Studio ID。
|
必要
|
|
params.stepNumber
|
編號
|
欲播放的步驟編號。
|
必要
|
|
successCallback
|
函數
|
在作業成功完成時呼叫。
|
選用
|
|
errorCallback
|
函數
|
在作業失敗時呼叫。
|
選用
|
|
|
模型必須具備已載入的 PVI 檔案，且備有有效的動畫步驟 (請見 loadPVI)。
|
gotoStep
跳轉至指定模型的特定動畫步驟，並將其設定至指定位置。
|
名稱
|
類型
|
描述
|
必要/選用
|
|---|---|---|---|
|
params
|
物件
|
物件包含了模型和步驟資訊。
|
必要
|
|
params.modelID
|
字串
|
用以播放動畫步驟的模型 Studio ID。
|
必要
|
|
params.stepNumber
|
編號
|
要前往的步驟編號。
|
必要
|
|
params.position
|
字串
|
步驟中的位置：「開始」或「結束」。
|
必要
|
|
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
|
字串
|
3D 凝視方向向量作為具備 x、y、z 內容的物件。例如：{"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})。
|