概念:スクリプトプラグイン

スクリプトパレットとスクリプトを作成および編集するで説明しているように、ドキュメントスクリプトがあれば、リソースマネージャを使用して特定のファイルからスクリプトを作成、保存、および実行できます。スクリプトプラグインオブジェクトでは、任意のVectorworksファイルでスクリプトを使用できます。メニューコマンド(.vsm)、ツール(.vst)、オブジェクト(.vso)の3種類のプラグインを使用すると、スクリプトをメニューコマンド、ツールパレット、リソースライブラリのオブジェクトとして作業画面に組み込むことができます。

スクリプトプラグインオブジェクトはカスタム項目になり、設計/作図処理を効率化および強化できます。これらのプラグインオブジェクトは、スナップ、クラス割り当て、高度な図形編集など、標準のVectorworksプログラムのコアテクノロジをサポートしており、基本的にはVectorworksの組み込みオブジェクトタイプと同じ機能を提供します。

スクリプトプラグインはスクリプトの移植性とプラットフォーム独立性も強化されているため、MacまたはWindowsにインストールしたVectorworksのどちらにもスクリプトを簡単に移行できます。さまざまな国のユーザー間で、プラグインオブジェクトを含む図面を交換できます。プラグインは、表示される名前と文字列を翻訳することで、他の国でローカライズして使用できます。

プラグインの仕組み

スクリプトプラグインはファイルとして保存され、スクリプトコードとプラグイン「ラッパー」(プラグインの特性と動作を定義する、エンコードされたヘッダ)を結合します。プラグインのカテゴリなどの情報、プラグインを有効にする方法を定義するプロパティ、Vectorworksアプリケーションフレームワーク内でプラグインを機能させるために必要なその他のあらゆる情報は、ヘッダ内に含まれています。

プラグインの種類

スクリプトプラグインの主な特徴は、Vectorworks製品インターフェイスにスムーズに統合できることです。これらのメニューコマンド、ツール、オブジェクトは、組み込みのVectorworksツール、オブジェクト、メニュー項目とまったく同じように機能します。スクリプトメニューコマンドは組み込みのメニューコマンドと同様、有効にする上で2D/3Dビューや項目セットの選択など特定のファイル条件を要求するよう設定できます。メニューコマンドまたはツールアイテムを選択すると、スクリプトおよびプラグインが必要とする情報がメモリに読み込まれ、プラグインスクリプトが実行されます。Vectorworksプログラムはプラグインが提供する情報を使用して、(スナップなど)ユーザーの操作を実行すると共に、メニューコマンドまたはツールのファイル環境を調え、定義された動作を実行します。スクリプトツールは、組み込みツールと同様、スマートカーソルなどツール指向のVectorworksプログラム機能を活用します。

プラグインオブジェクトは、ツールとシンボルの特性を併せ持っています。プラグインオブジェクトはツールパレットに追加でき、ツール項目に似ていますが、使用時には、シンボルツールがファイルにシンボルを配置するのと同じように、オブジェクトをファイルに配置します。オブジェクトスクリプトは、ファイル内で発生するイベントを通じて呼び出すこともできます。配置されているオブジェクトは、オブジェクト情報パレットを使用してオブジェクトの定義に使用されているパラメータ値を編集して修正でき、これらの変更により、オブジェクトを定義するスクリプトがオブジェクトの再描画を実行します。全体的なファイルの変更があると、ファイルは強制的に再生成され、ファイルに配置されているオブジェクトのスクリプトも実行されます。こうした特徴により、ファイル内でプラグインオブジェクトを表示する方法に高い柔軟性がもたらされています。

プラグインオブジェクトをリソースマネージャと組み合わせて使用し、設定済みのオブジェクトを作成して、配置した後に必要な編集を最小限にすることもできます。単一のプラグインオブジェクトに基づくさまざまなオブジェクト設定のライブラリの作成やリソースマネージャからの取得も簡単に行えます。

