APIリファレンス:目的から探す
設定、作画、選択、入力、編集、3D、板金、解析、レイアウト、保存の順で説明します。メソッドの引数表と具体例を同じ分類にまとめています。
コード例を動かす準備
同梱ApiExamplesのSamples.csはJDesignCAD.Api.dllを参照してコンパイルできます。使用する名前空間はSystem、System.Linq、System.Threading、System.Threading.Tasks、System.Collections.Generic、System.Text.Json、JDesignCAD.Apiです。.NET 8のImplicitUsingsを有効にします。外部接続はConnect(processId)、アドイン内はIAddinContext.ApiをICadFileApiへキャストしてcadへ代入します。CancellationTokenはCancellationToken.Noneまたは自分のCancellationTokenSourceから渡します。
例は練習用の新規図面で実行してください。OperationIdは新しいUUIDです。通信断の再送だけは同じ要求と同じUUIDを使います。競合を隠すためにrevisionだけ更新して再送しないでください。エラーはCadApiException.Codeで判別し、利用不可・ライセンス制限・形状不成立は理由を確認します。
ApiExamplesフォルダーで dotnet build を実行します。JDesignCADで練習用図面を開き、dotnet run -- --list で対象のProcessIdを調べます。例:dotnet run -- 1234 drawing は指定したCADに線と円を作成します(1234は実際のProcessIdへ置換)。inspect は選択状態の調査、rectangle は閉輪郭、box は直方体、sheet は板金ベースを作ります。実行の入口はProgram.cs、各処理はSamples.csにあります。
設定と接続
操作リファレンス:styles.lineWidth, styles.linePattern
ConnectにはFindSessionsで表示したProcessIdを渡します。複数起動中に最初のセッションを無条件で選ばないでください。長さは表示単位に関係なくWCSのmm、角度は度です。SettingsAsyncはExampleレイヤを作成・更新します。戻り値Layersで反映を確認できます。
コード例:connect
public static ICadFileApi Connect(int processId)
{
SessionInfo session = LocalProtocol.FindSessions()
.Single(s => s.ProcessId == processId);
return new LocalCadClient(session);
}コード例:settings
public static async Task<LayerPage> SettingsAsync(
ICadAutomationApi cad, CancellationToken ct = default)
{
CapabilityInfo caps = await cad.GetCapabilitiesAsync(ct);
if (!caps.Operations.Any(o => o.Name == "layers.set" && o.Available))
throw new InvalidOperationException("layers.set is unavailable.");
OperationSchema schema = await cad.GetOperationSchemaAsync("layers.set", ct);
Console.WriteLine(schema.ParametersSchema.GetRawText());
DocumentInfo doc = await cad.GetDocumentAsync(ct);
EditResult edit = await cad.ExecuteOperationAsync(doc.Operation("layers.set",
new SetLayerParameters("Example", new CadColor("rgb", "0080C0"))), ct);
return await cad.GetLayersAsync(
new DocumentRequest(edit.Document.Id, edit.Document.Revision), ct);
}ICadApi.GetDocumentAsync
図面の状態を取得 — 図面ID、リビジョン、図形数、Undo/Redo可否を取得します。編集要求を作る直前に呼び出します。
宣言
Task<DocumentInfo> GetDocumentAsync(
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<DocumentInfo>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Id | string |
| FileName | string |
| Revision | long |
| ObjectCount | int |
| CanUndo | bool |
| CanRedo | bool |
| LengthUnit | string |
| CoordinateSystem | string |
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadAutomationApi.GetCapabilitiesAsync
操作と利用条件を取得 — 操作名、入力型、実行方式、利用可否、制限理由、現在のプランを取得します。操作名を推測せず、Availableを確認してください。
宣言
Task<CapabilityInfo> GetCapabilitiesAsync(
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<CapabilityInfo>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Major | int |
| Minor | int |
| CoordinateSystem | string |
| LengthUnit | string |
| Operations | OperationInfo[] |
| Limitations | string[] |
| License | LicenseCapabilities |
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadAutomationApi.GetOperationSchemaAsync
操作の入力書式を取得 — 指定した操作のJSON Schemaを取得します。必須項目、型、null許可、入れ子を確認します。プロパティ名はcamelCaseです。
宣言
Task<OperationSchema> GetOperationSchemaAsync(
string operation,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| operation | string | GetCapabilitiesAsyncにある登録済みの操作名。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<OperationSchema>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Operation | OperationInfo |
| ParametersSchema | Text.Json.JsonElement |
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadAutomationApi.GetLayersAsync
レイヤーと線の設定を取得 — 図面内のレイヤー定義と、使用できる線種・線幅名を取得します。属性変更時に存在する名前を選ぶために使います。
宣言
Task<LayerPage> GetLayersAsync(
DocumentRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | DocumentRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<LayerPage>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Document | DocumentInfo |
| Layers | LayerInfo[] |
| LinePatterns | string[] |
| LineWidths | string[] |
要求型
public sealed record DocumentRequest(string DocumentId, long ExpectedRevision);
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadAutomationApi.ExecuteOperationAsync
即時操作を実行 — Execution=immediateの操作を1回のUndoで反映します。worker操作はStartOperationAsyncへ渡します。未知のフィールドは拒否します。
宣言
Task<EditResult> ExecuteOperationAsync(
OperationRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | OperationRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<EditResult>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Document | DocumentInfo |
| Entities | EntityInfo[] |
| Changed | bool |
要求型
public sealed record OperationRequest(string DocumentId, long ExpectedRevision, string OperationId,
string Operation, JsonElement Parameters, bool SelectResult = true);エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
作画:線・円・閉輪郭
操作リファレンス:geometry.clothoid, geometry.clothoid.basic, geometry.clothoid.stations
DrawingAsyncは長さ60の線と半径10の円を1回のUndo単位で作ります。RectangleAsyncは80×50の閉じたポリラインを作ります。Closed=trueでは最初の頂点を末尾に重ねません。戻り値EntitiesのIdを後続編集に渡します。
コード例:drawing
public static async Task<EditResult> DrawingAsync(
ICadApi cad, CancellationToken ct = default)
{
DocumentInfo doc = await cad.GetDocumentAsync(ct);
var request = new CreateGeometryRequest(doc.Id, doc.Revision,
Guid.NewGuid().ToString("D"),
new[] { new LineDefinition(new(0, 0, 0), new(60, 0, 0)) },
new[] { new CircleDefinition(new(30, 20, 0), 10, new(0, 0, 1)) });
EditResult result = await cad.CreateGeometryAsync(request, ct);
Console.WriteLine($"Created: {result.Entities.Length}; revision: {result.Document.Revision}");
return result;
}コード例:curves
public static async Task<EditResult> RectangleAsync(
ICadModelApi cad, CancellationToken ct = default)
{
DocumentInfo doc = await cad.GetDocumentAsync(ct);
var rectangle = new PolylineDefinition(new Point3[] {
new(0, 0, 0), new(80, 0, 0), new(80, 50, 0), new(0, 50, 0)
}, Closed: true);
return await cad.CreateCurvesAsync(new CreateCurvesRequest(
doc.Id, doc.Revision, Guid.NewGuid().ToString("D"),
new[] { rectangle }, Array.Empty<ArcDefinition>()), ct);
}ICadApi.CreateGeometryAsync
線分と円を作成 — LinesとCirclesに定義を渡します。未使用の配列は空配列とし、合計1~1000図形を1回のUndoで作成します。円のNormalはゼロでない法線です。
宣言
Task<EditResult> CreateGeometryAsync(
CreateGeometryRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | CreateGeometryRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<EditResult>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Document | DocumentInfo |
| Entities | EntityInfo[] |
| Changed | bool |
要求型
public sealed record CreateGeometryRequest(string DocumentId, long ExpectedRevision, string OperationId,
LineDefinition[] Lines, CircleDefinition[] Circles, bool SelectCreated = true);エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadModelApi.CreateCurvesAsync
ポリラインと円弧を作成 — 合計1~1000曲線、ポリライン点は合計4096点まで。閉輪郭の終点に始点を重複させません。円弧は右手系の符号付き角度で、0度と±360度は不可です。
宣言
Task<EditResult> CreateCurvesAsync(
CreateCurvesRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | CreateCurvesRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<EditResult>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Document | DocumentInfo |
| Entities | EntityInfo[] |
| Changed | bool |
要求型
public sealed record CreateCurvesRequest(string DocumentId, long ExpectedRevision, string OperationId,
PolylineDefinition[] Polylines, ArcDefinition[] Arcs, bool SelectCreated = true);エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
選択と図形の調査
点入力・ラバーバンド・図形選択の実装例(C#/VB.NET)
選択取得の戻り値は全件とは限りません。TotalとOffsetを確認し、大量の場合はページを分けて取得します。調査中は同じrevisionを保ちます。面・エッジのSubobjectRefは形状編集後に取り直し、固定したIndexを別形状へ使わないでください。
コード例:selection
public static async Task<SelectionInfo> SelectCreatedAsync(
ICadModelApi cad, CancellationToken ct = default)
{
EditResult created = await DrawingAsync(cad, ct);
DocumentInfo doc = await cad.GetDocumentAsync(ct);
await cad.SetSelectionAsync(new EntityEditRequest(doc.Id, doc.Revision,
Guid.NewGuid().ToString("D"), created.Entities.Select(e => e.Id).ToArray()), ct);
SelectionInfo selection = await cad.GetSelectionAsync(0, 256, ct);
Console.WriteLine($"Selected {selection.Entities.Length} of {selection.Total}");
return selection;
}コード例:inspect
public static async Task InspectAsync(
ICadAutomationApi cad, CancellationToken ct = default)
{
DocumentInfo doc = await cad.GetDocumentAsync(ct);
int offset = 0;
while (true)
{
EntityPage page = await cad.GetEntitiesAsync(
new EntityQuery(doc.Id, doc.Revision, offset, 100), ct);
if (page.Entities.Length == 0) break;
var request = new EntityDetailsRequest(doc.Id, doc.Revision,
page.Entities.Select(e => e.Id).ToArray());
EntityDetailsResult details = await cad.GetEntityDetailsAsync(request, ct);
AttributePage attributes = await cad.GetAttributesAsync(request, ct);
foreach (EntityDetail item in details.Entities)
Console.WriteLine($"{item.Entity.Id}: {item.GeometryStatus}");
foreach (AttributeInfo item in attributes.Items)
Console.WriteLine($"Layer: {item.Entity.Layer}; locked: {item.LayerLocked}");
offset += page.Entities.Length;
if (offset >= page.Total) break;
}
}コード例:topology
public static async Task<TopologyItem[]> EdgesAsync(
ICadAutomationApi cad, string entityId, CancellationToken ct = default)
{
DocumentInfo doc = await cad.GetDocumentAsync(ct);
var edges = new List<TopologyItem>();
do
{
TopologyPage page = await cad.GetTopologyAsync(new TopologyRequest(
doc.Id, doc.Revision, entityId, "edge", edges.Count, 128), ct);
edges.AddRange(page.Items);
if (edges.Count >= page.Total || page.Items.Length == 0) break;
} while (true);
return edges.ToArray();
}ICadApi.GetSelectionAsync
選択図形を取得 — 現在の選択をページ単位で取得します。ID・型・レイヤー・境界ボックスを返します。offsetは0始まり、limitは1~1000です。
宣言
Task<SelectionInfo> GetSelectionAsync(
int offset = 0,
int limit = 256,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| offset | int | 先頭から飛ばす件数。0始まり。 |
| limit | int | 1ページの最大件数。このメソッドの上限内で指定。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<SelectionInfo>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Document | DocumentInfo |
| Entities | EntityInfo[] |
| Total | int |
| Offset | int |
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadModelApi.GetEntitiesAsync
図面の図形一覧を取得 — モデル直下の図形を作成順のページで取得します。同じ一覧を読み切る間はリビジョンを固定し、変更があれば最初から取得します。
宣言
Task<EntityPage> GetEntitiesAsync(
EntityQuery request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | EntityQuery | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<EntityPage>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Document | DocumentInfo |
| Entities | EntityInfo[] |
| Total | int |
| Offset | int |
要求型
public sealed record EntityQuery(string DocumentId, long ExpectedRevision, int Offset = 0, int Limit = 256);
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadModelApi.GetEntityDetailsAsync
線や円の定義を取得 — 線分・円・円弧・直線ポリラインの正確な定義を取得します。1~100 ID。GeometryStatusがunsupported/too_largeなら定義の取得はできていません。
宣言
Task<EntityDetailsResult> GetEntityDetailsAsync(
EntityDetailsRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | EntityDetailsRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<EntityDetailsResult>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Document | DocumentInfo |
| Entities | EntityDetail[] |
要求型
public sealed record EntityDetailsRequest(string DocumentId, long ExpectedRevision, string[] EntityIds);
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadModelApi.SetSelectionAsync
選択を置き換える — 明示したIDだけを選択します。空配列で解除。ハイライトだけを変更し、Undo履歴を増やしません。
宣言
Task<EditResult> SetSelectionAsync(
EntityEditRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | EntityEditRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<EditResult>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Document | DocumentInfo |
| Entities | EntityInfo[] |
| Changed | bool |
要求型
public sealed record EntityEditRequest(string DocumentId, long ExpectedRevision, string OperationId, string[] EntityIds);
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadAutomationApi.GetAttributesAsync
図形の属性を取得 — 1~100 IDの色、線種、線幅、レイヤーロックを取得します。色はbyLayer/byBlock/foreground/rgbを区別します。
宣言
Task<AttributePage> GetAttributesAsync(
EntityDetailsRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | EntityDetailsRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<AttributePage>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Document | DocumentInfo |
| Items | AttributeInfo[] |
要求型
public sealed record EntityDetailsRequest(string DocumentId, long ExpectedRevision, string[] EntityIds);
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadAutomationApi.GetTopologyAsync
面や辺の参照を取得 — Kindはface/edge/vertex。ソリッド・シェル・面を対象に1~256件ずつ取得します。SubobjectRefはリビジョン変更で失効します。
宣言
Task<TopologyPage> GetTopologyAsync(
TopologyRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | TopologyRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<TopologyPage>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Document | DocumentInfo |
| Items | TopologyItem[] |
| Total | int |
| Offset | int |
要求型
public sealed record TopologyRequest(string DocumentId, long ExpectedRevision, string EntityId,
string Kind = "face", int Offset = 0, int Limit = 128);エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadWorkspaceApi.QueryAsync
拡張情報を取得 — Kind=geometryは楕円・スプライン・文字などの詳細、sheetは板金情報、blocksは定義とモデル直下の挿入数、stylesはスタイル名です。geometry/sheetは1~100 ID、その他は空配列です。
宣言
Task<QueryResult> QueryAsync(
QueryRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | QueryRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<QueryResult>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Document | DocumentInfo |
| Data | Text.Json.JsonElement |
要求型
public sealed record QueryRequest(string DocumentId,long ExpectedRevision,string Kind,string[] EntityIds);
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
入力と対話コマンド
点入力・ラバーバンド・図形選択の実装例(C#/VB.NET)
ユーザー入力を待って独自処理へ渡す
ICadInputApiの拡張メソッドは、ユーザーの確定までawait/Awaitで待ちます。入力だけでは本図形を作成しません。Escはcancelled、Accepted=trueのときだけ結果を使用します。C#・VB.NETの完全な例、引数、選択フィルター、仮表示
| 目的 / AutoCADでの対応例 | JDesignCAD | 入力と結果 |
|---|---|---|
| 点 / GetPoint | GetPointAsync(document, prompt, basePoint) | Point3を返す。基点を渡すと追跡とラバーバンド。現在のスナップ設定を使用。 |
| 対角点 / GetCorner | GetCornerAsync(document, prompt, basePoint) | 作図平面上の長方形を仮表示し、対角点を返す。 |
| 距離・角度 / GetDistance・GetAngle | GetDistanceAsync / GetAngleAsync | 基点とマウス位置、または数値入力。Numberはmm/度。角度の基準は現在の作図平面X方向。 |
| 整数・実数 / GetInteger・GetDouble | GetIntegerAsync / GetDoubleAsync | Numberを返す。既定値と最小・最大値を指定可能。整数はInt32範囲。 |
| 文字 / GetString | GetStringAsync | Textを返す。空白の可否、既定値を指定。最大4096文字。 |
| キーワード / GetKeywords | GetKeywordsAsync | 候補の正式な文字列をTextへ返す。大文字小文字を区別せず、一意な前方一致も受け付ける。 |
| 1図形 / GetEntity | GetEntityAsync | クリックしたトップレベル図形のEntitiesとPickPoint。 |
| 複数選択 / GetSelection | GetSelectionAsync(document, prompt, options) | クリックで追加/解除、左→右のドラッグで窓選択、右→左で交差選択。Enter/チェックで確定。 |
| 事前選択 / SelectImplied | 既存のGetSelectionAsync()/UsePreselection=true | 引数なし版は現在選択の取得。DocumentInfoとprompt付きの拡張メソッドはユーザーへ新たに選択を要求する。 |
| 条件・範囲選択 / SelectionFilter・SelectWindow・SelectCrossingWindow・SelectAll | SelectionFilter / SelectRegionAsync | Mode=all/window/crossing。Kinds・Layersは各リスト内OR、リスト間AND。種類はLine・Ellipse・Solid等のEntityInfo.Kindと同じ名前。 |
| 面・エッジ選択 | GetSubentityAsync(document, prompt, "face" / "edge") | SubobjectsにGetTopologyAsyncと共通の参照を返す。Entitiesは所有するソリッド等。形状変更後は取り直す。 |
| 動的仮表示 / Jig・Drag | DragAsync / UpdateInputPreviewAsync | カーソル座標に応じた線・円をコールバックで定義。最大256図形。確定後の本図形は呼出し側で作成。 |
一覧でId・Group・Availableを確認して、使うcommandIdをLaunchInputAsyncへ渡します。戻り値queuedは画面へコマンドを送ったことだけを示し、作図完了を意味しません。以後の点指定やダイアログ入力はCAD上で行います。独自処理で座標・数値・文字・選択結果を受け取る場合は、ICadInputApiのGetPointAsync等を使用します。標準コマンドの起動は、既存の操作を利用する場合に使い分けます。
コード例:input
public static async Task<InteractiveCommandResult> LaunchInputAsync(
ICadInteractionApi cad, string commandId,
CancellationToken ct = default)
{
InteractiveCommandInfo[] commands = await cad.GetInteractiveCommandsAsync(ct);
InteractiveCommandInfo command = commands.Single(c => c.Id == commandId);
if (!command.Available)
throw new InvalidOperationException(command.UnavailableReason);
DocumentInfo doc = await cad.GetDocumentAsync(ct);
return await cad.LaunchInteractiveCommandAsync(new InteractiveCommandRequest(
doc.Id, doc.Revision, Guid.NewGuid().ToString("D"), command.Id), ct);
}ICadInteractionApi.GetInteractiveCommandsAsync
画面コマンドを取得 — 登録された266個のコマンドIDと利用条件を取得します。これらは画面操作の入口で、自動作図のパラメーターAPIではありません。
宣言
Task<InteractiveCommandInfo[]> GetInteractiveCommandsAsync(
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<InteractiveCommandInfo[]>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Id | string |
| Group | string |
| Available | bool |
| UnavailableReason | string |
| UnavailableCode | string |
| LicenseRestriction | LicenseRestriction |
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadInteractionApi.LaunchInteractiveCommandAsync
画面コマンドを起動 — ユーザーが続けて操作するコマンドを起動します。queuedは起動予約の受付であり、作図・保存・解析の完了ではありません。
宣言
Task<InteractiveCommandResult> LaunchInteractiveCommandAsync(
InteractiveCommandRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | InteractiveCommandRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<InteractiveCommandResult>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| CommandId | string |
| State | string |
| Message | string |
要求型
public sealed record InteractiveCommandRequest(string DocumentId,long ExpectedRevision,string OperationId,string CommandId);
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
編集・複写・元に戻す
CopySelectionAsyncは選択図形をX方向へ100 mm複写し、元図形を残します。削除・Undo・Redoの例は、このコードで新規作成した図形だけを対象にします。他の操作とUndoを混在させず、各戻り値Documentのrevisionを引き継ぎます。
コード例:edit
public static async Task<EditResult> CopySelectionAsync(
ICadModelApi cad, CancellationToken ct = default)
{
SelectionInfo selected = await cad.GetSelectionAsync(0, 256, ct);
if (selected.Total == 0 || selected.Total > selected.Entities.Length)
throw new InvalidOperationException("Select 1 to 256 complete model objects.");
DocumentInfo doc = selected.Document;
return await cad.TranslateEntitiesAsync(new TranslateEntitiesRequest(
doc.Id, doc.Revision, Guid.NewGuid().ToString("D"),
selected.Entities.Select(e => e.Id).ToArray(),
new Point3(100, 0, 0), Copy: true), ct);
}コード例:history
public static async Task DeleteOwnExampleAndUndoAsync(
ICadModelApi cad, CancellationToken ct = default)
{
EditResult made = await DrawingAsync(cad, ct);
DocumentInfo doc = made.Document;
EditResult deleted = await cad.DeleteEntitiesAsync(new EntityEditRequest(
doc.Id, doc.Revision, Guid.NewGuid().ToString("D"),
made.Entities.Select(e => e.Id).ToArray()), ct);
doc = deleted.Document;
EditResult undone = await cad.UndoAsync(new HistoryRequest(
doc.Id, doc.Revision, Guid.NewGuid().ToString("D")), ct);
doc = undone.Document;
if (doc.CanRedo)
await cad.RedoAsync(new HistoryRequest(
doc.Id, doc.Revision, Guid.NewGuid().ToString("D")), ct);
}ICadModelApi.TranslateEntitiesAsync
移動または複写 — 1~1000個の図形をWCSのDisplacementだけ移動します。Copy=trueで元を保持。属性を引き継ぎ、全体を1回のUndoとします。
宣言
Task<EditResult> TranslateEntitiesAsync(
TranslateEntitiesRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | TranslateEntitiesRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<EditResult>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Document | DocumentInfo |
| Entities | EntityInfo[] |
| Changed | bool |
要求型
public sealed record TranslateEntitiesRequest(string DocumentId, long ExpectedRevision, string OperationId,
string[] EntityIds, Point3 Displacement, bool Copy = false, bool SelectResult = true);エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadModelApi.DeleteEntitiesAsync
図形を削除 — 対象を情報取得で確認してから、明示した1~1000 IDを削除します。ロックされたレイヤーや失効したIDは拒否します。
宣言
Task<EditResult> DeleteEntitiesAsync(
EntityEditRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | EntityEditRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<EditResult>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Document | DocumentInfo |
| Entities | EntityInfo[] |
| Changed | bool |
要求型
public sealed record EntityEditRequest(string DocumentId, long ExpectedRevision, string OperationId, string[] EntityIds);
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadApi.UndoAsync
直前の操作を取り消す — 手動操作も含む図面の直前の履歴が対象です。APIが作った図形だけを取り消す機能ではありません。
宣言
Task<EditResult> UndoAsync(
HistoryRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | HistoryRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<EditResult>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Document | DocumentInfo |
| Entities | EntityInfo[] |
| Changed | bool |
要求型
public sealed record HistoryRequest(string DocumentId, long ExpectedRevision, string OperationId);
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadApi.RedoAsync
取り消した操作を戻す — CanRedoを確認して実行します。戻り値のDocumentが更新後の状態です。
宣言
Task<EditResult> RedoAsync(
HistoryRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | HistoryRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<EditResult>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Document | DocumentInfo |
| Entities | EntityInfo[] |
| Changed | bool |
要求型
public sealed record HistoryRequest(string DocumentId, long ExpectedRevision, string OperationId);
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
3Dとバックグラウンド処理
RunEditAsyncは開始→状態確認→ready→確定までを担当する共通関数です。計算中に図面が変わると確定できません。その場合は選択と参照を取り直して最初から計算します。キャンセル時は専用CancelJobAsyncでワーカーも停止します。BoxAsyncの例は80×50×20 mmです。
コード例:worker
public static async Task<EditResult> RunEditAsync<T>(
ICadJobApi cad, string operation, T parameters,
CancellationToken ct = default)
{
DocumentInfo doc = await cad.GetDocumentAsync(ct);
JobInfo job = await cad.StartOperationAsync(new StartOperationRequest(
doc.Operation(operation, parameters), TimeoutSeconds: 120), ct);
try
{
while (job.State == "running")
{
await Task.Delay(200, ct);
job = await cad.GetJobAsync(job.Id, ct);
}
if (job.State != "ready")
throw new InvalidOperationException($"{job.State}: {job.ErrorCode}: {job.Message}");
return await cad.CommitJobAsync(new CommitJobRequest(
doc.Id, doc.Revision, Guid.NewGuid().ToString("D"), job.Id), ct);
}
catch (OperationCanceledException)
{
await cad.CancelJobAsync(job.Id, CancellationToken.None);
throw;
}
}コード例:solid
public static Task<EditResult> BoxAsync(
ICadJobApi cad, CancellationToken ct = default) =>
RunEditAsync(cad, "solid.primitive",
new PrimitiveParameters("box", new(0, 0, 0),
Size: new Point3(80, 50, 20)), ct);ICadJobApi.StartOperationAsync
計算ジョブを開始 — 切り離した形状を別プロセスで計算します。この時点では図面を変更しません。running/readyの保持は最大4件、同時実行は1件、時間制限は1~1800秒です。
宣言
Task<JobInfo> StartOperationAsync(
StartOperationRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | StartOperationRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<JobInfo>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Id | string |
| DocumentId | string |
| SourceRevision | long |
| Operation | string |
| State | string |
| Stage | string |
| ResultCount | int |
| ErrorCode | string |
| Message | string |
要求型
public sealed record StartOperationRequest(OperationRequest Request, int TimeoutSeconds = 120);
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadJobApi.GetJobAsync
計算の進捗を取得 — running、ready、completed、failed、cancelled、committedを区別します。readyはまだ図面へ反映されていません。
宣言
Task<JobInfo> GetJobAsync(
string jobId,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| jobId | string | StartOperationAsyncで返ったJobInfo.Id。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<JobInfo>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Id | string |
| DocumentId | string |
| SourceRevision | long |
| Operation | string |
| State | string |
| Stage | string |
| ResultCount | int |
| ErrorCode | string |
| Message | string |
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadJobApi.CancelJobAsync
計算や未確定結果を破棄 — runningの計算を中止し、readyの未確定結果を破棄します。既に確定した図面の取消しにはUndoAsyncを使います。
宣言
Task<JobInfo> CancelJobAsync(
string jobId,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| jobId | string | StartOperationAsyncで返ったJobInfo.Id。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<JobInfo>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Id | string |
| DocumentId | string |
| SourceRevision | long |
| Operation | string |
| State | string |
| Stage | string |
| ResultCount | int |
| ErrorCode | string |
| Message | string |
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
ICadJobApi.CommitJobAsync
計算結果を図面に反映 — readyの結果を1回のUndoで反映します。開始後に図面が変わっていれば拒否。開始とは別のUUIDを使い、ライセンスも再判定します。
宣言
Task<EditResult> CommitJobAsync(
CommitJobRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | CommitJobRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<EditResult>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Document | DocumentInfo |
| Entities | EntityInfo[] |
| Changed | bool |
要求型
public sealed record CommitJobRequest(string DocumentId, long ExpectedRevision, string OperationId, string JobId);
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
板金
SheetAsyncは既定設定をQueryAsyncで表示した後、例として板厚1・内R2・K係数0.4の基本板を作ります。この例の数値を実部品の既定値として固定しないでください。後続のフランジなどは新しいエッジ参照を取り直して実行します。
コード例:sheet
public static async Task<EditResult> SheetAsync(
ICadWorkspaceApi cad, CancellationToken ct = default)
{
DocumentInfo doc = await cad.GetDocumentAsync(ct);
QueryResult defaults = await cad.QueryAsync(new QueryRequest(
doc.Id, doc.Revision, "sheetDefaults", Array.Empty<string>()), ct);
Console.WriteLine(defaults.Data.GetRawText());
EditResult profile = await RectangleAsync(cad, ct);
// This example intentionally specifies t=1, R=2, K=0.4.
// Use the drawing or the inspected project defaults for production parts.
return await RunEditAsync(cad, "sheet.plate", new SheetPlateParameters(
profile.Entities.Single().Id, new SheetRules(1, 2, .4)), ct);
}計測と解析
操作リファレンス:measure.contour, measure.highlight, analysis.assembly.contacts, analysis.assembly.mesh, analysis.assembly.solve
計測・解析はworker-dataです。completed後にGetJobDataAsyncで結果を取得します。AnalysisAsyncは単一材料の学習例です。アセンブリはanalysis.assembly.contacts/mesh/solveを使い、Bodyごとに材料を指定します。節点・要素・境界を全ページ取得してから解析します。
コード例:data
public static async Task<JobDataPage> MeasureAsync(
ICadWorkspaceApi cad, string[] entityIds, CancellationToken ct = default)
{
DocumentInfo doc = await cad.GetDocumentAsync(ct);
JobInfo job = await cad.StartOperationAsync(new StartOperationRequest(
doc.Operation("measure.geometry", new MeasureParameters(entityIds))), ct);
while (job.State == "running")
{
await Task.Delay(200, ct);
job = await cad.GetJobAsync(job.Id, ct);
}
if (job.State != "completed")
throw new InvalidOperationException($"{job.State}: {job.Message}");
return await cad.GetJobDataAsync(new JobDataRequest(job.Id, "summary"), ct);
}コード例:analysis
public static async Task<JobInfo> RunDataAsync<T>(
ICadWorkspaceApi cad, string operation, T parameters,
CancellationToken ct = default)
{
DocumentInfo doc = await cad.GetDocumentAsync(ct);
JobInfo job = await cad.StartOperationAsync(new StartOperationRequest(
doc.Operation(operation, parameters), TimeoutSeconds: 120), ct);
while (job.State == "running")
{
await Task.Delay(200, ct);
job = await cad.GetJobAsync(job.Id, ct);
}
if (job.State != "completed")
throw new InvalidOperationException($"{job.State}: {job.Message}");
return job;
}
public static async Task<T[]> ReadArrayAsync<T>(
ICadWorkspaceApi cad, string jobId, string section,
CancellationToken ct = default)
{
var items = new List<T>();
do
{
JobDataPage page = await cad.GetJobDataAsync(
new JobDataRequest(jobId, section, items.Count, 128), ct);
T[] batch = page.Data.Deserialize<T[]>(LocalProtocol.Json)
?? throw new InvalidOperationException("Missing result data.");
items.AddRange(batch);
if (items.Count >= page.Total || batch.Length == 0) break;
} while (true);
return items.ToArray();
}
public static async Task<JobDataPage> AnalysisAsync(
ICadWorkspaceApi cad, CancellationToken ct = default)
{
EditResult box = await BoxAsync(cad, ct);
JobInfo job = await RunDataAsync(cad, "analysis.mesh",
new AnalysisMeshParameters(new[] { box.Entities.Single().Id }, 3, 10), ct);
double[][] points = await ReadArrayAsync<double[]>(cad, job.Id, "points", ct);
int[][] elements = await ReadArrayAsync<int[]>(cad, job.Id, "elements", ct);
AnalysisBoundaryData[] boundaries = await ReadArrayAsync<AnalysisBoundaryData>(
cad, job.Id, "boundaries", ct);
int[] GroupsAt(double x) => boundaries.Where(b =>
b.Nodes.All(n => Math.Abs(points[n][0] - x) < 1e-6))
.Select(b => b.Group).Distinct().ToArray();
int[] fixedGroups = GroupsAt(0), loadedGroups = GroupsAt(80);
if (fixedGroups.Length == 0 || loadedGroups.Length == 0)
throw new InvalidOperationException("Expected end faces were not found.");
var mesh = new AnalysisMeshData(3, points, elements, boundaries);
var conditions = new[] {
new AnalysisConditionData("fixed", Groups: fixedGroups),
new AnalysisConditionData("totalforce", Groups: loadedGroups, Z: -100)
};
JobInfo result = await RunDataAsync(cad, "analysis.solve",
new AnalysisSolveParameters(mesh, new AnalysisMaterialData(), conditions), ct);
return await cad.GetJobDataAsync(new JobDataRequest(result.Id, "summary"), ct);
}ICadWorkspaceApi.GetJobDataAsync
計測や解析の結果を取得 — completedのデータジョブからsummaryや結果配列をページ取得します。1~256件。データジョブにはCommitJobAsyncを呼びません。
宣言
Task<JobDataPage> GetJobDataAsync(
JobDataRequest request,
CancellationToken cancellationToken = default
);| 引数 | 型 | 意味 |
|---|---|---|
| request | JobDataRequest | 下記の要求型を作成します。編集時は現在の図面ID・revisionと新しいUUIDが必要です。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<JobDataPage>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Job | JobInfo |
| Section | string |
| Data | Text.Json.JsonElement |
| Total | int |
| Offset | int |
要求型
public sealed record JobDataRequest(string JobId,string Section="summary",int Offset=0,int Limit=128);
エラーと利用条件
図面取得にはno_document、入力にはinvalid_argument、IDにはdocument_changed/revision_conflict/entity_not_foundを確認します。編集はcad_busy/layer_locked/undo_disabledを返す場合があります。権限が必要な操作はlicense_requiredです。スキーマ取得だけでは実行許可になりません。ジョブにはjob_not_found/job_not_ready、計算にはgeometry_failed/invalid_result等があります。詳細は共通エラー表を参照してください。
レイアウト・注記・画面確認
操作リファレンス:layout.view, section.plane, section.generate, animation.view, animation.drive, animation.schedule, animation.control
LayoutAsyncはA4横に独立した平面ビューを配置します。紙面座標は紙のmm、ModelOriginはモデルのWCS mmです。VisibleLayersは対象図形の実際のレイヤ名に合わせます。同名レイアウトがある場合は別名を使います。layout.annotationsで文字付き引き出し線を追加し、view.captureで描画を確認できます。VIEWBASE/VIEWPROJの対話的な投影関係とは別です。 layout.viewではビューの作成・更新・削除と投影関係を指定できます。関連寸法は維持して編集します。 layout.viewではビューの作成・更新・削除と投影関係を指定できます。関連寸法は維持して編集します。
コード例:layout
public static async Task<EditResult> LayoutAsync(
ICadAutomationApi cad, CancellationToken ct = default)
{
DocumentInfo doc = await cad.GetDocumentAsync(ct);
var view = new LayoutViewParameters(new(0, 0, -1), new(0, 1, 0),
new(40, 25, 0), new(100, 110, 0), 1,
new LayoutRectangle(20, 180, 50, 180),
new[] { "Standard", "0", "Example" });
return await cad.ExecuteOperationAsync(doc.Operation("layout.create",
new LayoutCreateParameters("Example-A4", 297, 210, new[] { view },
Array.Empty<GeometryDefinition>(), Array.Empty<LayoutDimensionParameters>())), ct);
}読み込み・保存・書き出し
絶対パスと形式を指定し、completedになるまで確認します。戻り値Bytes・Sha256でファイルを検証できます。既存ファイルの上書きは既定で拒否します。Saveは図面名を変更し、Exportはコピーを書き出します。Warningsも確認してください。document.openは未保存変更がない状態で使用します。保存・出力は形状のUndoでは取り消せません。
コード例:files
public static async Task<FileOperationInfo> SaveAsync(
ICadFileApi cad, string absolutePath, CancellationToken ct = default)
{
FileFormatInfo[] formats = await cad.GetFileFormatsAsync(ct);
if (!formats.Any(f => f.Format == "jdc" && f.CanSave && f.Available))
throw new InvalidOperationException("JDC saving is unavailable.");
DocumentInfo doc = await cad.GetDocumentAsync(ct);
FileOperationInfo operation = await cad.SaveDocumentAsync(new SaveDocumentRequest(
doc.Id, doc.Revision, Guid.NewGuid().ToString("D"), absolutePath, "jdc"), ct);
return await WaitFileAsync(cad, operation, ct);
}
public static async Task<FileOperationInfo> ExportStepAsync(
ICadFileApi cad, string absolutePath, CancellationToken ct = default)
{
DocumentInfo doc = await cad.GetDocumentAsync(ct);
FileOperationInfo operation = await cad.ExportDocumentAsync(new ExportDocumentRequest(
doc.Id, doc.Revision, Guid.NewGuid().ToString("D"), absolutePath, "step"), ct);
return await WaitFileAsync(cad, operation, ct);
}
public static async Task<FileOperationInfo> WaitFileAsync(
ICadFileApi cad, FileOperationInfo operation, CancellationToken ct = default)
{
try
{
while (operation.State == "running")
{
await Task.Delay(200, ct);
operation = await cad.GetFileOperationAsync(operation.OperationId, ct);
}
}
catch (OperationCanceledException)
{
await cad.CancelFileOperationAsync(operation.OperationId, CancellationToken.None);
throw;
}
if (operation.State != "completed")
throw new InvalidOperationException($"{operation.State}: {operation.Error?.Message}");
foreach (string warning in operation.Warnings ?? Array.Empty<string>())
Console.WriteLine(warning);
Console.WriteLine($"{operation.FilePath}: {operation.Bytes} bytes; {operation.Sha256}");
return operation;
}ICadFileApi.GetFileFormatsAsync
Task<FileFormatInfo[]> GetFileFormatsAsync(CancellationToken cancellationToken = default);
完全な要求作成・状態確認・戻り値の使用例はこの分類のfilesコード例にあります。
ICadFileApi.SaveDocumentAsync
Task<FileOperationInfo> SaveDocumentAsync(SaveDocumentRequest request, CancellationToken cancellationToken = default);
完全な要求作成・状態確認・戻り値の使用例はこの分類のfilesコード例にあります。
ICadFileApi.ExportDocumentAsync
Task<FileOperationInfo> ExportDocumentAsync(ExportDocumentRequest request, CancellationToken cancellationToken = default);
完全な要求作成・状態確認・戻り値の使用例はこの分類のfilesコード例にあります。
ICadFileApi.GetFileOperationAsync
Task<FileOperationInfo> GetFileOperationAsync(string operationId, CancellationToken cancellationToken = default);
完全な要求作成・状態確認・戻り値の使用例はこの分類のfilesコード例にあります。
ICadFileApi.CancelFileOperationAsync
Task<FileOperationInfo> CancelFileOperationAsync(string operationId, CancellationToken cancellationToken = default);
完全な要求作成・状態確認・戻り値の使用例はこの分類のfilesコード例にあります。
コマンド登録とアドイン
ExampleAddinとSamplesを同じプロジェクトでビルドします。OnStartupでリボンを登録し、ボタンのExecuteAsyncから作図します。OnShutdownでは自分で登録したイベントやタイマーを解除してください。この例は登録していないので処理を空にしています。独自アドインは対応ライセンスが必要です。
コード例:addin
public sealed class ExampleAddin : ICadAddin
{
public void OnStartup(IAddinContext context)
{
context.RegisterTab(new RibbonTab("example", "Example", new[] {
new RibbonPanel("draw", "Draw", new[] {
new RibbonButton("line-circle", "Line and circle",
"Create example geometry", new DrawCommand())
})
}));
}
public void OnShutdown() { }
private sealed class DrawCommand : IAddinCommand
{
public async Task<CommandResult> ExecuteAsync(ICadApi api, CancellationToken ct)
{
EditResult result = await Samples.DrawingAsync(api, ct);
return new CommandResult($"Created {result.Entities.Length} objects.");
}
}
}IAddinCommand.ExecuteAsync
追加ボタンの処理 — ボタンから呼ばれます。apiで図面にアクセスし、CancellationTokenをAPIへ渡します。返したMessageが空でなければ本体が表示します。
宣言
Task<CommandResult> ExecuteAsync(
ICadApi api,
CancellationToken cancellationToken
);| 引数 | 型 | 意味 |
|---|---|---|
| api | ICadApi | 本体の共通API。必要な追加インターフェースへis/TryCastで変換。 |
| cancellationToken | CancellationToken | 呼出しの中止要求。開始前の待機を中止できます。短い確定処理は開始後に完了して返ります。 |
戻り値
Task<CommandResult>。Taskはawait/Awaitで待機します。
| プロパティ | 型 |
|---|---|
| Message | string |
OnStartupでの登録が成功してからタブが表示されます。Free版は本体同梱サンプルだけです。自作・変更したDLLはSTD/Proで読み込んでください。
IAddinContext.RegisterTab
タブを登録 — OnStartup内だけで呼べます。IDは重複不可。1拡張あたり最大10タブ、1タブ1~20グループ、1グループ1~50ボタンです。
宣言
void RegisterTab(
RibbonTab tab
);| 引数 | 型 | 意味 |
|---|---|---|
| tab | RibbonTab | タブ・グループ・ボタンを構成したRibbonTab。 |
戻り値
void
OnStartupでの登録が成功してからタブが表示されます。Free版は本体同梱サンプルだけです。自作・変更したDLLはSTD/Proで読み込んでください。
ICadAddin.OnStartup
起動時にタブを登録 — DLL読込み後に本体から呼ばれます。context.RegisterTabでタブ・グループ・ボタンを登録します。重い計算や作図はボタン実行へ分けます。
宣言
void OnStartup(
IAddinContext context
);| 引数 | 型 | 意味 |
|---|---|---|
| context | IAddinContext | 本体が渡す登録コンテキスト。ApiとAddinDirectoryを参照可能。 |
戻り値
void
OnStartupでの登録が成功してからタブが表示されます。Free版は本体同梱サンプルだけです。自作・変更したDLLはSTD/Proで読み込んでください。
ICadAddin.OnShutdown
終了時に後処理 — 本体の終了時などに呼ばれます。自分で登録したイベントやリソースを解除します。図面を保存する操作はここへ隠さないでください。
宣言
void OnShutdown();
引数なし。
戻り値
void
OnStartupでの登録が成功してからタブが表示されます。Free版は本体同梱サンプルだけです。自作・変更したDLLはSTD/Proで読み込んでください。
メソッド名索引
| Method | 分類 |
|---|---|
| CancelFileOperationAsync | 読み込み・保存・書き出し |
| CancelJobAsync | 3Dとバックグラウンド処理 |
| CommitJobAsync | 3Dとバックグラウンド処理 |
| CreateCurvesAsync | 作画:線・円・閉輪郭 |
| CreateGeometryAsync | 作画:線・円・閉輪郭 |
| DeleteEntitiesAsync | 編集・複写・元に戻す |
| ExecuteAsync | コマンド登録とアドイン |
| ExecuteOperationAsync | 設定と接続 |
| ExportDocumentAsync | 読み込み・保存・書き出し |
| GetAttributesAsync | 選択と図形の調査 |
| GetCapabilitiesAsync | 設定と接続 |
| GetDocumentAsync | 設定と接続 |
| GetEntitiesAsync | 選択と図形の調査 |
| GetEntityDetailsAsync | 選択と図形の調査 |
| GetFileFormatsAsync | 読み込み・保存・書き出し |
| GetFileOperationAsync | 読み込み・保存・書き出し |
| GetInteractiveCommandsAsync | 入力と対話コマンド |
| GetJobAsync | 3Dとバックグラウンド処理 |
| GetJobDataAsync | 計測と解析 |
| GetLayersAsync | 設定と接続 |
| GetOperationSchemaAsync | 設定と接続 |
| GetSelectionAsync | 選択と図形の調査 |
| GetTopologyAsync | 選択と図形の調査 |
| LaunchInteractiveCommandAsync | 入力と対話コマンド |
| OnShutdown | コマンド登録とアドイン |
| OnStartup | コマンド登録とアドイン |
| QueryAsync | 選択と図形の調査 |
| RedoAsync | 編集・複写・元に戻す |
| RegisterTab | コマンド登録とアドイン |
| SaveDocumentAsync | 読み込み・保存・書き出し |
| SetSelectionAsync | 選択と図形の調査 |
| StartOperationAsync | 3Dとバックグラウンド処理 |
| TranslateEntitiesAsync | 編集・複写・元に戻す |
| UndoAsync | 編集・複写・元に戻す |