JDesignCAD / CUSTOMIZATION / API 1.4

カスタマイズマニュアル

対話入力と選択:点・数値・文字・図形選択・仮表示を独自コマンドで使う

らせん回転ソリッド・実体ねじ API / MCP

らせん・干渉チェック API / MCP

保存・書き出し、5メソッドとMCP、形式・完了・エラーの詳細

公開メソッドリファレンス:宣言・引数・戻り値・使用例

Free版とカスタマイズの利用条件

Free版は配布時の「APIサンプル」10コマンドだけを利用できます。独自DLLと変更したサンプルの実行には、有効なSTDまたはProライセンスが必要です。Free版ではサンプルの名前・IDを使っても外部DLLのコードは実行せず、本体に同梱されたサンプルを実行します。変更が反映されない場合は[読込状況]とプランを確認してください。C#/VB.NETの実習サンプルを自作DLLとして読み込む場合もSTD/Proが必要です。

MCPはFree版でも使用できます。通常の作図・編集APIは利用でき、板金・解析のAPIはライセンス判定で拒否されます。独自DLLの読込み制限とMCP接続の可否は別です。

JDesignCADの追加DLL、独立した.NETプログラム、MCPは同じ共通APIを使用します。図形ID・座標・寸法などを明示して呼び出し、図面への反映とUndoは本体が管理します。APIにCADエンジンは含まれません。対象のJDesignCADと図面を開いて使います。

1. 開発環境を準備C#・VB.NET、参照DLL、配置、デバッグまで。2. サンプルを動かす作図、3D計算、板金、選択、Undo。3. 目的別リファレンスで調べる設定、作画、選択、入力などの分類、引数と実行コード例。4. 対応範囲を確認266個の登録コマンドと共通APIの対応方法。

操作の3つの形

種別用途完了の判断
数値・ID指定の自動操作作図、図形定義・属性・レイヤー変更、変換、ブロック、寸法ExecuteOperationAsyncがEditResultを返す。図形変更は1回のUndo。
別プロセスで計算3D加工、板金、曲線加工、計測、解析readyならCommitJobAsyncで図面へ反映。計測・解析はcompletedになり、GetJobDataAsyncで結果を読む。
対話コマンドの起動既存の作図入力、印刷・保存画面、設定などqueuedは起動予約の受付。ユーザーがCAD画面で完了する。処理完了の通知ではない。

「すべてのコマンドを起動できること」と「すべてを無人で実行できること」は別です。共通APIは93種類の構造化操作と、266個の登録コマンドの一覧・対話起動を提供します。ブール演算3件は別プロセスのAPIを使います。形状依存の失敗、画面操作が必要な機能、未公開の編集項目は対応表に記載しています。板金・解析は本体と同じSTD/Proの条件が適用されます。

配布物とDLLの配置

JDesignCAD.exe のフォルダー/
  JDesignCAD.Api.dll                   公開契約
  JDesignCAD.Automation.Worker.exe     計算用ワーカー
  Customization/
    使い方.html                       このマニュアル
    reference.ja.html                 APIリファレンス
    coverage.ja.html                  対応表
    SDK/Api/                         DLLとIntelliSense用XML
    SDK/Samples/Customization.Sample/     実用コマンド10例
    SDK/Samples/Customization.Workshop/   C#実習
    SDK/Samples/Customization.WorkshopVB/ VB.NET実習
    Mcp/JDesignCAD.Mcp.exe
    mcp-config.json

追加DLLの配置先は%LOCALAPPDATA%\JDesignCAD\Addins\拡張名です。[カスタマイズ]→[DLLフォルダー]から開けます。各フォルダーへaddin.json、作成したDLL、依存DLL、アイコンを配置し、JDesignCADを再起動します。

DLLは本体と同じWindowsユーザーの権限で動作します。読込分離はセキュリティ用の隔離ではありません。自作または内容を確認した拡張を配置してください。

APIサンプル:実用コマンド

[APIサンプル]タブには文字連番・置換・大文字小文字・文字囲み、等間隔複写・同種同層選択・重複線整理・色をByLayer、長さ面積集計・ブロック集計の10例を配置しています。共通APIだけで作るサンプルです。操作方法・対応API・ソースの読み方をご覧ください。[カスタマイズ]タブの管理コマンドは変更していません。

APIの共通ルール

  1. コマンドやダイアログを終了し、モデル空間をアクティブにします。
  2. GetDocumentAsyncで図面IDとrevisionを取得します。
  3. 図形は選択・一覧取得で返されたIDを使います。IDは現在開いている図面のセッション内だけで有効です。
  4. 変更には新しいUUIDのoperationIdを付けます。通信切断後の再試行は同じリクエスト・同じUUIDにします。
  5. 変更後は返されたDocumentInfoを使うか、再取得します。面・辺・頂点の参照はrevisionが変わるたびに取り直します。

座標はWCS、長さはmm、角度は度です。表示単位・UCSに依存しません。ロックしたレイヤー、Undo無効、他のコマンド実行中、古いrevisionには書込みを拒否します。大きな図面では一覧と結果をページ単位で取得してください。

問題が起きたとき

症状確認
タブが出ない[読込状況]。addin.jsonのassembly・entryType・enabled、.NET 8/x64、DLL参照。
以前のDLLが動く本体を終了して差し替え、再起動。重複したaddin idや配置先違いも確認。
cad_busyCAD入力・ダイアログを終了。UIスレッドでTask.Wait/Resultを使わずAwait/awaitする。
revision_conflict図面・対象・面参照を再取得して計算をやり直す。古い計算結果に新revisionを付けても反映不可。
worker_unavailable本体と同じ版のAutomation.Workerのexe・dll・deps.json・runtimeconfig.jsonを一緒に配布。
geometry_failed / invalid_result寸法、板厚、閉鎖、交差、辺・面の参照を確認。元図面は保持。全形状で成功する保証はない。
license_requiredSTD/Proが必要。DLLとMCPで同じ判定。
message_too_largeローカル通信は1メッセージ1 MiBまで。取得ページを小さくする。巨大な解析入力はMCP送信に制約あり。

読込・対話起動ログは%LOCALAPPDATA%\JDesignCAD\Automation配下です。queued後に画面が変わらない場合は、現在の選択・画面・コマンドの有効状態も確認します。