プラグインオブジェクトには、1点型、2点型、3点型、パス(2D、3D)の4種類があります。図面内での配置および編集方法はそれぞれ異なります。

1点型オブジェクト:1点型オブジェクトは、用紙上の1点をクリックすると描画されるプラグインオブジェクトです。1点型オブジェクトを配置するには、最初のクリックで図面内での配置場所を指定し、次のクリックで回転角度を設定します。1点型プラグインオブジェクトは、カーソルを使用して編集(サイズ変更や回転)することはできません。オブジェクト情報パレットを使用して編集します。

2点型オブジェクト:2点型オブジェクトの配置は、2回のクリックで線と向きを定義します。線のいずれかの端点でクリックし、図形のサイズ変更や回転が行えます。オブジェクト情報パレットを使用して編集することも可能です。

3点型オブジェクト:3点型オブジェクトを配置するには、中心線による四角形作成(一度クリックして場所を指定し、再度クリックして長さを設定し、再度クリックして幅を設定します)モードまたは端線による四角形作成(一度クリックして角を設定し、再度クリックして長さを設定し、再度クリックして幅を設定します)モードを使用します。図形は選択ハンドルをドラッグしてサイズ変更でき、オブジェクト情報パレットで編集できます。

パス(2D、3D)オブジェクト:パスオブジェクトを作成するには、一連のクリックでパスに沿って頂点を定義します。使用するパスの種類に基づき、2つの異なる種類のパスオブジェクトがあります。2Dパスオブジェクトは曲線パスを使い、3Dパスオブジェクトはパスに3D NURBS曲線を使います。パスオブジェクトは変形ツールを使用して直接編集できます。加工> グループに入るや、オブジェクト情報パレットを使用して編集することも可能です。

プラグインファイルの場所

Vectorworksプログラムを起動すると、スクリプト型プラグインファイルを検索し、プラグインを有効にして管理するために必要な情報を登録します。関連するプラグインファイルが配置されているのと同じフォルダで、参照ファイルが検索されます。

Vectorworks製品は、以下の順番と場所でプラグインを検索します。

ユーザーの 「Plug-Ins」フォルダ、またはユーザーの 「Plug-Ins」フォルダのエイリアスあるいはショートカット

Vectorworksの「Plug-Ins」フォルダ内およびそのサブフォルダ内

Vectorworks「Plug-Ins」フォルダ内にあり、Vectorworks階層外部の場所を参照しているエイリアスあるいはショートカット

ユーザーの「Plug-Ins」フォルダはプラットフォーム固有の場所にあります。

Windows:C:>「ユーザー」>「<ユーザー名>」>「AppData」>「Roaming」>「Nemetschek」>「Vectorworks」>「2024」>「Plug-Ins」

Mac:「ユーザー」>「<ユーザー名>」>「ライブラリ」>「Application Support」>「Vectorworks」>「2024」>「Plug-Ins」

プラグインファイルを新規作成すると、常にユーザーの「Plug-Ins」フォルダに配置されます。

Vectorworksプログラムを起動するか作業画面をアクティブにすると、プラグインが「Plug-Ins」フォルダおよびそのサブフォルダ、ユーザーの「Plug-Ins」フォルダおよびそのサブフォルダ、またはエイリアス(Mac)あるいはショートカット(Windows)で参照されているフォルダに配置されている場合のみ、現在のセッションで使用できるようになります。

複数の場所にプラグインファイルが重複して存在する場合は、フォルダ階層で最初に検知されたファイルが使用されます。

ソフトウエアを以前のバージョンからアップグレードする上で、プラグインファイルの場所を柔軟に設定できることは有益です。サードパーティのプラグインはアプリケーションとは別のフォルダに格納できるため、アップグレードをインストールする際も簡単に参照できます。アップグレードする場合は、「Plug-Ins」フォルダを現在のバージョンのフォルダにコピーするか、エイリアスまたはショートカットで参照するだけで済みます。

スクリプト型プラグインを作成する

概念:Vectorworksシンボル