プラグイン定義

スクリプトで作成されたコマンド、ツール、またはオブジェクトプラグインの外観を定義するパラメータは、ファイル内の各オブジェクトレコードに関連付けられたパラメータレコードに保存されます。これらのレコードは使用時の永続的なデータを格納し、デフォルトのパラメータ値を提供します。たとえばダイアログボックスを表示するメニューコマンドは、場合によってユーザが入力した値を後で使用するために格納する必要があります。ツールのポップアップリストで複数のモードオプションを提供することもあります。ツールに別のモードを選択したい場合は、新しい設定を保存し、その後ツールアイテムを使用する時に再利用できます。これらの値はメニューコマンドやツールのパラメータレコードに保存し、後でコマンドやツールを再度選択した時に取得できます。ファイルを切り替えると、新しいファイルに関連付けられた格納値が表示されます。パラメータレコードが存在しない場合は、プラグインアイテムで作成されたパラメータレコードのデフォルト値が表示されます。

各オブジェクトレコードのパラメータは、オブジェクト情報パレットを使用してオブジェクトパラメータレコード内の値にアクセスするよう修正できます。ファイルにオブジェクト（またはツール）の最初のレコードを作成する時に、デフォルトのパラメータレコードを作成することもできます。このデフォルトのパラメータレコードは、オブジェクトレコードに関連付けられたパラメータレコードとは異なり、オブジェクトのデフォルト設定をファイルに格納します。デフォルトのパラメータレコードは、それ以降オブジェクトレコードを配置する際、新しいオブジェクトレコードごとにデフォルトを定義するために使用されます。

1. プラグインマネージャのカスタムプラグインタブで、定義または編集するプラグインを選択します。

