EXAMPLES / API 1.2

共通APIの実装例

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

以下はIAddinCommand.ExecuteAsync内のC#コードです。apiはICadApi、ctは渡されたCancellationTokenを表します。コード全体が必要な場合は、同梱のCustomization.Workshopプロジェクトを使用してください。

線分・楕円・文字をまとめて作成

if (api is not ICadAutomationApi cad)
    throw new InvalidOperationException("API 1.2が必要です。");
var doc = await cad.GetDocumentAsync(ct);
var request = doc.Operation("geometry.create", new CreateObjectsParameters([
    new(Line: new(new(0, 0, 0), new(50, 0, 0))),
    new(Ellipse: new(new(25, 20, 0), new(15, 0, 0), new(0, 8, 0))),
    new(Text: new("加工基準", new(0, 40, 0), new(1, 0, 0), new(0, 1, 0), 5))
]));
var result = await cad.ExecuteOperationAsync(request, ct);
// 全図形をまとめて、1回のUndoで取り消せます。
return new CommandResult($"{result.Entities.Length}個作成しました。");

GeometryDefinitionはLine/Circle/Arc/Polyline/Ellipse/Spline/Text/Pointのうち1つだけを指定します。Splineは通過点指定です。詳細取得のスプラインは正確な極点・節点・重みを返すため、そのまま通過点入力として使うことはできません。

選択図形を回転する

var cad = (ICadAutomationApi)api;
var selection = await cad.GetSelectionAsync(cancellationToken: ct);
if (selection.Total == 0) return new CommandResult("図形を選択してください。");
if (selection.Total != selection.Entities.Length)
    return new CommandResult("ページを追加取得してから実行してください。");
var ids = selection.Entities.Select(e => e.Id).ToArray();
var request = selection.Document.Operation("entities.rotate",
    new RotateParameters(ids, new(0, 0, 0), new(0, 0, 1), 30));
await cad.ExecuteOperationAsync(request, ct);
return new CommandResult("WCSのZ軸を中心に30度回転しました。");

箱の作成:計算と反映を分ける

var cad = (ICadJobApi)api;
var doc = await cad.GetDocumentAsync(ct);
var request = doc.Operation("solid.primitive",
    new PrimitiveParameters("box", new(0, 0, 0), new(20, 30, 10)));
var job = await cad.StartOperationAsync(new(request, TimeoutSeconds: 120), ct);
try
{
    while (job.State == "running")
    {
        await Task.Delay(250, ct);
        job = await cad.GetJobAsync(job.Id, ct);
    }
    if (job.State != "ready")
        throw new InvalidOperationException(job.ErrorCode + ": " + job.Message);
    var current = await cad.GetDocumentAsync(ct);
    var committed = await cad.CommitJobAsync(new(current.Id, current.Revision,
        Guid.NewGuid().ToString("D"), job.Id), ct);
    return new CommandResult("箱を作成しました。");
}
catch
{
    try { await cad.CancelJobAsync(job.Id, CancellationToken.None); } catch { }
    throw;
}

readyになるまでは図面を変更しません。計算中に手動編集や別APIの変更が入ると、CommitJobAsyncは拒否されます。無理にrevisionだけを書き換えず、対象を取り直して計算します。タイムアウト・中止はAPIが起動した計算プロセスを停止します。

面・辺を選んで加工

GetTopologyAsyncでkindをface/edge/vertexに指定して取得します。返されたReferenceをそのままFaceOffsetParameters/FilletParameters等へ渡します。Indexを固定値で決め打ちせず、Bounds、GeometryType、Position、Normal、Lengthと対象図形の情報を使って選びます。平面以外の面ではPosition/Normalがnullになることがあります。

var doc = await cad.GetDocumentAsync(ct);
var faces = await cad.GetTopologyAsync(new(doc.Id, doc.Revision, solidId,
    Kind: "face", Limit: 256), ct);
// wantedFaceは取得結果から条件で決定。複数候補なら利用者に選択してもらう。
var request = doc.Operation("face.offset",
    new FaceOffsetParameters(solidId, [wantedFace.Reference], 5));
// StartOperationAsync → ready → CommitJobAsync の順に実行。

面のコピー・移動で得た新しいソリッドには新しいIDが返ります。次の加工には結果のEntitiesを使用します。形状更新前の辺・面番号を使い回してはいけません。

板金の作成・加工・再編集

var doc = await cad.GetDocumentAsync(ct);
var request = doc.Operation("sheet.loft", new SheetLoftParameters(
    new SheetRules(Thickness: 1, Radius: 1, KFactor: .4),
    new SheetLoftDimensions(Kind: 3, FormingMode: 1, Height: 80,
        BottomWidth: 100, BottomDepth: 80, TopWidth: 60, TopDepth: 40,
        CornerRadius: 10, TopCornerRadius: 6,
        OffsetX: 10, SeamMode: 1, SeamAngle: 45)));
