Dialog creation/jp

このページではQtのインナーフェイスデザイン用の公式ツールであるQtDesignerを使って簡単なQtダイアログを作成し、それをPythonコードに変換してFreeCAD内部で使用する方法について説明します. この例ではPythonスクリプトの編集と実行の仕方、ディレクトリの移動などのターミナルウィンドウでの簡単な操作については既に知っているものとして説明を行います. また当然のことながらpyqtをインストールしてなければなりません.

ダイアログのデザイン
CADアプリケーションでは優れたUI（ユーザーインターフェイス）のデザインは非常に重要です. ユーザーが行う操作のほとんど全てがダイアログボックスの文章を読んだり、ボタンを押したり、アイコンを選択したりといったインターフェイスを通じたものになります. 従って自分が何をしたいのか、ユーザーにどのような操作をさせたいのか、処理の流れがどのようになるのかを慎重に考えることがとても重要になってきます.

インターフェイスをデザインする際に知っておく必要のある概念がいくつかあります：


 * モーダル/モーダレスなダイアログ： モーダルダイアログは画面の前面に表示されメインウィンドウの操作をできなくした上でユーザーにダイアログを操作するように要求します. 一方、モーダレスダイアログはメインウィンドウの操作を妨げることはしません. どちらが良いかは時と場合によります.
 * 何が必須であり何がオプションであるかを認識する：何をしなければならないユーザーが間違いなくわかるようにします. 全てのものに適切な説明が書かれたラベルを付ける、ツールチップを使用するなどの方法があります.
 * コマンドとパラメータの分離：通常、これはボタンとテキスト入力フィールドを使って行われます. ボタンをクリックすると処理が行われ、テキストフィールド内部の値を変更すると何かしらのパラメータが変更されるということをユーザーは理解しています. 現在ではユーザーは通常、ボタンが何か、入力フィールドが何かといったことを熟知しているのです. 私たちが使用するインターフェイスツールキットであるQtは最先端のツールキットです. どうやればわかりやすいものを作れるか悩む必要はほとんどありません. 既にそれ自体がわかりやすい様になっているのです.

さてこれからやることについては十分な定義が終わりました. いよいよQtDesignerを開きます. 次の様な非常に簡単なダイアログをデザインしてみましょう：



出来上がったらFreeCADできれいな長方形の平面を作成するためにこのダイアログを使うことにします. きれいな長方形の平面を作るのにはこれは不便だということにあなたは気がつくでしょうが、後でもっと複雑なことを行えるように変更することは簡単です. QtDesignerを開くと次のような表示になります：



使い方は非常に簡単です. 左側のバーにはウィジット上にドラッグして置ける要素があります. 右側には選択されている要素の編集可能なプロパティ全てが表示されているプロパティパネルがあります. それではまず新しいウィジットを作成することから始めてみましょう. デフォルトのOK/キャンセルボタンはいらないので"Dialog without buttons"を選択します. 次にLabelウィジットを3つドラッグしてきます. 一つはタイトル、一つは "Height"、一つは"Width"と書くために使います. ラベルはウィジット上に表示されるシンプルなテキストでユーザーに情報を与えるために使います. ラベルを選択すると右側にフォントスタイル、高さなどいくつかの変更可能なプロパティが表示されます.

次にユーザーが入力することが可能なテキストフィールドであるLineEditsを2つ追加します. 一つは高さ用、もう一つは幅用です. ここでもプロパティを編集することができます. 例えばデフォルト値を設定してみてはどうでしょう？それぞれ1.00としてみましょう. こうすればユーザーがダイアログを見た確認した時には既に両方の値が設定されていて、ユーザーがその値に満足していれば直接ボタンを押すことができるので貴重な時間を節約できます. さらにユーザーが2つのフィールドに入力した後に押す必要があるPushButtonを追加します.

ここでは非常に簡単なコントロールを選んでいますがQtにもっと多くのオプションがあり、LineEditの代わりにSpinboxeを使ったりすることなどもできます. 何が利用可能か見てみてください. きっと他のアイデアが思い浮かぶはずです.

QtDesignerで行うことはこれで全てです. ただし、最後に全ての要素の名前をわかりやすいものに変更しておきましょう. そうすればスクリプトで区別がつきやすくなります：



ダイアログのPythonコードへの変換
さあ、私たちのウィジットをどこかに保存しましょう. ウィジットは.uiファイルとして保存され、pyuicを使うと簡単にPythonスクリプトに変換できます. Windowsではpyuicはpyqtにバンドルされています（確認してください）. Linuxではパッケージマネージャで個別にインストールする必要があるはずです（Debianベースのパッケージの場合、pyqt4-dev-toolsパッケージに含まれています）. 変換のためにはまずターミナルウィンドウ（Windowsの場合はコマンドプロンプトウィンドウ）を開き、.uiファイルを保存した場所に移動して次のコマンドを実行します：

