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
|
文字列
|
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}) ででなければなりません。
|