Documentation
ドキュメントの検索
karat

+

K

APIリファレンス ↗
オントロジーの構築Vulcanスキーマリファレンス

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

スキーマリファレンス

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

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

スキーマの安定性

Vulcan の開発に伴い、スキーマの詳細は変更される可能性があります。Vulcan のリリースごとに、このページと照らし合わせてスキーマを検証してください。

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

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

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

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

オブジェクトタイプ

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

CAD オブジェクト

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

タイプクラス（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 オブジェクトに関連付けます。