注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

スキーマリファレンス

Vulcan では、特定のオントロジーのオブジェクトタイプ、アクション、リンクタイプ、およびプロパティのタイプクラスがエンロールメント内に存在する必要があります。このページでは、Vulcan が読み書きするすべてのタイプクラスを一覧で示します。

Ontology Manager でオブジェクトタイプ、アクション、リンクタイプを作成し、このページに記載されているタイプクラスを、それぞれのプロパティ、アクションパラメーター、リンクタイプに付与します。

スキーマの安定性

スキーマの詳細は、Vulcan の開発に伴って変わる場合があります。Vulcan のリリースごとに、このページと照らし合わせてスキーマを確認してください。

タイプクラスは、プロパティの用途を Vulcan に伝えるために、そのプロパティに付与するラベルです。Vulcan はプロパティを名前ではなく、常にタイプクラスで検索するため、独自のオントロジーの規約に合わせてプロパティに名前を付けられます。また、1個のプロパティに複数のタイプクラスを付与することで、Vulcan とほかのアプリケーションの両方で使用できます。

以下に記載するすべてのタイプクラスは vulcan 名前空間に属します。つまり、kind フィールドは常に "vulcan" で、name フィールドのみが異なります。

以下のテーブルでは、必須は、対応するタイプクラスが設定済みのスキーマに存在しなければならないことを示します。テーブルの種類ごとに、さらに次の要件が適用されます。

  • オブジェクトのプロパティ: 必須プロパティには、保存されたオブジェクト上で値が設定されている必要もあります。
  • アクションパラメーター: Vulcan が値を指定できるように、記載されているタイプクラスとデータ型を持つパラメーターをアクションで公開する必要があります。
  • リンクタイプ: Vulcan がリンクをたどれるように、記載されているタイプクラスをリンクタイプに付与する必要があります。

オブジェクトタイプ

Vulcan は、次のオブジェクトタイプを読み書きします。各テーブルには、そのオブジェクトタイプのプロパティで Vulcan が検索するタイプクラスを記載しています。

CAD オブジェクト

Vulcan がレンダリングできる3D モデルを表します。モデルのジオメトリは Media Reference として保存されます。

Media Reference プロパティには、vulcan:cad_media_reference タイプクラスを付与する必要があります。vulcan は名前空間(kind)、cad_media_reference は名前(name)です。設定手順については、はじめるを参照してください。

タイプクラス (name)必須データ型説明
cad_media_referenceはいMedia ReferenceCAD モデルファイルです。このプロパティは、サポートされているモデル形式に記載されているすべての形式を受け付けます。Vulcan は拡張子から形式を検出します。
up_axisいいえ文字列モデルの上方向の軸の規約です。指定できる値は X、Y、Z です。省略した場合、Vulcan は形式ごとのデフォルト値を適用します。GLB と GLTF には Y、STL、OBJ、PLY、3MF、DXF、LAS、LAZ には Z を適用します。
model_unitいいえ文字列ファイル自体に単位が宣言されていない場合に、Vulcan がモデルの座標をどのように解釈するかを指定します。単位を宣言しない OBJ、STL、PLY、DXF、LAS、LAZ では、このプロパティを設定してください。GLB、GLTF、3MF では、Vulcan がこれらの形式で宣言されている単位を常に読み取るため、このプロパティは効果がありません。指定できる値は m(または meter / metre)と mm(または millimeter / millimetre)です。Vulcan はそれ以外の値を無視します。

注釈

CAD モデルの一部に付けられた注釈を表します。注釈は、テキストラベル、3D 空間内の取り付け点、作成者と意図に関するメタデータを組み合わせたものです。

タイプクラス (name)必須データ型説明
annotation_idはい文字列注釈の一意の識別子です。
annotation_titleはい文字列注釈とともに表示される短いラベルです。
annotation_contentはい文字列より長い本文テキストです。
part_instance_idはい文字列注釈がアタッチされているパーツインスタンスの識別子です。
annotation_attachment_xはいDoubleモデルの単位で表したアタッチ点の X 座標です。
annotation_attachment_yはいDoubleモデルの単位で表したアタッチ点の Y 座標です。
annotation_attachment_zはいDoubleモデルの単位で表したアタッチ点の Z 座標です。
annotation_sphere_sizeはいDoubleモデルの単位で表したマーカーの半径です。点マーカーを表示するには、0 を使用します。
annotation_created_byはい文字列注釈を作成したユーザーの識別子です。
annotation_intentはい文字列注釈マーカーの視覚的な Intent です。下記の Intent の値を参照してください。
annotation_timestampはいタイムスタンプ注釈が作成された日時です。

