VSCode で ARES のアプリケーション開発（２）

ARESの設定

VSCodeをARESのデバッガとして利用するには次の設定を行います。

1. OPTIONSコマンドで、オプションダイアログを開きます。
2. 「システムオプション」の「LISPデバッガー」を選び、「デバッグの有効化」をチェックします。
   
   
   
   
3. オプションダイアログをOKで閉じて設定を保存し、ARESを再起動します。
4. VSCodeやLISP Extensionがインストールされていなかったら、インストールするように指示されます。

デバッグの開始

VSCodeでソースコードを記述し、ソースファイルを C:\Temp\Hello.lsp として保存します。

実行メニューのデバッグの開始を選ぶと、コマンドパレットが表示されて、"Graebert Lisp Debugger: Attach" と "Grabert Lisp Debugger: Launch" が表示されます。アタッチは起動中のARESでコードを実行します。Launch は ARES を起動してコードを実行します。

アタッチを選ぶとリストから起動中のARESを選択できます。

デバッグコンソールにプログラムロード成功という表示がでました。

ARES側でAPPLOAD[アプリケーションのロード]コマンドでソースコードをロードします。

ARES側で定義した LISP コマンド LSPHELLO を実行します。

VSCode側で、LISP コマンドの入り口で止まります。

1行目の家形はコードの実行位置です。

2行目の赤い丸はブレークポイントです。
ツールバーのボタンは左から

実行(F5) は処理の終わりまたはブレークポイントまで実行します。

ステップ実行(F10) は次の行まで実行します。

ステップイン(F11) はユーザー定義関数の中に入ります。

ステップアウト(Shift+F11) は現在の関数の最後まで進み元の関数の次の行で止まります。

再起動 (CTRL+F5)は処理を再開します。

切断(SHFT+F5)は処理を中止します。

F5キーにより、ブレークポイントで止まりました。

さらにF5キーを押すことでLISPコマンド LSPHELLOは終了しました。

ブレークポイントで停止

エディタで vla-AddCircle ポインタの行(38行目)にブレークポイントを設定します。

エディタとARESそれぞれにプログラムをロードさせたのち、ARES側でLISPコマンド ADDCIRC3 を実行します。

中心と半径を画面上で取得したのち、ブレークポイントで処理が止まります。

デバッグコンソールに変数名 app doc spc などを入力すると、それぞれ IAcadApplication 型のCOMオブジェクト、IAcadDocument 型のCOMオブジェクト、IAcadModelSpace 型のCOMオブジェクトが格納されていることがわかります。

また、左側のParameters (引数) のノードを展開すると、これから実行しようとする関数と引数（もしくは式）と、戻り値が表示されます。

ステップ実行[F10]で関数一つずつ処理をするか、実行[F5]キーで最後まで実行した後に、画面をARESに切り替えると、円を描いたことがわかります。

Visual Studio Codeで ARESのアプリケーション開発(1)

 Microsoft の汎用ソフトウェア統合開発環境の Visual Studio Code を使って、Graebert ARES Commander のカスタマイズをいじる。

Visual Studio Code の入手

Microsoft Store から入手します。

