「Vlax-add-cmd」の版間の差分

2024年2月12日 (月) 07:04時点における版

AutoLISP Home - AutoLISP 目次 - DCL - AutoLisp関数互換表 - CAD&CGブログ - オンラインショップ- GizmoTools ヘルプセンター

構文: (vlax-add-cmd global-name func-sym [local-name cmd-flags])

機能

コマンドを AutoCAD の組み込みコマンドセットに追加する。

vlax-add-cmd 関数を使用すると、名前の先頭が c: 以外の関数を、AutoCAD コマンドとして定義することができる。 c: 関数では不可能な割り込み AutoLISP コマンドを定義することもできる。

警告割り込み定義された vlax-add-cmd 関数で、command 関数呼び出しを使用することはできない。使用すると CAD が異常終了する可能性がある。

vlax-add-cmd 関数は、現在の CAD セッションの間、CAD のコマンドプロンプトから AutoLISP 関数を、ObjectARX スタイルのコマンドとして使用できるようにする。この関数は、ObjectARX acedRegCmds マクロへのアクセスを提供する。これは、ObjectARX システム AcEdCommandStack オブジェクトへのポインタを提供する。

vlax-add-cmd 関数は、コマンドをコマンドグループに自動的に割り当てる。ドキュメント名前空間から実行した場合、vlax-add-cmd 関数はコマンドを doc-ID という名前のグループに追加される。doc-ID は、ドキュメントを識別する 16 進数の値。

独自の名前空間 VLX から実行した場合、vlax-add-cmd 関数はコマンドを VLC-Ddoc-ID:VLX-name という名前のグループに追加される。ここで VLX-name は、vlax-add-cmd 関数を呼び出したアプリケーションの名前。

vlax-add-cmd 関数を独自の名前空間 VLX から使用することが推奨される。 VLX をスタートアップ LISP ファイルからロードするのではなく、 APPLOAD[アプリケーションロード]コマンドを使用して明示的にロードする。

注リアクタオブジェクトを作成する関数や、リアクタコールバックとして機能する関数を、vlax-add-cmd 関数を使用して定義することはできない。

引数

global-name : 文字列。
func-sym : 引数のない AutoLISP 関数の名前を示すシンボル。
local-name : 文字列 (既定値は global-name)。
cmd-flags : 整数 (既定値は ACRX_CMD_MODAL + ACRX_CMD_REDRAW)。

主なフラグは、次のとおり。

ACRX_CMD_MODAL (0) 他のコマンドがアクティブなときは、コマンドを呼び出せない。
ACRX_CMD_TRANSPARENT (1) 他のコマンドがアクティブでも、コマンドを呼び出せる。

副次的なフラグは、次のとおり。

ACRX_CMD_USEPICKSET (2) コマンドがピックファーストセットを取得すると、AutoCAD 内部のピックファーストセットをクリアする。コマンドは、ピックファーストセットを取得できる。コマンドは、グリップの取得および設定はできない。
ACRX_CMD_REDRAW (4) コマンドがピックファーストセットやグリップセットを取得しても、AutoCAD 内部のピックファーストセットやグリップセットをクリアすることはない。コマンドは、ピックファーストセットとグリップセットを取得できる。

ACRX_CMD_USEPICKSET と ACRX_CMD_REDRAW の両方を設定した場合、その効果は ACRX_CMD_REDRAW のみを設定したのと同じ。

フラグの詳細は、『ObjectARX リファレンス』の「Command Stack」を参照。

戻り値: 成功した場合は、global-name 引数。 acedRegCmds->addCommand(...) がエラーを返した場合は、nil を返す。

サンプル: 次の例の hello-autocad 関数には接頭の c: がないが、vlax-add-cmd 関数を使用して、AutoCAD コマンドプロンプトから ObjectARX スタイルのコマンドとして使用できるようにしている。; (defun hello-autocad () (princ "hello Visual LISP")); HELLO-AUTOCAD; (vlax-add-cmd "hello-autocad" 'hello-autocad); "hello-autocad"

@@ 28行目: / 28行目: @@
 ::* '''ACRX_CMD_MODAL''' (0) 他のコマンドがアクティブなときは、コマンドを呼び出せない。
 ::* '''ACRX_CMD_TRANSPARENT''' (1) 他のコマンドがアクティブでも、コマンドを呼び出せる。
 ::
 :: 副次的なフラグは、次のとおり。
 ::* '''ACRX_CMD_USEPICKSET''' (2) コマンドがピックファースト セットを取得すると、AutoCAD 内部のピックファースト セットをクリアする。 コマンドは、ピックファースト セットを取得できる。コマンドは、グリップの取得および設定はできない。
 ::* '''ACRX_CMD_REDRAW''' (4) コマンドがピックファースト セットやグリップ セットを取得しても、AutoCAD 内部のピックファースト セットやグリップ セットをクリアすることはない。 コマンドは、ピックファースト セットとグリップ セットを取得できる。
-::* ACRX_CMD_USEPICKSET と ACRX_CMD_REDRAW の両方を設定した場合、その効果は ACRX_CMD_REDRAW のみを設定したのと同じ。 フラグの詳細は、『ObjectARX リファレンス』の「Command Stack」を参照。
+ACRX_CMD_USEPICKSET と ACRX_CMD_REDRAW の両方を設定した場合、その効果は ACRX_CMD_REDRAW のみを設定したのと同じ。
+フラグの詳細は、『ObjectARX リファレンス』の「Command Stack」を参照。
@@ 49行目: / 52行目: @@
 -----
 関連事項
+* [[vlax-add-cmd]] 関数
 * [[vlax-remove-cmd]] 関数
 [[Category:AutoLISP]]