pyuic mywidget.ui > mywidget.py

一部のシステムではプログラム名がpyuicではなくpyuic4の場合があります. このコマンドによって.uiファイルがPythonスクリプトに変換されます. mywidget.pyファイルを開いて見てみるとその内容が簡単に理解できるものであることがわかります：

from PyQt4 import QtCore, QtGui class Ui_Dialog(object): def setupUi(self, Dialog): Dialog.setObjectName("Dialog") Dialog.resize(187, 178) self.title = QtGui.QLabel(Dialog) self.title.setGeometry(QtCore.QRect(10, 10, 271, 16)) self.title.setObjectName("title") self.label_width = QtGui.QLabel(Dialog) ...        self.retranslateUi(Dialog) QtCore.QMetaObject.connectSlotsByName(Dialog) def retranslateUi(self, Dialog): Dialog.setWindowTitle(QtGui.QApplication.translate("Dialog", "Dialog", None, QtGui.QApplication.UnicodeUTF8)) self.title.setText(QtGui.QApplication.translate("Dialog", "Plane-O-Matic", None, QtGui.QApplication.UnicodeUTF8)) ...

見てわかるようにとても簡単な構造です. Ui_Dialogという名前のクラスが作成され、その中にウィジットのインターフェイス要素が保存されています. クラスは二つのメソッドを持っています. 一つはウィジットをセットアップするためのもので、もう一つはその内容を翻訳するためのものです. 翻訳用のものはインターフェイス要素を翻訳するために用意された一般的なQtの仕組みの一部です. セットアップ用のメソッドは私たちがQtDesignerで定義したウィジットを1つずつ作成し、先に私たちが決めたオプションを設定していきます. それからインターフェイス全体が翻訳され、最後にスロットが接続されます（これについては後で説明します）.

これで新しいウィジットを作成し、そのインターフェイスを作成するためにこのクラスを使用することができます. もう既にウィジットを動かしてみることができます. FreeCADが検索する場所（FreeCADのbinディレクトリまたはModサブディレクトリのどれか）にmywidget.pyファイルを置き、FreeCADのPythonインタプリタで次のコマンドを実行すればいいのです：

from PyQt4 import QtGui import mywidget d = QtGui.QWidget d.ui = mywidget.Ui_Dialog d.ui.setupUi(d) d.show するとダイアログが表示されます！Pythonインタプリタがまだ動作していることに注意してください. 私たちはモーダレスダイアログを使っているのです. ダイアログを閉じるには次のコマンドを使ってください（もちろんダイアログの閉じるアイコンをクリックしても閉じられます）： d.hide

ダイアログで処理を行えるようにする
さてダイアログの表示と非表示はできるようになりました. 最後の仕上げを行いましょう：処理を行えるようにするのです！QtDesignerを少しいじっていればすぐに"signals and slots"と呼ばれる機能があることに気がつくでしょう. 基本的な動作は次のようになります. ウィジット上の要素（Qtでの用語で言うとこれらの要素自体もウィジットなのです）はシグナルを送信できます. シグナルはウィジットの型によって異なります. 例えばボタンは押された時と離された時にシグナルを送れます. このシグナルはスロットにつなげることができます. スロットとしては他のウィジットの特別な機能（例えばダイアログには"閉じる"スロットがあり、閉じるボタンからのシグナルを接続することができます）や自作関数を使うことができます. PyQtリファレンスドキュメントには全てのQtウィジット、それを使ってできること、どんなシグナルを送信できるかなどがリストアップされています.

ここで行うことは高さと幅に基いて平面を作成する新しい関数を作成すること、その関数と"Create!"ボタンを押した際に発信されるシグナルとを接続することです. まずFreeCADモジュールをインポートすることから始めましょう. 次の行をQtCoreとQtGuiをインポート済みのスクリプトの先頭に書き込むことで可能です：

import FreeCAD, Part

次にUi_Dialogクラスに新しい関数を追加しましょう：

def createPlane(self): try: # まず有効な値が入力されているかをチェック w = float(self.width.text) h = float(self.height.text) except ValueError: print "Error! Width and Height values must be valid numbers!" else: # 4つの点から面を作成 p1 = FreeCAD.Vector(0,0,0) p2 = FreeCAD.Vector(w,0,0) p3 = FreeCAD.Vector(w,h,0) p4 = FreeCAD.Vector(0,h,0) pointslist = [p1,p2,p3,p4,p1] mywire = Part.makePolygon(pointslist) myface = Part.Face(mywire) Part.show(myface) self.hide

