CATIAのAPIとは何か——マクロから触れる範囲と、最初に開く資料の探し方
「CATIA の API」と調べると、用語の説明は出てきても、結局マクロで何に触れるのか、どの資料から開けばよいのかが分かりにくい、という声を聞きます。API という言葉は難しそうに聞こえますが、CATIA の現場で使うときは、画面で行う操作に名前をつけて、マクロや外のプログラムから呼べるようにしたもの、と考えると整理できます。この記事では、API が指すもの、マクロから触れる範囲の考え方、最初に開く資料の探し方、そして自分の作業が API で届くかどうかの見極め方を、短いコード例とあわせて順に書きます。マクロを作る手順そのものはCATIA VBAでマクロを作る手順に書いたので、こちらは「何に触れるか」「どこで調べるか」の話です。
Photo: UnsplashAPIとは、画面の操作に名前をつけて外から呼べるようにしたもの
CATIA の画面では、スケッチを描き、パッドを作り、パラメータを変え、ファイルを保存します。API は、これらの操作や、操作の対象になるものを、名前のついた部品として用意したものです。マクロは、その名前を呼んで CATIA に仕事を頼みます。
たとえば「いま開いている文書」「その中のパート」「パートの中のボデー」には、それぞれ名前があります。名前を順にたどれば、画面を開かなくても、中身を読んだり、変えたりできます。マクロを書くとは、この名前を並べて、操作の手順を文章にすることだと言ってもよいと思います。
CATIA のマクロで使う API は、Automation と呼ばれることがあります。資料や画面の中で Automation という語が出てきたら、同じものを指していると考えて構いません。
なお、CATIA には、C++ で機能を作り込む別の開発の道もあります。この記事は、現場でマクロとして使う側、つまり VBA や CATScript から呼ぶ API の話に絞ります。言語の選び方はCATIA VBAとCATScript・VB.NET——自動化の言語はどれを選ぶべきかに整理してあります。
触れる範囲は、親から子へたどる木の形になっている
API の部品は、ばらばらに置かれているのではなく、親と子の木の形でつながっています。いちばん上に CATIA というアプリケーションがあり、その下に開いている文書、文書の下にパートやプロダクト、パートの下にボデーやスケッチ、というように、画面のツリーと近い順で並びます。
この形を知っておくと、調べ方が変わります。やりたいことが「ボデーの名前を取る」なら、アプリケーションから文書、パート、ボデーとたどる道を探せばよいと分かります。たどる道が見つかれば、あとは各段の名前を並べるだけです。
下のコード例は、その木を3段たどって、開いているパートの中身を一覧にするだけのものです。モデルは変えません。最初は、読むだけの例で、名前をたどる感覚をつかむのがおすすめです。実際の操作で図形を選ぶ段になると、選択を扱う部品が主役になります。こちらはCATIAマクロの主役はSelectionオブジェクト——現場で使う選択テクニック集にまとめています。
木の形は、画面のツリーとまったく同じではありません。画面で一つに見えるものが、API では二つの部品に分かれていたり、その逆だったりします。この違いに戸惑ったときは、次に書く「記録」と「オブジェクトブラウザ」が助けになります。
' CATIA のオブジェクトを上から順にたどって、開いているパートの中身を一覧にする(CATIA V5 / パート)。
' APIとは「CATIA の部品を、名前で呼んで操作できるようにしたもの」。まず読むだけの例で形をつかむ。
Option Explicit
Sub ListPartContents()
Dim oDoc As Document, oPart As Part, i As Long, s As String
' 1段目: アプリケーション(CATIA)が持っている、いま開いている文書
If TypeName(CATIA.ActiveDocument) <> "PartDocument" Then
MsgBox "パート(Part)を開いて実行してください。": Exit Sub
End If
Set oDoc = CATIA.ActiveDocument
' 2段目: 文書の中のパート
Set oPart = oDoc.Part
' 3段目: パートの中のボデーと、ジオメトリカルセット
s = oDoc.Name & vbCrLf
For i = 1 To oPart.Bodies.Count
s = s & "ボデー " & i & ": " & oPart.Bodies.Item(i).Name & vbCrLf
Next
s = s & "ジオメトリカルセットの数: " & oPart.HybridBodies.Count
MsgBox s ' 読んだだけ。モデルは変えない
End Sub最初に開く資料は、記録したマクロとオブジェクトブラウザ
資料というと、分厚いリファレンスを思い浮かべるかもしれません。ですが、最初に開くのは別のものです。まず、CATIA の「マクロの記録」で、画面でやった操作をそのまま記録します。記録されたコードを読めば、その操作がどの名前で呼ばれているかが、実例として見えます。
次に、VBA のエディターにあるオブジェクトブラウザを開きます。エディターの表示メニューか、F2 キーで開きます。ここには、CATIA が用意している部品の一覧と、それぞれの持つ項目が並びます。記録で見つけた名前を検索欄に入れると、同じ仲間の部品や、使える操作が一覧で見えます。
それでも足りないときに、製品に付いてくるオンラインのヘルプや、開発者向けの資料を開きます。Automation の資料は、部品ごとに、持っている項目と使い方を説明する形です。どこに入っているかは、版や導入の仕方で違うことがあるので、御社の CATIA で一度探しておくと安心です。
順番をまとめると、記録で名前を見つけ、ブラウザで仲間を探し、資料で使い方を確かめる、になります。いきなり資料から読み始めると、部品の数が多くて、何を探してよいか分からなくなります。
記録したコードは、そのままでは長く、選択を含むので壊れやすい面があります。記録は「名前を知るための手がかり」として使い、実際に動かすコードは自分で整えるのが、現場での使い方です。つまずきやすい点はCATIAマクロを始める人が最初につまずく5つのことにもまとめています。
名前を知れば、操作は文章になる。
まず、記録で名前を見つけることから。
自分の作業がAPIで届くかを見極める
API を知ったあとに気になるのは、自分の作業が API で届くのかという点です。画面で行う操作のすべてが、API として用意されているとは限りません。機能によって、用意の厚さにも差があります。
見極めは、三つの順で進めます。まず、画面で行う手順を紙に書き出します。次に、その手順の一つひとつを記録で取り、名前が出てくるかを見ます。最後に、出てこない手順は、オブジェクトブラウザや資料で探します。ここまで調べて見つからなければ、その操作は API では届きにくい、と判断します。
届きにくい操作が見つかっても、あきらめる必要はありません。別の操作で同じ結果を作れることがあります。たとえば、画面で一度に行う操作を、複数の細かい操作に分けて呼ぶ、といった形です。それでも難しいときは、その手順だけは人が行い、前後をマクロでつなぐ、という分け方もあります。
届くかどうかは、使う機能(ワークベンチ)や CATIA の版にも左右されます。ライセンスとの関係はCATIAのライセンスとマクロの関係——買う前に、マクロで届く範囲を確かめるに書きました。
CATIA 以外の CAD を使っている現場では、見極めの項目が変わります。その場合はCATIA以外のCADでも自働化できるのか——API対応の見極め方が参考になります。
VBAでも、外のプログラムからでも、呼ぶ名前は同じ
API の良いところは、呼ぶ側の言語が変わっても、呼ぶ名前が変わらないことです。CATIA の中の VBA でも、Excel のマクロでも、Python のような外のプログラムでも、同じオブジェクトを同じ名前で呼べます。
下の Python の例は、先ほどの VBA と同じ一覧を、外のプログラムから出すものです。書き方は少し違っても、文書、パート、ボデーとたどる名前は同じです。VBA で覚えた名前が、他の言語でも使えるのは、現場で長く使うときの安心材料になります。
ただし、外から動かす場合は、CATIA が起動していること、使える環境かどうかを先に確かめます。会社の環境で、どの言語が許されているかも、情報システムの方と先に話しておきます。
どの言語で書くかは、後から選び直せます。最初は、いま使っている環境でいちばん動かしやすいものを選び、名前の使い方を覚えることを優先するのが、近道だと考えています。
# 外から CATIA を動かす例(Python)。VBA と同じオブジェクトを、同じ名前で呼ぶ。
# 前提: Windows、CATIA が起動していて、パートが1つ開いている。pywin32 が入っていること。
import win32com.client
catia = win32com.client.Dispatch("CATIA.Application")
doc = catia.ActiveDocument
print("開いている文書:", doc.Name)
part = doc.Part
for i in range(1, part.Bodies.Count + 1):
print("ボデー", i, ":", part.Bodies.Item(i).Name)
# VBA の oPart.Bodies.Item(i).Name と同じ形。言語が変わっても、呼ぶ名前は変わらない。調べたあとは、小さい操作を1つ動かしてみる
資料を読んでも、動かさなければ身につきません。調べたあとは、必ず小さい操作を1つ、自分の手で動かします。最初の例は、読むだけのもので構いません。名前をたどって、期待した文字が出れば、API が使えている証拠です。
次の段階では、変える操作を一つだけ足します。たとえば、ボデーの名前を変える、パラメータの値を一つ変える、といった小さな操作です。壊れたときに戻しやすいよう、検証用のコピーのパートで試します。
動いたら、調べて分かったことを、短いメモに残しておきます。どの操作が、どの名前で呼べたか。届かなかった操作は何か。このメモが、次に別の作業をマクロにするときの、最初の資料になります。
マクロの進め方を小さく試す考え方はPoCで小さく始める——1ツール2週間の進め方にまとめました。
御社の CATIA の作業で、手で繰り返しているものはありますか。その手順を紙に書き出して、一つずつ API で届くかを見てみてください。クロニクスでは、現場の作業を見せていただき、CATIA でどこまで自働化できるかをヒアリングし、自働化設計書として無料でご提案しています。ご相談は contact@qronix.jp までどうぞ。