dayjournal memo

Total 963 articles!!

QGIS #028 - プラグイン作成2「QGIS Plugin Builder」

Yasunori Kirimoto's avatar

今回は「QGIS #027」で紹介した「QGIS Plugin Builder」で作成したプラグインをカスタマイズする方法を試してみます。


まずデフォルトダイアログを変更します。以前「QGIS #008」で紹介した「Qt Designer」を起動して「モジュール名_dialog_base.ui」を開きます。 QGIS_028_02


開いた「モジュール名_dialog_base.ui」を修正して上書き保存します。 ※今回は「QGIS #008」で紹介したレイヤ数の表示機能を構築します。 QGIS_028_01

次に、Pythonファイルを修正します。今回は「モジュール名.py」のみを修正したいと思います。

モジュール名.py


from PyQt4.QtCore import QSettings, QTranslator, qVersion, QCoreApplication
from PyQt4.QtGui import QAction, QIcon
# Initialize Qt resources from file resources.py
import resources
# Import the code for the dialog
from sample_dialog import sampleDialog
import os.path

class sample:
    """QGIS Plugin Implementation."""

    def __init__(self, iface):
        """Constructor.

        :param iface: An interface instance that will be passed to this class
            which provides the hook by which you can manipulate the QGIS
            application at run time.
        :type iface: QgsInterface
        """
        # Save reference to the QGIS interface
        self.iface = iface
        # initialize plugin directory
        self.plugin_dir = os.path.dirname(__file__)
        # initialize locale
        locale = QSettings().value('locale/userLocale')[0:2]
        locale_path = os.path.join(
            self.plugin_dir,
            'i18n',
            'sample_{}.qm'.format(locale))

        if os.path.exists(locale_path):
            self.translator = QTranslator()
            self.translator.load(locale_path)

            if qVersion() > '4.3.3':
                QCoreApplication.installTranslator(self.translator)

        # Create the dialog (after translation) and keep reference
        self.dlg = sampleDialog()

        # Declare instance attributes
        self.actions = []
        self.menu = self.tr(u'&sample')
        # TODO: We are going to let the user set this up in a future iteration
        self.toolbar = self.iface.addToolBar(u'sample')
        self.toolbar.setObjectName(u'sample')

    # noinspection PyMethodMayBeStatic
    def tr(self, message):
        """Get the translation for a string using Qt translation API.

        We implement this ourselves since we do not inherit QObject.

        :param message: String for translation.
        :type message: str, QString

        :returns: Translated version of message.
        :rtype: QString
        """
        # noinspection PyTypeChecker,PyArgumentList,PyCallByClass
        return QCoreApplication.translate('sample', message)

    def add_action(
        self,
        icon_path,
        text,
        callback,
        enabled_flag=True,
        add_to_menu=True,
        add_to_toolbar=True,
        status_tip=None,
        whats_this=None,
        parent=None):
        """Add a toolbar icon to the toolbar.

        :param icon_path: Path to the icon for this action. Can be a resource
            path (e.g. ':/plugins/foo/bar.png') or a normal file system path.
        :type icon_path: str

        :param text: Text that should be shown in menu items for this action.
        :type text: str

        :param callback: Function to be called when the action is triggered.
        :type callback: function

        :param enabled_flag: A flag indicating if the action should be enabled
            by default. Defaults to True.
        :type enabled_flag: bool

        :param add_to_menu: Flag indicating whether the action should also
            be added to the menu. Defaults to True.
        :type add_to_menu: bool

        :param add_to_toolbar: Flag indicating whether the action should also
            be added to the toolbar. Defaults to True.
        :type add_to_toolbar: bool

        :param status_tip: Optional text to show in a popup when mouse pointer
            hovers over the action.
        :type status_tip: str

        :param parent: Parent widget for the new action. Defaults None.
        :type parent: QWidget

        :param whats_this: Optional text to show in the status bar when the
            mouse pointer hovers over the action.

        :returns: The action that was created. Note that the action is also
            added to self.actions list.
        :rtype: QAction
        """

        icon = QIcon(icon_path)
        action = QAction(icon, text, parent)
        action.triggered.connect(callback)
        action.setEnabled(enabled_flag)

        if status_tip is not None:
            action.setStatusTip(status_tip)

        if whats_this is not None:
            action.setWhatsThis(whats_this)

        if add_to_toolbar:
            self.toolbar.addAction(action)

        if add_to_menu:
            self.iface.addPluginToMenu(
                self.menu,
                action)

        self.actions.append(action)

        return action

    def initGui(self):
        """Create the menu entries and toolbar icons inside the QGIS GUI."""

        icon_path = ':/plugins/sample/icon.png'
        self.add_action(
            icon_path,
            text=self.tr(u'sample go'),
            callback=self.run,
            parent=self.iface.mainWindow())

        self.dlg.pushButton.clicked.connect(self.layerall)

    def unload(self):
        """Removes the plugin menu item and icon from QGIS GUI."""
        for action in self.actions:
            self.iface.removePluginMenu(
                self.tr(u'&sample'),
                action)
            self.iface.removeToolBarIcon(action)
        # remove the toolbar
        del self.toolbar

    def run(self):
        """Run method that performs all the real work"""
        # show the dialog
        self.dlg.show()
        # Run the dialog event loop
        result = self.dlg.exec_()
        # See if OK was pressed
        if result:
            # Do something useful here - delete the line containing pass and
            # substitute with your code.
            pass

    def layerall(self):

        layerall = str(self.iface.mapCanvas().layerCount())
        self.dlg.label.setText(layerall)

2箇所に処理を追加します。

ボタンクリック時のイベント処理:


self.dlg.pushButton.clicked.connect(self.layerall)

ラベルに現在表示されているレイヤ数を表示:


def layerall(self):

    layerall = str(self.iface.mapCanvas().layerCount())
    self.dlg.label.setText(layerall)
    

QGISを起動して作成したプラグインを実行します。 QGIS_028_03


実行ボタンを押すと現在表示されているレイヤ数が取得されてラベルに表示されました。 QGIS_028_04


以前「QGIS #008」で紹介したファイル構造と違う部分も多いので少し困惑しましたがサンプル作成できました。あとは各機能の組み合わせを理解していくと色々な機能を実装したプラグインが作れそうです。

ちなみに「QGIS Plugin Builder」でプラグイン作成すると、「metadata.txt」についても入力項目の内容通りに自動で作成されます。あと「モジュール名_dialog.py」の記述により「モジュール名_dialog_base.ui」を上書きするだけでPythonファイルに変換しなくてもダイアログをそのまま読み込めるようです。各機能を追加する場合は、基本的に「モジュール名.py」を修正することになると思います。



book

Q&A


  • 参考文献

QGIS Plugin Builder