それがだめなら公式ページ(https://code.visualstudio.com) から入手します。

ユーザーインストーラー x64 版を起動した場合は、同意してインストール作業を進めます。

インストールが完了したらVisual Studio Code を起動できます。

起動すると英語なので、機能拡張から Japanese Language Pack をインストールします。

再起動後にメニューや画面が日本語になります。

Windows 用 Git もインストールします。

Git for Windowsのインストールで標準エディタを VSCode に変更します。

Git for Windowsのインストール後、VSCode をインストールすると、バージョン管理の画面が変わります。

Graebert LISP Extension の入手

機能拡張の検索ボックスに Graebert と入力してフィルタボタンを押すと Graebert LISP Extension が表示されるので、インストールします。

Graebert LISP Extension の概要

LISPとDCL言語のエディタとしての機能は以下の通りです。

1. 構文強調表示
2. スニペットによる補完
3. 閉カッコの補完と対のカッコの強調表示(Smart bracket)
4. コメント化、コメント解除  
5.  自動補完 
6.  関数定義への移動
7.  多言語化
8.  LISP コード保護 
9. 見出しの追加と変更
10. 矩形範囲の挿入
11. オンラインヘルプ
12. 現在のLISPファイルの読み込み

LISPとDCL言語のデバッガとしての機能は以下の通りです。

1.  起動している ARES にアタッチする
2.  ブレークポイントの設定
3.  ステップ実行
4.  変数と値を表示
5.  デバッグコンソール
6.  ユーザー入力時にARESをアクティブにする

ARES LISP関数のポップアップヘルプなど便利なコードエディタとして使ってみて、ゆくゆくはデバッガ機能にも挑戦するのがよいと思われます。

 LISP コード保護機能によってLISPのソースコードを暗号化し、暗号化したプログラムを配布することも可能です。これによりエンドユーザーによる改竄やノウハウの流出を防ぎます。

復号機能はないので、元のソースコードをなくさないようにしてください。

緯度経度とCAD座標

 ARESマッププラグインでGEOマップを挿入するとGEODATAオブジェクトが用意されます。

GEODATAオブジェクトが利用可能なときは、transformToLonLatAlt() や transformFromLonLatAlt() で緯度経度とXYの変換が可能です。

#include "stdafx.h"
#include "FXHeaders.h"	// ほとんどのCFxのヘッダが入っている
#include "DbGeoData.h"  // GEODATA オブジェクト

//===========================================================
//  JDTESTCmd Class
//===========================================================
int JDTESTCmd::Execute(CFxCommandContext* pCmdCtx)
{
	CFxDocumentPtr doc = pCmdCtx->GetFxDocument();
	CFxUserIO* io = doc->GetFxUserIO();
	CFxDatabasePtr db = doc->GetFxDatabase();
	CFxString prompt;
	OdResult rt;
	// 座標系が用意できているか
	OdDbObjectId geoid;
	if (oddbGetGeoDataObjId(db, geoid) != eOk)
	{
		io->Write(L"\nNo GEODATA.");
		return RTNORM;
	}
	OdDbGeoDataPtr geodata = geoid.safeOpenObject();
	OdGePoint3d p1;
	OdGePoint3d p2;
	int rc = io->GetPoint(L"\n位置を指定 : ", nullptr, nullptr, &p1);
	if (rc == RTNORM)
	{
		rt = geodata->transformToLonLatAlt(p1, p2);
		prompt.format(L"\n(%f,%f,%f) - (%f,%f,%f) ", p1.x, p1.y, p1.z, p2.x, p2.y, p2.z);
		io->Write(prompt);
		OdError e(rt);
		io->Write(e.description());
	}
	rc = io->GetString(false, L"\n経度,緯度を指定 : ", L"", &prompt);
	if (rc == RTNORM)
	{
		rc = io->GetUnitsFormatter()->StringToPoint(p1, prompt);
		if (rc == RTNORM)
		{
			rt = geodata->transformFromLonLatAlt(p1,p2);
			prompt.format(L"\n(%f,%f,%f) - (%f,%f,%f)", p1.x, p1.y, p1.z, p2.x, p2.y, p2.z);
			io->Write(prompt);
			OdError e(rt);
			io->Write(e.description());
		}
	}
	return RTNORM;
}

transformFromLonLatAlt() の戻り値 XYZ の Z がおかしいとき（緯度の値がそのまま入っていることがある）は無視してください。

緯度経度とCAD座標

ARES マッププラグインは、ESRIやTeigaのマップソリューションを利用しています。

C#のカスタムアプリケーションから緯度経度からCAD座標への相互変換を利用する方法を紹介します。

マッププラグインのGEOマップを有効にして

GEODATA オブジェクトを図面に挿入し、座標変換を利用可能にします。

C++ではGEODATAクラスの座標変換APIが利用できますが、ARESのC#にはGEODATAクラスがありませんでした。しかしPOSITIONMARKER図形クラスはあるのでそれを使って座標変換します。

このプログラムは、POSITIONMARKER 図形を図面に追加して、緯度経度を読み取ったり、緯度経度を設定してXY値を読み取っています。

using Teigha.ApplicationServices;
using Teigha.DatabaseServices;
using Teigha.EditorInput;
using Teigha.Geometry;
using Teigha.Runtime;
using CADException = Teigha.Runtime.Exception;

namespace geodata
{
    public class Class1
    {
        [CommandMethod("TESTCS")]
        public void cmdTestCS()
        {
            var doc = Application.DocumentManager.MdiActiveDocument;
            var ed = doc.Editor;
            var db = doc.Database;
            try
            {
                var id = db.GeoDataObject;
                ed.WriteMessage("\nGEODATA [{0}]", id.Handle.ToString());
            }
            catch (CADException)
            {
                ed.WriteMessage("\nNo GEODATA.");
                return;
            }
            var ret = ed.GetPoint("Specify location");
            if(ret.Status != PromptStatus.OK )
            {
                return;
            }
            var model = db.CurrentSpaceId.GetObject(OpenMode.ForWrite) as BlockTableRecord;
            GeoPositionMarker marker = new GeoPositionMarker();
            marker.Position = ret.Value;
            model.AppendEntity(marker);
            Point3d rts = marker.GeoPosition;
            ed.WriteMessage("\n{0} -> {1}", ret.Value, rts);
            var ret2 = ed.GetString("経度,緯度を入力");
            if (ret2.Status == PromptStatus.OK)
            {
                string text = ret2.StringResult;
                int len = text.IndexOf(",");
                double lon = System.Convert.ToDouble(text.Substring(0, len));
                double lat = System.Convert.ToDouble(text.Substring(len + 1));
                Point3d geo = new Point3d(lon,lat,0);
                marker.GeoPosition = geo;
                rts = marker.Position;
                ed.WriteMessage("\n{0} -> {1}", geo, rts);
            }
            marker.Erase();
        }
    }
}

緯度経度からXYZに変換したときに、 Z がおかしいとき（緯度の値がそのまま入っていることがある）は無視してください。

実行結果

: TESTCS
GEODATA [10E]
Specify location: »
(15086629.5460905,4121448.60999969,0) -> (135.525499071023,34.6871623638417,0)
経度,緯度を入力: » 135.5255,34.6871
(135.5255,34.6871,0) -> (15086629.6495038,4121440.16715828,34.6871)

コマンドの横取り

 ARESのログファイルは実行したコマンド名しか記録しません。コマンド履歴ウィンドウの内容を取得する方法があれば便利です。

カスタムコマンドを CFx (C++)で作成してみました。

準備

1. 信頼できるフォルダに TeeCommand_24.7_17.tx を置いてください。
2. アドインとしてアプリケーションを追加します。

使い方

1. TEEコマンドを実行します。
2. 実行するファイル名を指定します。
3. 出力先のファイル名を指定します。そのままでよければEnterを押します。
4. コマンドが実行され、正常終了、キャンセルに関わらず、コマンドの出力内容がファイルに出力されます。

プログラムの説明

teecommand.h

class TeeCommand : public CFxCommand, CFxOutputDevice
{
public:
	virtual const OdString groupName() const { return "TEE_GROUP_NAME"; }
	virtual const OdString globalName() const { return "_TEE"; }
	virtual const OdString localName() const { return "TEE"; }
	virtual int Execute(CFxCommandContext* pCmdCtx);

	virtual void CommandOutput(const CFxString& message, const CFxDocument* document);
	virtual void SystemOutput(const CFxString& message, const CFxDocument* document);

protected:
	TeeCommand(void) {}
	~TeeCommand(void) {}
private:
	//QString getCoordinates(const OdGePoint3dArray& inp);
	QStringList m_output;
	int m_prec;
};

teecommand.cpp

void TeeCommand::CommandOutput(const CFxString& message, const CFxDocument* document)
{
    m_output.append(message);
}

void TeeCommand::SystemOutput(const CFxString& message, const CFxDocument* document)
{
    //m_output.append(message);
}

int TeeCommand::Execute(CFxCommandContext* pCmdCtx)
{
    CFxHostAppServicesPtr svc = GetFxSystemServices()->GetHostAppServices();
    CFxDocumentPtr doc = pCmdCtx->GetFxDocument();
    CFxDatabasePtr db = doc->GetFxDatabase();
    CFxUserIO* io = doc->GetFxUserIO();
    m_output.clear();
    // Specify command.
    CFxString command;
    CFxString prompt = io->GetPrompt(L"Command name");
    int rc = io->GetString(false, prompt, L"", &command);
    if (rc != RTNORM)
        return RTNORM;
    // Specify filename.
    QFileInfo fi;
    if (db->getDWGTITLED())
    {
        fi.setFile(QString::fromUtf16(db->getFilename().c_str()));
    }
    else
    {
        fi.setFile(
            QString::fromUtf16(svc->getMYDOCUMENTSPREFIX().c_str()),
            QString::fromUtf16(db->getDWGNAME().c_str())
        );
    }   
    CFxString inputname = QString("%1/%2.txt").arg(fi.absolutePath()).arg(fi.completeBaseName());
    CFxString filename;
    prompt = io->GetPromptString(L"File name", &inputname);
    rc = io->GetString(true, prompt, inputname, &filename);
    if (rc != RTNORM)
        return RTNORM;
    // Run command
    GetFxSystemServices()->AddOutputDevice(this);
    OdResBufPtr cmd = OdResBuf::newRb(OdResBuf::kRtString, command.wide_strU());
    GetFxSystemServices()->SendStringToExecute(nullptr, cmd);
    GetFxSystemServices()->RemoveOutputDevice(this);
    // Write file
    QFile fOut(filename);
    if (fOut.open(QFile::WriteOnly | QFile::Text)) 
    {
        QTextStream s(&fOut);
        s.setCodec("shift-jis");
        for (int i = 0; i < m_output.size(); ++i)
        {
            s << m_output.at(i);
        }
        s.flush();
        fOut.close();
    }
    else 
    {
        io->Write(L"File open error.\n");
    }
    return RTNORM;
}

• 最初の GetString( )でコマンド名を入力します。最初の引数が false なのでスペースで入力が終了します。
• Qt のQFileInfo クラスはディレクトリ、ファイル、拡張子を処理するのに便利なクラスです。
• 保存済みの図面の場合は CFxDatabase::getFilename() にDWGファイルの完全パスがあるのでそれを使い、未保存の図面の場合はシステム変数 MYDOCUMENTPREFIX と DWGNAME からファイル名を生成します。
• 最初の GetString( )でファイル名を入力します。最初の引数が true なのでEnterで入力が終了し、ファイル名にスペースを含めることが可能です。
• AddOutputDevice() でコマンド出力内容の横取りが開始します。
• SendStringToExecute() でコマンドをただちに実行して、終了まで待ちます。リザルトバッファにコマンドの追加の引数が指定できますが、足りない場合はユーザー入力待ちになります。
• RemoveOutputDevice() でコマンド出力内容の横取りを終了します。
• Qtの QFile クラス、QTextStream クラスによってテキストファイルを出力しています。setCodec() によって出力する文字コードをシフトJIS (日本語)に切り替えています。setCodec() がないとユニコード(UTF-8)での出力になります。
• コマンド出力内容を横取りするためには、CFxOutputDevice クラスを継承する必要があります。TEE コマンドは、CFxCommand と CFxOutputDevice クラスを継承しているのでコマンド出力内容を横取りできるコマンドになります。
• CFxOutputDevice クラスを継承すると、commandOutput() と systemOutput() を実装する必要があります。今回システムからの出力は不要なので、commandOutput() が呼び出されたら、m_output に文字列をためるようにします。

ARESのコマンド履歴ウィンドウやコマンドプロンプトウィンドウはQtのウィジェットになっているので text() で内容を取ってくることは可能なのですが、コマンド出力内容が更新されるのは ARES のタイミング次第なので、text() ではうまくいきません。CFx APIに提供されている CFxOutputDevice クラスを利用することで確実にコマンド出力内容を横取りすることができます。

案外覚えやすいDXFのグループコード

 案外覚えやすい、DXFのグループコード。行ってみよう。

基本

0  データ種類｛DXF名）

1 文字データ

2 名前（ブロック名など）

3 コメント、追加の文字データ

5 図形ハンドル

6 線種名

7 スタイル名（文字設定）

8 画層名

9 システム変数名

10 座標値

38 高度

39 厚さ

40 実数値（円の半径等）

50 角度値（円弧の開始角等）

60 図形非表示

62 図形色

70 整数値（画層のフラグ等）

90 長整数値

100 クラス名

102 リアクター等の目印

210 押し出し方向

420 フルカラー

430 色名

999 コメント（DXFファイルのみ）

1000 拡張データ　文字データ

1001 学長データID

1002 カツコ

1003 画像名

1005 ハンドル（ソフトリンク）

1010 座標

1040 実数

1070 整数

画層や線種といった各種図形に共通のプロパティは覚えておいて損はない。

図形などデータベースオブジェクトをDXFファイルやリスト形式で表現するほか、図形の選択条件式としても使います。それはLISP以外でも使います。VBAしかり、c++しかり、.NETでも使います。

ARESからPowerShellのInvoke-WebRequest を使って適当にファイルをダウンロードしてくる

何このアタオカな処理はって感じですが... 

: SHELL

OS コマンドを指定» powershell.exe Invoke-WebRequest -uri "https://cyberjapandata.gsi.go.jp/xyz/std/1/1/0.png" -outfile "c:\temp\std~1~1~0.png"

ARESのSHELLコマンドってのが、コマンドプロンプトへの１行分の処理を行って終了を待って戻ってきます。コマンドプロンプトに powershell.exe とするので PowerShell を１行実行です。ここではInvoke-WebRequest というコマンドレットの実行だけなので引数に処理を全部書いちゃいます。 -Uri ダウンロードするファイル -Outfile 出力先 で行けます。

そこそこ早かったです。

(2024/06/11 追記）

スペースを含むパスを引数にしたいときには、シングルクォートで囲う。

: SHELL

OS コマンドを指定» powershell.exe Invoke-WebRequest -uri ’https://cyberjapandata.gsi.go.jp/xyz/std/1/1/0.png' -outfile  'C:\Users\cadkh\AppData\Local\Temp\ARES Commander Edition_temp\std~0~0~0.png'

盲点であった。