ビューアを操作するための API です。
Configurator 360 ビューア オブジェクトは、ビューアを操作するための API を備えています。
このオブジェクトをエラーの結果として取得した場合、使用できるメソッドは unload のみです。
ページから Configurator 360 ビューアをロード解除します。
ビューアのロード解除後は、このオブジェクトを再び使用しないでください。
ロードした設計の UI プロパティ値をツリー構造で取得します。
filter (任意 => 既定: ' ')
タイプ: 文字列
プロパティを取得するパーツの refChain (参照チェーン)です。undefined、Null、または空の文字列(' ')の場合、ルートの値が提供されます。
callback (任意)
タイプ: コールバック関数
result は、配列内のパーツおよび子のツリー構造のプロパティを備えたプレーン オブジェクトです。
例:
// Non-ETO/iLogic application
{
"refChain": "Root",
"properties": [
{
"name": "Tier",
"value": "1 Tier"
},
{
"name": "Casters",
"value": false
},
{
"name": "Total_Price",
"value": "$700"
}
]
}
// ETO application
{
"refChain": "Root",
"properties": [
{
"name": "uiCompany",
"value": "[Enter Company]"
},
{
"name": "uiTitle",
"value": "[Enter Title]"
}
],
"children": [
{
"refChain": "Root.Cap",
"properties": [
{
"name": "uiBOMPartNumber",
"value": "Cap_15CN_NoIndicator_0_3_4"
}
]
},
{
"refChain": "Root.Bowl",
"properties": [
{
"name": "uiBOMPartNumber",
"value": "Bowl_15CN_Single_NoDrain"
}
]
}
]
}
error (任意)
タイプ: エラー コールバック関数
ロードした設計の UI プロパティ値を設定します。
properties (必須)
タイプ: プレーン オブジェクトまたはプレーン オブジェクトの配列
設定するプロパティおよび値の設定内容を指定します。
例:
// Set Properties prop1 and prop2 on the root part.
viewer.setPropertyValues({prop1: 5, prop2: 'some string'});
//Do the same with an array
viewer.setPropertyValues([{'name': 'prop1', 'value': 5}, {'name': 'prop2', 'value': 'some string'}]);
//Do the same with a tree structure
viewer.setPropertyValues({
"refChain": "Root",
"properties": [
{
'name': 'prop1',
'value': 5
},
{
'name': 'prop2',
'value': 'some string'
}
],
'children': [] // can include child parts with more properties to set
}]);
callback (任意)
タイプ: コールバック関数
result は、操作の影響を受けるツリー構造のプロパティを備えたプレーン オブジェクトです。変更されるとは限らない追加のプロパティが含まれる場合もあります。形式の getPropertyValues ()関数の結果については、例を参照してください。
error (任意)
タイプ: エラー コールバック関数
自動更新機能を有効または無効にします。この機能では、プロパティが変更されたときに、3D ビューを自動的に更新します。チェック ボックスのステータス、および機能に関連付けられているボタンの表示を更新します。
enable (必須)
タイプ: ブーリアン
自動更新を有効にする場合は true、無効にする場合は false です。
callback (任意)
タイプ: コールバック関数
自動更新が有効になっている場合は true、無効になっている場合は false です。
error (任意)
タイプ: エラー コールバック関数
ビューアで 3D ビューを更新するようにします。
callback (任意)
タイプ: 関数
パラメータがない点を除くと、標準のコールバック関数と同じです。
error (任意)
タイプ: エラー コールバック関数
パーツで使用できるアクションのリストを取得します。
data(任意 => 既定: undefined)
タイプ: プレーン オブジェクト
次のプロパティを格納する入力オブジェクトです。undefined、Null、または空の文字列(' ')の場合、ルートのアクションが付与されます。
refChain
タイプ: 文字列
アクションを取得するターゲット パーツを指定します。
callback (任意)
タイプ: コールバック関数
result は、次のプロパティを備えたプレーン オブジェクトの配列です。
category
タイプ: 文字列
カテゴリ名です。
displayName
タイプ: 文字列
表示名です。
name
タイプ: 文字列
アクションの内部名です。このアクションは、executeAction と同様に、プログラムでアクションを参照する目的で使用します。
error (任意)
タイプ: エラー コールバック関数
パーツに対してアクションを実行します。
出力アクションの場合: callback を指定しない場合、生成されたファイルがブラウザでダウンロードされます。指定した場合、ファイルは自動的にダウンロードされません。
data (必須)
タイプ: プレーン オブジェクト
次のプロパティを格納する入力オブジェクトです。
refChain (任意 => 既定:"Root")
タイプ: 文字列
ターゲット パーツを指定します。
name (必須)
タイプ: 文字列
アクションの名前を指定します。
callback (任意)
タイプ: コールバック関数
result は、実行したアクションのタイプに応じて異なります。
- C360 標準出力の場合
次のプロパティを備えたプレーン オブジェクトです。
url
タイプ: 文字列
生成される出力の URL です。
- ServerAction プロパティを ReturnResult に設定するアクションの場合
次の一連のプロパティを備えたプレーン オブジェクトです。
title
タイプ: 文字列
アクション コードで設定する出力のタイトルです。
message
タイプ: 文字列
アクション コードで設定する出力のメッセージです。
- ServerAction プロパティを UpdateModel に設定するアクションの場合
最小限の場合、操作の影響を受けるプロパティで構成されるツリー構造です。変更されるとは限らない追加のプロパティが含まれる場合もあります。形式の getPropertyValues ()関数の結果については、例を参照してください。
error (任意)
タイプ: エラー コールバック関数
.ikms ファイルにセッションを保存します。callback を指定しない場合、ファイルがブラウザでダウンロードされます。指定した場合、ファイルは自動的にダウンロードされません。
callback (任意)
タイプ: コールバック関数
result は、次のプロパティを備えたプレーン オブジェクトです。
urlタイプ: 文字列
生成される .ikms ファイルの URL です。
タイプ: エラー コールバック関数
タイプ: 数値
Configurator 360 ビューアのステータスを表すコードを指定します。
ADSK.C360.loadedState のプロパティは、指定可能なすべての値を表します。
タイプ: 関数(function (result) { })
定義した場合、唯一の引数として操作の結果を格納する C360Viewer オブジェクトのコンテキストで操作が完了したときに、コールバック関数が呼び出されます。
タイプ: 関数(function (err) { })
定義した場合、唯一の引数としてエラー オブジェクトを格納する C360Viewer オブジェクトのコンテキストで操作に失敗したときに、コールバック関数が呼び出されます。