Intent の値

annotation_intent プロパティには、次の文字列値のいずれかを指定できます。Vulcan は各値を異なるマーカーの色で表示するため、重要度やカテゴリーを、ユーザーがひと目で認識できるように表現できます。Vulcan はこれらの値の意味を規定しないため、ワークフローに合わせて設定できます。

値マーカーの色
noneグレー
primary青(新しい注釈が作成されたときのデフォルト)
success緑
warning黄
danger赤

測定

モデル上の2点以上の間で取得した距離の測定結果を表します。

タイプクラス (name)必須データ型説明
measurement_idはい文字列測定の一意の識別子です。
measurement_pointsはいDouble の配列測定を定義する順序付きの3D 点座標で、フラットな数値配列としてシリアライズされます。下記の点の形式を参照してください。
measurement_created_byはい文字列測定を作成したユーザーの識別子です。
measurement_timestampはいタイムスタンプ測定が作成された日時です。

点の形式

測定点は、モデルの座標空間で表された数値のフラットな配列として、[x1, y1, z1, x2, y2, z2, ...] の順序でシリアライズされます。したがって、2点の測定には6個の数値が含まれ、3点の測定には9個の数値が含まれます。点は順序付きの折れ線として解釈されます。Vulcan が測定結果として報告する合計距離は、連続する点の間の距離の合計です。

断面平面

モデルを横切る断面平面を表します。

タイプクラス (name)必須データ型説明
section_plane_idはい文字列断面平面の一意の識別子です。
section_plane_positionはいDouble の配列[x, y, z] の順序で並んだ、ちょうど3個の位置の値です。
section_plane_quaternionはいDouble の配列[x, y, z, w] の順序で並んだ、ちょうど4個のクォータニオンの値です。
section_plane_created_byはい文字列断面平面を作成したユーザーの識別子です。
section_plane_timestampはいタイムスタンプ断面平面が作成された日時です。

アクションタイプ

Vulcan は、アクションを通じて注釈、測定結果、断面平面をオントロジーに書き戻します。各アクションタイプは、付与されたパラメーターのタイプクラスの組み合わせによって識別されます。

以下のテーブルには、Vulcan が値を指定するパラメーターのみを記載しています。作成されるオブジェクトのそれ以外の必須プロパティは、すべてアクション定義で値を設定する必要があります。

  • 3個すべてのアクションについて、オブジェクトIDと作成者のプロパティ。作成者のプロパティ(annotation_created_by、measurement_created_by、または section_plane_created_by)には、アクションを実行したユーザーを設定します。
  • 測定を作成するアクションと断面平面を作成するアクションについて、タイムスタンプのプロパティ。Vulcan が annotation_timestamp を指定するのは、注釈を作成するの場合のみです。

追加のアクションパラメーターに Vulcan のタイプクラスは必要ありません。Workshop ウィジェットでアクションを設定する際、これらのパラメーターにデフォルト値を指定するか、ユーザー入力項目として公開できます。

注釈を作成する

パラメーターのタイプクラス (name)必須データ型説明
annotation_titleはい文字列短いラベルです。
annotation_contentはい文字列本文テキストです。
part_instance_idはい文字列注釈がアタッチされるパーツインスタンスです。
annotation_attachment_xはいDoubleアタッチ点の X 座標です。
annotation_attachment_yはいDoubleアタッチ点の Y 座標です。
annotation_attachment_zはいDoubleアタッチ点の Z 座標です。
annotation_sphere_sizeはいDoubleモデルの単位で表したマーカーの半径です。点マーカーには 0 を使用します。
annotation_intentはい文字列カテゴリーまたは重大度です。
annotation_timestampはいタイムスタンプ作成時のタイムスタンプです。
cad_objectはいオブジェクト参照注釈が属する CAD オブジェクトへの参照です。

測定を作成する

パラメーターのタイプクラス (name)必須データ型説明
measurement_pointsはいDouble の配列[x1, y1, z1, x2, y2, z2, ...] 形式の順序付き点座標です。

断面平面を作成する

パラメーターのタイプクラス (name)必須データ型説明
section_plane_positionはいDouble の配列[x, y, z] の順序で並んだ、ちょうど3個の位置の値です。
section_plane_quaternionはいDouble の配列[x, y, z, w] の順序で並んだ、ちょうど4個のクォータニオンの値です。

リンクタイプ

タイプクラス (name)必須説明
cad_objectはい注釈をその親 CAD オブジェクトに関連付けます。