パラメータ	説明
一般
タイプ	作成されるプラグインのタイプ（メニュー、ツール、または参照ファイル）が表示されます。
スクリプト言語	プラグインのスクリプト部分に使用されている言語により、PythonまたはVectorScriptが表示されます（プラグインスクリプトを指定するを参照）。
名前	新しいプラグインの名前を指定します。これはプラグインファイルの名前でもあり、適切な拡張子（.px、.vsm、.vst、または.vso）が自動的に付加されます。プラグインの名前を変更する場合は、変更後に作業画面を更新して最新のプラグイン名を反映させます。
カテゴリ	プラグインに見出しカテゴリを割り当てて、作業画面でそのプラグインを簡単に見つけられるようにします。
パラメータ	プラグインのデフォルトのパラメータを指定します。デフォルトのパラメータはプラグインの挿入時に適用されます。パラメータは、プラグインを指定した順番で一覧表示されます。パラメータの順番を変更するには#列内をドラッグします。
パラメータリスト	デフォルトのオブジェクトパラメータ、該当する場合は（ローカライズした）フィールド名、型、初期値を一覧表示します。2点型オブジェクトでは、オブジェクトの軸の長さを含むLineLengthパラメータが表示されます。四角形では、LineLength（オブジェクトの最初の長さ）およびBoxWidth（オブジェクトの最初の幅）パラメータの両方が表示されます。これらのパラメータには新しいデフォルト値を指定できますが、これらのパラメータを削除することはできません。
新規	プラグインの新しいパラメータを作成します。フィールドの設定ダイアログボックスが開きます。パラメータ名、該当する場合は（ローカライズした）フィールド名、型、初期値を指定します。定義済みのパラメータオプションのポップアップリストを作成するには、型でPop-upを選択してメニュー／ボタンの設定ダイアログボックスを開きます。オプションをリストに入力します。リストの各行がポップアップの選択肢になります。空の行は残さないでください。ポップアップの選択肢を後から編集するには、設定をクリックします。
編集	選択したプラグインパラメータを編集します。特定のサードパーティおよび内蔵プラグインでは、パラメータを編集できます。
削除	選択したプラグインパラメータを削除します。
ストリング	プラグインで使用する文字列を指定します。
ストリングリスト	プラグインで使用するストリング（プラグインで使用する特定の色を指定するカラーセレクタの値など）を一覧表示します。
追加	プラグイン定義に文字列を追加します。ストリングの追加ダイアログボックスが開きます。次に使用可能なリソースID番号が自動的に割り当てられます。カテゴリ名を指定します。
編集	現在選択しているストリングを編集します。ストリングの編集ダイアログボックスが開きます。個別のストリング値を選択して編集をクリックすると、ストリングの編集ダイアログボックスが開きます。ストリング値を指定します。値はカテゴリによって異なります。詳細はdeveloper.vectorworks.net（開発元サイト）を参照してください。
削除	現在選択しているストリングを削除します。
プロパティ	プロパティ設定を使用すると、標準のVectorworksメニューコマンド、ツール、およびオブジェクトと同様にプラグインが動作するよう設定できます。これらの設定は、（選択状態やビューの方向など）ファイルの状態に対するプラグインの動作を制御し、表示するヘルプテキストを定義します。使用できるプロパティはプラグインタイプによって異なります。カスタムプラグインのプロパティのみ指定できます。
コマンド
条件の設定	描画状態ごとに、条件を必要とする（コマンドを有効にするには描画状態の条件を必要とする）か、禁止する（描画状態の条件が存在する場合はコマンドを無効にする）か、無視する（描画状態がコマンドの有効化に影響を及ぼさないようにする）かを指定します。
ツールチップヘルプの内容	メニューコマンドのヘルプテキストを指定します。メニューコマンドについて説明するヘルプテキストは、カーソルをコマンドの上に置いて停止した時に表示されます（現時点ではMacでのみ使用できます）。
コンテキストヘルプのオーバーライド	URL（http:で始まる文字列）を入力して、ヘルプ情報の入ったWebページを指定します。Vectorworksプログラムフォルダを基準にしてファイルを指定するには、. /（ピリオドとスラッシュ）で始まるパスを指定します。
作成バージョン	プラグインを作成した時のVectorworksのバージョン番号を指定します。たとえば、Vectorworks 2019、2020、2021に対しては、それぞれ24、25、26を使用します。
修正バージョン	プラグインを最後に修正した時のVectorworksのバージョン番号を指定します。たとえば、Vectorworks 2019、2020、2021に対しては、それぞれ24、25、26を使用します。
使用中止バージョン	プラグインの使用を中止した時のVectorworksのバージョン番号を指定します。たとえば、Vectorworks 2019、2020、2021に対しては、それぞれ24、25、26を使用します。
ツール
ツールバーに表示する文字	ツールバーに表示する説明テキストを指定します。通常これには図形の名前が含まれるほか、ユーザが実行する操作を示すテキストを含めることができます。
アイコン	必要に応じて、デフォルトのプラグイン用アイコンをカスタムアイコンに置き換えることができます。サードパーティのアイコンエディタを使用して、2つのバージョンのアイコンを作成します。1つは標準解像度の表示用、もう1つは高解像度の表示用です。 ● 標準解像度：幅26ピクセル、高さ20ピクセルの範囲の中央に配置する画像。アイコンは.png形式で保存します。 ● 高解像度：幅52ピクセル、高さ40ピクセルの範囲の中央に配置する画像。アイコンは、標準解像度の画像ファイル名の後ろに「@2x」を付けて、.png形式で保存します。例えば、標準解像度のアイコンの名前が3DModelingToolSet.pngなら、高解像度用アイコンの名前は3DModelingToolSet@2x.pngでなくてはなりません。これ以外の名前を付けると、Vectorworksプログラムでアイコンを配置することができません。 PNGアイコンを取り込むをクリックして、標準解像度アイコンを取り込みます。@2xで指定した高解像度アイコンも配置されている場合は、自動的に一緒に取り込まれます。機器の解像度に合わせて、適切な画像が自動的に表示されます。
ワーキングプレーン	アクティブにする必要があるビューの投影方法を決定します。3D投影が必要な場合はビューが変更されます。2D投影が必要な場合は、スクリーンプレーンがアクティブになりツールを使用できます。ハイブリッド投影はビューの投影に影響しません。
スクリプトの実行	デフォルトでは、ツールは選択された直後に実行するよう設定されています。ただし場合によっては、マウスが移動してからスクリプトを実行したい場合もあります（ユーザによるマウスの移動に基づいてインタラクティブに描画を行うツールなど）。
コンテキストヘルプのオーバーライド	URL（http:で始まる文字列）を入力して、ヘルプ情報の入ったWebページを指定します。Vectorworksプログラムフォルダを基準にしてファイルを指定するには、. /（ピリオドとスラッシュ）で始まるパスを指定します。
作成バージョン	プラグインを作成した時のVectorworksのバージョン番号を指定します。たとえば、Vectorworks 2019、2020、2021に対しては、それぞれ24、25、26を使用します。
修正バージョン	プラグインを最後に修正した時のVectorworksのバージョン番号を指定します。たとえば、Vectorworks 2019、2020、2021に対しては、それぞれ24、25、26を使用します。
使用中止バージョン	プラグインの使用を中止した時のVectorworksのバージョン番号を指定します。たとえば、Vectorworks 2019、2020、2021に対しては、それぞれ24、25、26を使用します。
ツールチップヘルプの内容	カーソルがパレットのオブジェクトアイコンの上で停止した時に表示するヘルプテキストを指定します。
オブジェクト
アイコン	必要に応じて、デフォルトのアイコンをカスタムアイコンに置き換えることができます。サードパーティのアイコンエディタでは、幅26ピクセル、高さ20ピクセルの範囲の中央に8ビットの画像を作成します。.png形式でアイコンを保存し、PNGアイコンを取り込むをクリックして取り込みます。
ワーキングプレーン	アクティブにする必要があるビューの投影方法を決定します。3D投影が必要な場合はビューが変更されます。2D投影が必要な場合は、スクリーンプレーンがアクティブになりツールを使用できます。ハイブリッド投影はビューの投影に影響しません。
スクリプトの実行	デフォルトでは、オブジェクトは選択された直後に実行するよう設定されています。ただし場合によっては、（ユーザのマウス操作に基づいてインタラクティブに描画するオブジェクトなど）マウスの操作を待ってからスクリプトを実行させる方が望ましいこともあります。
デフォルトのクラス	オブジェクト挿入時のデフォルトクラスを指定します。オブジェクトを配置する時にクラスが存在しない場合は、自動的にクラスが作成されます。
コンテキストヘルプのオーバーライド	URL（http:で始まる文字列）を入力して、ヘルプ情報の入ったWebページを指定します。Vectorworksプログラムフォルダを基準にしてファイルを指定するには、. /（ピリオドとスラッシュ）で始まるパスを指定します。
作成バージョン	プラグインを作成した時のVectorworksのバージョン番号を指定します。たとえば、Vectorworks 2019、2020、2021に対しては、それぞれ24、25、26を使用します。
修正バージョン	プラグインを最後に修正した時のVectorworksのバージョン番号を指定します。たとえば、Vectorworks 2019、2020、2021に対しては、それぞれ24、25、26を使用します。
使用中止バージョン	プラグインの使用を中止した時のVectorworksのバージョン番号を指定します。たとえば、Vectorworks 2019、2020、2021に対しては、それぞれ24、25、26を使用します。
ツールチップヘルプの内容	カーソルがパレットのオブジェクトアイコンの上で停止した時に表示するヘルプテキストを指定します。
オプション（カスタムのパラメトリックオブジェクトタイプのみ）
実行オプション	シンボルなどのオブジェクトには、設定済みの配置オプションを割り当ててファイルに配置できます。これらのオプションにより、壁などの高度なVectorworksオブジェクトタイプとオブジェクトを適切にやり取りさせることができます。コマンドとツールのプラグインには挿入オプションの設定がありません。デフォルトでは、オブジェクトの形状はオブジェクトのパラメータまたは制御点が編集された場合にのみ再計算されます。オブジェクトの形状が再計算されると、フォント、テキストサイズ、線の模様の色などの属性に対するファイルのデフォルト設定がオブジェクトに再適用されます。これらの設定のいずれかがオブジェクトの配置または最後の編集以降に変更されている場合、オブジェクトの外観が変化することがあります。このスクリプトは、オブジェクトパラメータが変更されると常に呼び出されます。さらに、（壁に配置された窓など）再計算が重要なオブジェクトでは、オブジェクトが回転された時（回転すると、コマンドを再実行する）または移動された時（移動すると、コマンドを再実行する）に、スクリプトで形状を再計算することもできます。あるいは、プラグインスクリプトをイベントハンドラ（イベントベース）にできます。スクリプトはその後、少数セットのアプリケーションイベントに応答する必要があります。イベントを処理するスクリプトのサンプルやドキュメントは、vectorworks.net（開発元サイト）のサポートページを参照してください。
挿入位置	オブジェクトを壁に挿入する際のオプション設定を選択します。シンボル定義を作成するを参照してください。挿入オプションが不要なオブジェクトの場合、オプションはデフォルト設定のままにしておきます。

3.プラグインパラメータを定義したら、OKをクリックしてプラグインマネージャに戻ります。