独自のコマンドでは、ユーザーから座標や値を受け取り、その結果を使って作図・編集します。ICadInputApiは標準コマンドを起動せず、入力そのものを提供します。待っている間もCAD画面は操作でき、仮表示は図面やUndo履歴に登録されません。
入力を受け取る流れ
- ICadApiをICadInputApiへキャストし、GetDocumentAsyncで図面情報を取得します。
- GetPointAsync等をawait/Awaitで待ちます。UIスレッドで.Wait()や.Resultを使用しません。
- Acceptedを確認します。Escはcancelled、明示的にAllowNoneを許可した空入力はnoneです。
- 結果のDocumentを次の入力または編集へ渡します。入力中に図面・ビュー・図形が変わると中止されます。
- 座標・選択ID・数値を使い、CreateGeometryAsyncやTranslateEntitiesAsync等で確定します。
CancellationTokenの中止は入力も閉じ、OperationCanceledExceptionを返します。ユーザーのEscは例外ではなくcancelledです。入力の途中で編集を呼ぶとcad_busyになります。1ウィンドウで同時に1入力だけ開始できます。
目的別メソッド
| 目的 / 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図形。確定後の本図形は呼出し側で作成。 |
2点から線分を作る
以下はIAddinCommandの実装です。.NET 8 Windows / x64を使用し、本体付属のCustomization/SDK/Api/JDesignCAD.Api.dllを参照します。ボタン登録・addin.json・円の仮表示・選択複写を含むプロジェクトはCustomization/SDK/Samples/Customization.InputCSとCustomization.InputVBにあります。
C#
using System; using System.Threading; using System.Threading.Tasks; using JDesignCAD.Api; を宣言してください。
public sealed class TwoPointLineCommand : IAddinCommand
{
public async Task<CommandResult> ExecuteAsync(ICadApi api,CancellationToken cancellationToken)
{
var input=(ICadInputApi)api;
var doc=await api.GetDocumentAsync(cancellationToken);
// 1点目をユーザーが指示するまで待つ。
var first=await input.GetPointAsync(doc,"1点目を指示してください",cancellationToken:cancellationToken);
if(!first.Accepted)return new CommandResult("");
// 1点目からマウス位置へラバーバンドを表示し、2点目を待つ。
var second=await input.GetPointAsync(first.Document,"2点目を指示してください",
basePoint:first.Point,cancellationToken:cancellationToken);
if(!second.Accepted)return new CommandResult("");
var a=first.Point!;var b=second.Point!;
if(Math.Sqrt(Math.Pow(b.X-a.X,2)+Math.Pow(b.Y-a.Y,2)+Math.Pow(b.Z-a.Z,2))<=1e-6)
return new CommandResult("異なる2点を指示してください。");
// ここからが自作の作図処理。標準の線分コマンドは呼ばない。
await api.CreateGeometryAsync(new CreateGeometryRequest(
second.Document.Id,second.Document.Revision,Guid.NewGuid().ToString("D"),
new[]{new LineDefinition(a,b)},Array.Empty<CircleDefinition>()),cancellationToken);
return new CommandResult("");
}
}
VB.NET
Imports System、System.Threading、System.Threading.Tasks、JDesignCAD.Apiを宣言してください。
Public NotInheritable Class TwoPointLineCommand
Implements IAddinCommand
Public Async Function ExecuteAsync(api As ICadApi, cancellationToken As CancellationToken) As Task(Of CommandResult) Implements IAddinCommand.ExecuteAsync
Dim input = DirectCast(api, ICadInputApi)
Dim doc = Await api.GetDocumentAsync(cancellationToken)
' 1点目をユーザーが指示するまで待つ。
Dim first = Await input.GetPointAsync(doc, "1点目を指示してください", cancellationToken:=cancellationToken)
If Not first.Accepted Then Return New CommandResult("")
' 1点目からマウス位置へラバーバンドを表示し、2点目を待つ。
Dim second = Await input.GetPointAsync(first.Document, "2点目を指示してください", basePoint:=first.Point, cancellationToken:=cancellationToken)
If Not second.Accepted Then Return New CommandResult("")
Dim a = first.Point
Dim b = second.Point
If Math.Sqrt((b.X - a.X) ^ 2 + (b.Y - a.Y) ^ 2 + (b.Z - a.Z) ^ 2) <= 0.000001 Then Return New CommandResult("異なる2点を指示してください。")
' ここからが自作の作図処理。標準の線分コマンドは呼ばない。
Await api.CreateGeometryAsync(New CreateGeometryRequest(
second.Document.Id, second.Document.Revision, Guid.NewGuid().ToString("D"),
New LineDefinition() {New LineDefinition(a, b)}, Array.Empty(Of CircleDefinition)()), cancellationToken)
Return New CommandResult("")
End Function
End Class
数値・文字・キーワードを使う
var input = (ICadInputApi)api;
var doc = await api.GetDocumentAsync(ct);
var count = await input.GetIntegerAsync(doc, "個数を入力",
new ValueInputOptions(DefaultNumber: 3, Minimum: 1, Maximum: 100), ct);
if (!count.Accepted) return;
int copies = (int)count.Number!.Value;
var name = await input.GetStringAsync(count.Document, "名称を入力",
new ValueInputOptions(DefaultText: "部品", AllowSpaces: true), ct);
if (!name.Accepted) return;
var mode = await input.GetKeywordsAsync(name.Document, "処理を選択",
new[] { "Move", "Copy" }, "Copy", ct);
if (!mode.Accepted) return;
bool copy = mode.Text == "Copy";
メソッドごとの専用オーバーロードは通常の入力用です。空Enterを受け付けたい場合はPromptAsyncへCadInputRequestを渡し、AllowNone=trueにします。数値が不正な場合やキーワードが曖昧な場合は、案内を表示して同じ入力を続けます。
図形を選択する
var selection = await input.GetSelectionAsync(doc, "線分を選択してEnter",
new SelectionInputOptions(
Filter: new SelectionFilter(Kinds: new[] { "Line" }),
UsePreselection: true), ct);
if (!selection.Accepted) return;
string[] ids = selection.Entities!.Select(e => e.Id).ToArray();
// 円の種類名もEllipseです。名前はGetEntitiesAsyncのKindで確認します。
// 閉じた範囲内に完全に収まる図形を取得します。
var inside = await input.SelectRegionAsync(new SelectionRegionRequest(
selection.Document.Id, selection.Document.Revision, "window",
new Point3(0, 0, 0), new Point3(100, 50, 0),
Filter: new SelectionFilter(Layers: new[] { "Standard" }),
SetSelection: false), ct);
最大1000図形です。非表示のトップレベル図形は対象外、ロック図形はIncludeLocked=trueを明示したときだけ対象です。取得してもロック図形の編集許可にはなりません。窓は完全包含、交差窓は交差を含みます。範囲はWCS座標を現在のビューへ投影して判定します。
GetSubentityAsyncはトップレベルのSolid/Shell/Faceの面・エッジをクリック選択します。複数ならGetSelectionAsyncのTarget="face"または"edge"を指定します。部分選択では窓・事前選択は使用せず、Kinds/Layersフィルターは所有する本体に適用します。SubobjectsのIndexとRevisionはGetTopologyAsyncと共通で、後続のフィレット等へ渡せます。
独自の仮表示
DragAsyncは点入力中のCursorPointに対してコールバックを実行し、InputPreviewRequestで返された線・円を仮表示します。コールバック内で図面を編集しないでください。円のサンプルでは中心からカーソルまでの距離から半径を計算し、ユーザーが確定した後にCreateGeometryAsyncで円を作成します。このサンプルの円はWCS XY平面です。
UpdateInputPreviewAsyncで空配列を渡すと仮表示を消せます。accepted/cancelledになれば自動的に仮表示が消えます。CursorPointは未確定値なので、これだけを根拠に本図形を作成しないでください。
MCP・外部プログラムから入力を待つ
- cad_start_input / StartInputAsyncへCadInputRequestを送ります。Kindはpoint・corner・distance・angle・integer・double・string・keyword・entity・selectionです。
- cad_get_input / GetInputAsyncを適切な間隔で呼びます。waitingの間はユーザーがCAD画面を操作します。通信リクエストを長時間保持しません。
- acceptedのPoint/Number/Text/Entities/Subobjectsを使います。cad_cancel_input / CancelInputAsyncで中止できます。
図面内でOperationIdを再利用するときは同一のリクエストに限ります。OperationIdはInputIdにもなります。変更した引数で同じIDを使うとoperation_conflictです。新しい作図処理には別のOperationIdを付けます。終了した入力の結果は図面を開き直すまで取得できます。上限1024入力です。MCPの仮表示はcad_update_input_preview、範囲選択はcad_select_regionです。
対応範囲
AutoCADのAPIと役割を比較して設計していますが、型やバイナリーの互換APIではありません。名前だけを置換してAutoCADのソースを実行することはできません。現在はモデル空間の対話入力、トップレベル図形と本体の面・エッジ選択、線・円による仮表示が対象です。
ブロック内部の入れ子選択と変換行列(GetNestedEntity相当)、フェンス・多角形選択、点入力途中のキーワード分岐、任意の3Dモデルをドラッグする全面的なJig互換は未対応です。必要な操作と未対応部分を区別してコマンドを設計してください。
参考:Autodesk公式 Editorメソッド一覧、選択セットとフィルター。JDesignCADで利用できる内容は、このページと本体のInputMethods・型定義を基準にしてください。