CATIA VBAでマクロを作る手順——.catvbaの作り方と開き方、エディターで止めながら直すまで
「CATIA VBA」で調べていると、二つの違う話が同じ言葉で出てきます。一つは Excel のマクロから CATIA を動かす形、もう一つは CATIA の中に .catvba を作り、その中にモジュールやフォームを置く形です。書く言葉はどちらも VBA ですが、ファイルの置き場所も、人に渡すときの手順も別物なので、探していたのと違うほうを読んで戻ってくることになりがちです。この記事は後者、CATIA の中の .catvba のほうを扱います。作って開き、フォーム付きの1本が動くまでを、画面の順番どおりに書きます。Excel の表に並べた寸法を流し込みたい、という用件でしたらExcelとCATIAをつなぐ——パラメータ一括変更の実装パターンのほうが近いはずです。CATScript から移ってくる理由も、第1節で先に整理します。
Photo: UnsplashVBA を選ぶのは、画面か、止めて直す仕組みが欲しくなったとき
CATIA V5 のマクロは、CATScript・MS VBScript・MS VBA から選べます。CATIA を動かす命令はどれも同じで、違うのは作れるものと、その準備です。CATScript でマクロを作る手順で1本目を動かしたあと、VBA に移る理由はたいてい次の三つのどれかです。
一つ目は、ボタンや入力欄のある画面(ユーザーフォーム)を作りたいとき。二つ目は、ブレークポイントを置いて1行ずつ進め、変数の中身を見ながら直したいとき。三つ目は、よく使う処理を共通のモジュールにまとめて、何本ものマクロから呼びたいときです。
逆に言えば、この三つが要らないうちは CATScript のままで困りません。言語を変えるのは、道具として育てる段階に入ってからで間に合います。
始める前に——VBA が使える環境かを確かめる
CATIA の VBA は、CATIA 本体とは別に入っている部品です。環境によっては入っていないことがあり、その状態で進めると、VBA の項目が選べなかったりエディターが開かなかったりします。
確かめ方は簡単で、CATIA で「ツール」→「マクロ」→「Visual Basic エディター」(英語表示では Tools → Macro → Visual Basic Editor、キーボードなら Alt+F11)を開いてみます。エディターの画面が出てくれば使えます。出てこない場合は、CATIA の導入を担当している方に、VBA が入っているかを確認してください。
ここで止まる職場は意外と多く、最初の1本を VBA で始めて環境の問題に時間を取られる原因になります。CATScript で動くところまで確かめてから VBA に移る順番をすすめているのは、このためです。
.catvba を作る——マクロ・ライブラリーで「VBA プロジェクト」を選ぶ
CATScript はフォルダに置いたファイル1つがマクロ1本でしたが、VBA は違います。.catvba という1つのファイルの中に、モジュールやフォームがまとめて入ります。Excel のブックの中にマクロが入っているのと近い形です。
作り方は、「ツール」→「マクロ」→「マクロ...」(Alt+F8)で画面を出し、「マクロ・ライブラリー...」を押します。ライブラリーの種類で「VBA プロジェクト」(VBA projects)を選び、「新規ライブラリーを作成...」(Create new library)で保存先とファイル名を指定します。場所は日本語や空白を含まない短いフォルダにしておくと扱いやすいです。
マクロの画面に戻ると、作った .catvba がライブラリーとして選べるようになっています。この登録は一度やれば残り、次からは Alt+F8 で同じ一覧に出てきます。画面の表記は版や言語設定で少し違いますが、並び順はほぼこのとおりです。
エディターで書いて、止めながら確かめる
Alt+F11 で Visual Basic エディターを開くと、左側のプロジェクトの一覧に作った .catvba が出ています。それを選んだ状態で「挿入」→「標準モジュール」を選び、右側のコード画面に書いていきます。書き終えたら保存を忘れずに。保存先は .catvba ファイルそのものです。
Excel と違うのは、操作の起点が CATIA というオブジェクトになることです。ActiveWorkbook の代わりに CATIA.ActiveDocument、Worksheets の代わりに Part や Bodies をたどります。Alt+F8 の一覧に出るのは引数のない Sub なので、入口の名前を CATMain にそろえておくと迷いません。
VBA に移った価値がいちばん出るのは、ここからです。気になる行で F9 を押してブレークポイントを置き、Alt+F8 から実行すると、その行で止まります。F8 で1行ずつ進め、変数にカーソルを当てれば中身が見えます。Debug.Print で書いた内容は、「表示」→「イミディエイト ウィンドウ」に出ます。
次のマクロは、ボディの名前をイミディエイト ウィンドウに1つずつ出すものです。ループの中で止めて、F8 で進めてみてください。
言語を変えるのは、
道具として育てる段階に入ってからで間に合う。
' 参考実装例:標準モジュールに置く最初の1本
' 一覧に出るのは引数のない Public な Sub。名前は CATMain にそろえておくと迷わない
Sub CATMain()
If CATIA.Documents.Count = 0 Then
MsgBox "ドキュメントが開かれていません。"
Exit Sub
End If
If TypeName(CATIA.ActiveDocument) <> "PartDocument" Then
MsgBox "CATPart を開いて、そのウィンドウを前に出してから実行してください。"
Exit Sub
End If
Dim oPart As Object
Set oPart = CATIA.ActiveDocument.Part
Dim i As Integer
For i = 1 To oPart.Bodies.Count
' この行に F9 でブレークポイントを置き、F8 で1行ずつ進めてみる
Debug.Print i & " : " & oPart.Bodies.Item(i).Name
Next
MsgBox "ボディは " & oPart.Bodies.Count & " 個です。一覧はイミディエイト ウィンドウに出しました。"
End Sub
書き方に迷ったら、マクロの記録で命令の名前を拾う
どの命令を書けばよいか分からないときは、CATIA に操作を記録させると早く見つかります。「ツール」→「マクロ」→「記録開始...」(英語表示では Start Recording...)を選ぶと、記録先のライブラリーと言語を選ぶ画面が出ます。前の節で作った .catvba と MS VBA を選んで記録を始め、パッドを1つ作るなど、知りたい操作を画面で一度なぞってから「記録終了」を押します。
Alt+F11 でエディターを開くと、.catvba の中にモジュールが1つ増え、いまの操作が CATIA の命令の並びとして残っています。ただ、画面で選んだ面やエッジは、そのときのファイルの中の名前のまま書き込まれます。別のファイルで流すと同じ名前が見つからず、そこで止まります。記録は、そのまま配る物ではなく、命令の名前と引数の順番を拾う下書きです。
拾った命令を前の節の CATMain の形に移し、選ぶ部分を人に画面で選ばせる書き方に替えると、どのファイルでも動く1本になります。選ばせ方はCATIAマクロの主役はSelectionオブジェクト——現場で使う選択テクニック集にまとめています。操作によっては記録に何も残らないものもあるので、そのときは F8 で止めながら、オブジェクトを1段ずつたどって探します。
ボタンのある画面を1枚つくる
エディターの「挿入」→「ユーザーフォーム」で、空の画面が1枚できます。ツールボックスからコマンドボタンとテキストボックスを1つずつ置き、ボタンをダブルクリックすると、押したときに動くコードを書く場所が開きます。
フォームは単独では一覧に出ないので、標準モジュール側に「フォームを表示するだけの CATMain」を用意し、それを Alt+F8 から呼びます。次の例は、ボタンを押すと、いま開いているドキュメントの名前をテキストボックスに出すだけのものです。
ここまで動けば、入力欄に寸法を入れて形状を作る、選んだ部品の属性を一覧に出す、といった道具の骨組みはそろっています。あとは中身の処理を差し替えていくだけです。次に書く処理に迷ったら、現場で本当に使うCATIAマクロ スニペット10選から近いものを選んで、ボタンの中に移してみてください。
' 参考実装例:ボタンを押すと、開いているドキュメント名を画面に出すフォーム
' UserForm1 に CommandButton1 と TextBox1 を1つずつ置いておく
' ---- 標準モジュール ----
Sub CATMain()
UserForm1.Show
End Sub
' ---- UserForm1 のコード ----
Private Sub CommandButton1_Click()
If CATIA.Documents.Count = 0 Then
MsgBox "ドキュメントが開かれていません。"
Exit Sub
End If
TextBox1.Text = CATIA.ActiveDocument.Name
End Sub
よくある質問——CATIA VBA を書き始めた人が次に聞くこと
Q. 使える命令の一覧(リファレンス)は、どこにありますか。 CATIA を入れたフォルダの中に、V5Automation.chm というヘルプファイルがあります(置き場所は版や入れ方で変わるので、CATIA のフォルダの中をこの名前で探すのが早いです)。オブジェクトの名前で引くと、持っている命令と引数が並びます。ただ、載っていない命令や、説明が古いものもあります。見つからないときは、前の節のマクロの記録で名前を拾い、F8 で止めて中身を確かめる、の順で埋めていきます。
Q. CATScript で書いたマクロは、VBA にそのまま持ってこられますか。 CATIA を動かす命令は同じなので、多くは標準モジュールに貼れば動きます。違いが出るのは、変数の型の書き方や、ファイル・画面まわりの扱いです。どこが違うかはCATIA VBAとCATScript・VB.NET——自動化の言語はどれを選ぶべきかで並べています。
Q. 前の環境で動いていた .catvba が、新しい PC で開いたとたん赤い行を出して止まります。 64bit の CATIA に移ったときによく起きます。Windows の機能を呼ぶ Declare の行に PtrSafe が無いと、開いた時点で止まります。直し方はVBAの64bit問題と文字コード——古いマクロが動かない時の定番対処にまとめています。
Q. 作ったマクロを、毎回 Alt+F8 から選ばずにボタン1つで呼べますか。 呼べます。「ツール」→「カスタマイズ」の「コマンド」で一覧からマクロを選び、ツールバーへドラッグすると、アイコンを押すだけで CATMain が走ります。何人かで同じボタンを使うなら、置き場所と更新の仕方を先に決めておくと、古い版を押してしまう事故を防げます(作ったマクロを配る仕組み)。
すでにある .catvba を開くとき、配るときの注意
人から受け取った .catvba を使うときは、マクロ・ライブラリーの画面で種類を「VBA プロジェクト」にし、「既存のライブラリーを追加...」(Add existing library)でそのファイルを指定します。一覧に中のマクロが並ぶので、実行する前に Alt+F11 でコードを開き、何をするものかを読んでください。VBA はファイルの保存や削除もできます。
もう一つ知っておきたいのは、.catvba はテキストではないことです。CATScript のようにメモ帳で開いて差分を見ることができません。変更を記録しておきたいときは、エディターでモジュールを右クリックし「ファイルのエクスポート」で .bas や .frm として書き出しておくと、どこを直したかを後から追えます。
同じ .catvba を何人かで共有フォルダから開くと、誰かが開いている間は保存できない、といった取り合いも起きます。配るときは、原本は1か所に置き、使う人には読み取り専用で渡す形にしておくと事故が減ります。
社内のマクロが .catvba や .CATScript に散らばっていて、どれが最新か分からなくなっている——そんな状態からの整理もお手伝いしています。いまの作業とマクロを見せていただければ、ヒアリングのうえで自働化設計書を無料でお出しします。遠慮なく声をかけてください。