Altium Designerにおけるスクリプティングシステムの概要と設定

Created: 1月 31, 2023 | Updated: 1月 31, 2023

Altium Designer のスクリプトシステムは、ソフトウェア内の作業を自動化するスクリプトを作成するために必要なツールと機能をすべて備えています。

スクリプトエディタ、デバッガ、各種スクリプト用パネルが連携して、スクリプトの作成とデバッグを容易にします。スクリプトはスクリプトエディタから直接実行できるほか、メニュー、ツールバー、またはホットキーに割り当てることで、PCB Layout などの現在のドキュメントに対していつでも適用できます。

Altium Designer で Script Code と Form の各ウィンドウを表示し、Object Inspector、Code Explorer、Tool Palette の各パネルを表示している例。

スクリプトシステムの機能

スクリプトシステムは、主に 2 つの要素（エディタとデバッガ）で構成されます。主な機能は次のとおりです。

Project access – スクリプトはスクリプトプロジェクトまたはデザインプロジェクトに保存できます。プロジェクト内の任意のスクリプトに含まれるルーチンは、同一プロジェクト内の他のスクリプトから参照できます。
Scripting Editor – スクリプトエディタには専用のテキストエディタが用意されており、編集環境の設定や構文カラーリングなど、さまざまなオプションを利用できます。
Scripting Panels – スクリプトシステムには、スクリプトのコーディングとデバッグを迅速に行うための複数のパネルが用意されています。
Scripting Debugger – スクリプト実行時にエラーが発生すると、簡潔なエラーメッセージを示すダイアログが表示されます。Watches ウィンドウで変数をプレビューしたり、Script Debugger でコードをトレースしてスクリプトの実行を制御したりできます。
Scripting Languages – スクリプトは DelphiScript で作成でき、レガシー言語として有効化されている場合は VBScript でも作成できます。

既定のスクリプト言語は DelphiScript に設定されています。VBScript および JavaScript（Jscript）で書かれた既存のスクリプトは開いて実行できます。VBScript で新規スクリプトを作成できるようにするには、Advanced Settings dialog で Legacy.Scripts.SupportOldLanguages オプションを有効にする必要があります。
スクリプト API のドキュメントはここにあります: Scripting API Objects。なお、このドキュメントは古いバージョンの Altium Designer 向けに最後に更新されたものです。多くの原則やアプローチは同様のままですが、インターフェース、オブジェクト、メソッド、プロパティなどは当時から変更されており、以降のバージョンに存在するすべてを反映しているわけではない点に注意してください。

スクリプトユニットとフォーム

スクリプトプロジェクトは、Script Units と Script Forms の 2 種類のスクリプトドキュメントをサポートします。Script Units では、独立したプロシージャおよび関数を記述できます。Script Forms では、コントロールとイベントハンドラを備えたダイアログに加え、プロシージャおよび関数を作成できます。

Script Unit は X2 Application Programming Interface（API）を使用して、設計ドキュメント上の設計オブジェクトを変更または操作できます。Script Form はユーザーインターフェースとしてコントロールをホストし、X2 API を活用して、アクティブな設計ドキュメントに作用するスクリプトダイアログを提供します。
Script Form は、スクリプトによってサポートされるビジュアルなフォームユニットです。フォームがアクティブなとき、それはダイアログウィンドウを表します。
Script Form には 2 つのビュー（Script Code ビューと Script Form ビュー）があります。Script Code ビューにはイベントハンドラとプロシージャ／関数が含まれます。Script Form ビューは（複数タイプの）ダイアログフォームを表し、コントロールと、それに関連付けられたイベントハンドラを備えます。
Script Form には関連ファイルが 2 つあります。イベントハンドラとプロシージャ／関数を含む *.pas ファイルと、スクリプトフォーム自体の詳細（コンポーネントおよびその配置）を含む *.dfm ファイルです。
コンポーネントとは、ユーザーからの入力（マウスクリックや文字入力のシーケンスなど）を受け付ける、ビジュアルまたは非ビジュアルのコントロールオブジェクト（Tool Palette panel から配置）です。設計時には、Object Inspector panel を使用して Script Form 上のコンポーネントを操作できます。コンポーネントは、スクリプトシステムがサポートする任意の言語セットの任意の Script Form で使用できます。
コンポーネント（コントロールオブジェクト）には、Script Form から利用できるメソッド、プロパティ、イベントがあります。
- メソッドは、オブジェクトが実行できるアクションです。
- プロパティは、オブジェクトに含まれるデータを表し、アクセスまたは変更できます。
- イベントは、Script Form 上のコンポーネントが反応できる条件です。
Script Form には、フォームのボタンがクリックされたときなど、捕捉した条件を処理するイベントハンドラがあります。

スクリプトに関するドキュメントは主に DelphiScript 言語セットに焦点を当てています。DelphiScript 言語セットは Embarcadero DelphiScript 技術に基づいています。DelphiScript と（Delphi で使用される）Object Pascal の違いについては、DelphiScript 参照ドキュメントを参照してください。

Altium Designer のスクリプト例

例示および参照用スクリプトは、オブジェクトのインターフェース、メソッド、プロセス、プロパティ、コンポーネントがスクリプト内でどのように適用されるかを理解するうえで有用なリソースです。また、独自のスクリプトプロジェクトのベースとしても利用できます。

Altium Designer 10 のリリース時に作成されたレガシー参照デザインは、here からダウンロードできます。これらには複数のシミュレーション例およびスクリプト例が含まれます。なお、これらはレガシーであり、更新されない点に留意してください。

他のスクリプト例については、Script Examples Reference を参照してください。Altium Designer で動作するスクリプト例を実践的に把握するには、Writing Scripts および Script Example Analysis を参照してください。

例の実行

Altium Designer でスクリプト例をすばやく実行するには、まず例のプロジェクト、または例スクリプトフォルダのいずれかから個別のスクリプトファイルを開きます。たとえば、Scripts\Delphiscript Scripts\General フォルダにあるシンプルな「Hello World」プロジェクト（HelloWorld.PRJSCR）などです。

スクリプト例は、zip を展開したダウンロードフォルダ内にあります。

DelphiScript の Hello World プロジェクトが Projects panel に開かれている状態。

このプロジェクトには「Hello World」スクリプトが 2 つのバージョンで含まれており、2 つ目（HelloWorlDialog.pas）は Form ユニットの基本的な使用方法を示しています。スクリプト名をダブルクリックすると、エディタでスクリプトを開いて確認できます。なお、スクリプトはエディタで開いていなくても実行できます。

いずれかのスクリプトを実行するには、メインメニューから File » Run Script を選択し、Select Item To Run ダイアログで利用可能なスクリプトプロシージャを選びます。いずれかのバージョンを実行すると、メッセージを表示するダイアログが開きます。

例スクリプトを実行するための、手早く簡単な方法。