QGIS3 Plugin Builderでプラグイン作成

このページでは、QGISプラグイン「Plugin Builder」についてご紹介していきます。Plugin Builderは、QGISプラグインの雛形を作成してくれる補助ツールです。このプラグインを使えば、QGISプラグイン作成が大分楽になります。


Plugin Builderをインストールする

プラグイン管理のダイアログを表示する

f:id:Chiakikun:20180901143311p:plain

QGISを起動して、メニューの『プラグイン』→『プラグインの管理とインストール』を選択して下さい。

 

Plugin Builderを検索する

f:id:Chiakikun:20180901143419p:plain

Plugin Builderをインストールします。上の赤丸の検索窓で検索すると見つけやすいです。

 

f:id:Chiakikun:20180901143512p:plain

候補に出てきた『Plugin Builder 3』を選択してインストールして下さい。

 

メニューに表示される

f:id:Chiakikun:20180901143601p:plain

Plugin Builderがメニューから選択できるようになりました。


Plugin Builderを使ってみる

必要項目を入力する

f:id:Chiakikun:20180901143949p:plain

Plugin Builderが使えるようになったので、試しにPlugin Builderでプラグインのひな型を作成して実行してみます。メニューの『プラグイン』→『Plugin Builder』を実行し、上の画面のように必要事項を入力してNextボタンを押して下さい。

 

作成するプラグインの説明文を入力する

f:id:Chiakikun:20180901144110p:plain

f:id:Chiakikun:20180901144150p:plain

この辺りは適当に入力して下さい。

 

追加コンポーネントを選択

f:id:Chiakikun:20180901144232p:plain

今回はそのままにしました。本家サイトを確認しましたが、必須ではないようです。

チェックを全部外して実行してみましたが、問題も発生していません。

 

プラグインのレポジトリ等

f:id:Chiakikun:20180901144324p:plain

ここもそのままで、ただ一応お試しプラグインなので、赤丸部分のチェックボックスにチェックを入れておきました。

 

f:id:Chiakikun:20180901144444p:plain

作成するプラグインの保存先を指定します。私は『E:\QGIS Plugin』フォルダを指定しました。赤線部分がこのプラグインの保存先になります。画像では保存先がDドライブになっていますが、気にしないでください。

 

prcc5 was not found ?

f:id:Chiakikun:20190922130700p:plain

「The resource compiler pyrcc5 was not found in your path.」と警告ダイアログが表示されるので、PowerShellを起動して次のコードを入力します。

    cd "E:\QGIS Plugin\test_plugin"
    pyrcc5 -o resources.py resources.qrc

1行目で作成中のプラグインの保存先に移動して、2行目でpyrcc5コマンドを実行しています。

pyrcc5コマンドを実行するにはPathを設定しないといけません。こちらで紹介した設定を済ませていればパスは通っています。

環境変数QGIS_PLUGINPATHの設定

QGISが今作成したプラグインを探せるように、環境変数QGIS_PLUGINPATHを設定します。次のコードをPowerShellに張り付けて実行して下さい。

$old = [System.Environment]::GetEnvironmentVariable("QGIS_PLUGINPATH", "User")
$old += ";E:\QGIS Plugin"
[System.Environment]::SetEnvironmentVariable("QGIS_PLUGINPATH", $old, "User")

作成したプラグインを実行してみる

環境変数QGIS_PLUGINPATHの設定に問題無ければ、QGISを起動すれば先ほど作成したプラグインはメニューに表示されるはずですが、もし見当たらない場合は次の方法を試してください。

メニューに表示されていればこちらに進んでください。

プラグインを有効にする

f:id:Chiakikun:20180901145055p:plain

QGISに戻って、メニューの『プラグイン』→『プラグインの管理とインストール』を選択して下さい。

 

f:id:Chiakikun:20180901145401p:plain

f:id:Chiakikun:20180901145527p:plain

検索窓に先ほど作成したプラグインの名前を入力するとプラグインが見つかります。チェックして有効にして下さい。

 

プラグインを実行する

f:id:Chiakikun:20180901145600p:plain

作成したプラグインがメニューに登録されています。実行してみると...

 

f:id:Chiakikun:20180901145648p:plain

ウィンドウが表示されました。


Plugin Builderで作成した雛形に少し手を加える

Designerを実行する

f:id:Chiakikun:20180930154055p:plain

フォームに少し手を加えてみます。「Qt Designer」を起動します。スタートボタンを押して、検索窓に「designer」と入力すると、候補が出てきます。上の赤丸を選択してください。

 

UIファイルを開く

f:id:Chiakikun:20180930154233p:plain

先ほど作成したTest Pluginのフォームを選択します。メニューの「ファイル」→「開く」を選択すると、ファイル選択ダイアログが出るので、「E:\QGIS Plugin\testplugin\test_plugin_dialog_base.ui」を選択すると...

 

f:id:Chiakikun:20180930155003p:plain

Test Pluginのフォームが表示されました。

 

Line Editを貼り付けてみる

f:id:Chiakikun:20180930155429p:plain

Line Editを貼り付けます。貼り付けたらメニューの「ファイル」→「保存」を選択して、Designerを終了します。

 

プラグインに反映されているか確認する

f:id:Chiakikun:20180930162023p:plain

フォームの変更が反映されているか確認してみます。QGISを起動して、Test Pluginボタンをクリックします。Line Editが追加されたフォームが表示されましたでしょうか?

 

ソースコードを編集する

ソースに少し手を加えてみます。test_plugin.pyを編集します。33行目あたりに次のコードを追加します。

import qgis.core

さらに185行目あたりにあるrunメソッドの「if result:」と書かれたコードの下に次のコードを挿入します。lineEditに指定したシェープファイルを読み込むコードです。

            file = self.dlg.lineEdit.text()
            layer = qgis.core.QgsVectorLayer(file, u"サンプルレイヤ", "ogr")
            if layer.isValid():
                qgis.core.QgsProject.instance().addMapLayer(layer)

実行してみる

f:id:Chiakikun:20180930172524p:plain

QGISを起動して、Test Pluginを実行します。そしてLine Editに適当なシェープファイルのフルパスを指定してOKボタンをクリックします。指定したシェープファイルがQGISに読み込まれると思いますが、うまく表示されたでしょうか?


最後までご覧頂き、ありがとうございました