// ジョブで作成。STD/Proが必要。
  1. sheet.unfoldを実行し、返されたソリッドIDを取得します。
  2. 円・閉輪郭からgeometry.extrudeで工具ソリッドを作り、solid.booleanのsubtractで穴・切欠きを加工します。Booleanは先頭IDが加工される母材です。
  3. sheet.refoldで加工を保持して再曲げします。
  4. sheet.loftのEntityIdに現在のロフトIDを指定すると、Dimensions/Rulesで寸法と角Rを変更できます。加工位置は展開板の基準からの距離を維持します。

既存の板金エンジンと同じ形状条件が適用されます。加工が新しい板の外側に出る、曲げとの干渉、非展開形状などは失敗します。自由なソリッド変形をすべて板金として復元する機能ではありません。

計測・解析の結果を読む

measure.geometry、measure.contour、analysis.mesh/solve、analysis.assembly.*は図形を挿入しません。stateがcompletedになったらGetJobDataAsyncを呼びます。CommitJobAsyncは使いません。

var workspace = (ICadWorkspaceApi)api;
var summary = await workspace.GetJobDataAsync(new(jobId, "summary"), ct);
var firstPage = await workspace.GetJobDataAsync(new(jobId, "items", 0, 128), ct);
// measure.geometry: summary / items
// analysis.mesh: summary / points / elements / boundaries / edgeBoundaries / vertexNodes
// analysis.solve: summary / values / elementValues / nodeReactions /
//                elementStrains / equivalentStrains / thermalFrames

analysis.mesh/solveは単一材料、analysis.assembly.*は3D部品別材料を対象とします。メッシュの節点番号は0始まり、要素は2次要素です。荷重はN、応力はN/mm²、熱流束はW/mm²、対流係数はW/(mm² K)です。材料の熱伝導率W/(m K)とは単位が異なるため、リファレンスを確認してください。

アセンブリのメッシュを解析へ渡す

先に analysis.assembly.contacts で接合面を確認し、同じ部品順で analysis.assembly.mesh を実行します。接合させない面のGroup番号をExcludedContactGroupsに指定します。次のコードは、メッシュジョブがcompletedになった後の例です。メッシュの配列は256件を超えるため、全ページを取得してください。

var cad = (ICadWorkspaceApi)api;
// meshJobId: 完了した analysis.assembly.mesh のジョブID
async Task<T[]> ReadAll<T>(string section)
{
    var items = new List<T>();
    int offset = 0;
    while (true)
    {
        var page = await cad.GetJobDataAsync(
            new(meshJobId, section, offset, 256), ct);
        var batch = page.Data.Deserialize<T[]>(LocalProtocol.Json)!;
        items.AddRange(batch);
        offset += batch.Length;
        if (offset >= page.Total) return items.ToArray();
    }
}
var mesh = new AnalysisMeshData(3,
    await ReadAll<double[]>("points"),
    await ReadAll<int[]>("elements"),
    await ReadAll<AnalysisBoundaryData>("boundaries"),
    await ReadAll<AnalysisBoundaryData>("edgeBoundaries"),
    await ReadAll<int>("vertexNodes"));
var assemblyMesh = new AssemblyMeshData(mesh,
    await ReadAll<int>("elementBodies"),
    await ReadAll<string>("bodyNames"),
    await ReadAll<AnalysisContactData>("contacts"),
    await ReadAll<AnalysisBoundaryData>("bodySurfaces"));
// BodyNamesの順に部品ごとの材料を設定します。
var materials = assemblyMesh.BodyNames.Select(name =>
    new AnalysisMaterialData(name, YoungModulus: 200000)).ToArray();
// 条件は取得したメッシュの面Group番号・稜線・節点番号から指定します。
// conditions は AnalysisConditionData[]。図形を変更したらメッシュを再作成。
var doc = await cad.GetDocumentAsync(ct);
var request = doc.Operation("analysis.assembly.solve",
    new AssemblySolveParameters(assemblyMesh, materials, conditions,
        Kind: "elastic"), selectResult: false);
var solveJob = await cad.StartOperationAsync(new(request, 180), ct);
// completedを待って values / elementValues / summary 等を取得します。

接合設定は完全接合または非接合です。摩擦や接触離脱を伴う非線形接触は対象外です。接合設定を変える場合はメッシュから作り直します。解析結果はAPIのデータとして取得でき、解析画面へのスタディ登録は対話操作です。

独立した.NETプログラムから接続

var sessions = LocalProtocol.FindSessions();
// 対象ウィンドウを利用者に選んでもらい、対応するSessionInfoをselectedに設定。
ICadInteractionApi cad = new LocalCadClient(selected);
var doc = await cad.GetDocumentAsync();

同じWindowsユーザーの起動中JDesignCADへ接続します。別の図面へ自動で切り替えることはありません。外部プログラムでもrevision、operationId、ライセンスとUndoの規則は共通です。