さらにボタンと関数を接続するようにQtに指定する必要があります. 次の行をQtCore.QMetaObject.connectSlotsByName(Dialog)の直前に挿入することで可能です：

QtCore.QObject.connect(self.create,QtCore.SIGNAL("pressed"),self.createPlane)

見てわかるようにこれによって私たちが作成したオブジェクト（"Create!"ボタン）のpressedシグナルが私たちが定義したcreatePlaneという名前のスロットに接続されます. これで終わりです！最後に呼び出しを簡単に行うためにダイアログを作成するための小さな関数を追加しましょう. Ui_Dialogクラスの外に次のコードを追加します：

class plane: d = QtGui.QWidget d.ui = Ui_Dialog d.ui.setupUi(d) d.show

それが終わったらFreeCADから次のコマンドを実行するだけです：

import mywidget mywidget.plane

これで終わりです. もうあなたは自分のウィジットをFreeCADのインターフェイスに追加したり、ウィジット上の他の要素を使ってもっと高度な自作ツールを作るといったあらゆることに挑戦できるのです.

全スクリプト
参考のために全スクリプトを記載しておきます：

# # from PyQt4 import QtCore, QtGui import FreeCAD, Part class Ui_Dialog(object): def setupUi(self, Dialog): Dialog.setObjectName("Dialog") Dialog.resize(187, 178) self.title = QtGui.QLabel(Dialog) self.title.setGeometry(QtCore.QRect(10, 10, 271, 16)) self.title.setObjectName("title") self.label_width = QtGui.QLabel(Dialog) self.label_width.setGeometry(QtCore.QRect(10, 50, 57, 16)) self.label_width.setObjectName("label_width") self.label_height = QtGui.QLabel(Dialog) self.label_height.setGeometry(QtCore.QRect(10, 90, 57, 16)) self.label_height.setObjectName("label_height") self.width = QtGui.QLineEdit(Dialog) self.width.setGeometry(QtCore.QRect(60, 40, 111, 26)) self.width.setObjectName("width") self.height = QtGui.QLineEdit(Dialog) self.height.setGeometry(QtCore.QRect(60, 80, 111, 26)) self.height.setObjectName("height") self.create = QtGui.QPushButton(Dialog) self.create.setGeometry(QtCore.QRect(50, 140, 83, 26)) self.create.setObjectName("create") self.retranslateUi(Dialog) QtCore.QObject.connect(self.create,QtCore.SIGNAL("pressed"),self.createPlane) QtCore.QMetaObject.connectSlotsByName(Dialog) def retranslateUi(self, Dialog): Dialog.setWindowTitle(QtGui.QApplication.translate("Dialog", "Dialog", None, QtGui.QApplication.UnicodeUTF8)) self.title.setText(QtGui.QApplication.translate("Dialog", "Plane-O-Matic", None, QtGui.QApplication.UnicodeUTF8)) self.label_width.setText(QtGui.QApplication.translate("Dialog", "Width", None, QtGui.QApplication.UnicodeUTF8)) self.label_height.setText(QtGui.QApplication.translate("Dialog", "Height", None, QtGui.QApplication.UnicodeUTF8)) self.create.setText(QtGui.QApplication.translate("Dialog", "Create!", None, QtGui.QApplication.UnicodeUTF8)) def createPlane(self): try: # まず有効な値が入力されているかをチェック w = float(self.width.text) h = float(self.height.text) except ValueError: print "Error! Width and Height values must be valid numbers!" else: # 4つの点から面を作成 p1 = FreeCAD.Vector(0,0,0) p2 = FreeCAD.Vector(w,0,0) p3 = FreeCAD.Vector(w,h,0) p4 = FreeCAD.Vector(0,h,0) pointslist = [p1,p2,p3,p4,p1] mywire = Part.makePolygon(pointslist) myface = Part.Face(mywire) Part.show(myface) class plane: d = QtGui.QWidget d.ui = Ui_Dialog d.ui.setupUi(d) d.show
 * 1) -*- coding: utf-8 -*-
 * 1) フォームの実装は読み込んだ'mywidget.ui'ファイルから生成
 * 1) Created: Mon Jun  1 19:09:10 2009
 * 2)      by: PyQt4 UI code generator 4.4.4
 * 1) 警告！このファイルで行った全ての変更が失われます！