[Blender3.3] 日本の地形モデルメッシュ追加アドオンの開発 (1): メニュー追加とポップアップ画面

これまでは準備ばかりでしたが、そろそろアドオンの開発を進めたいと思います。

最初に作るのは、日本の地形モデルのメッシュを追加するアドオンです。まだまだアドオン開発に不慣れで、試行錯誤しながらですので、一気に完成にはなりませんことご容赦ください。

使うデータですが、過去調べていた 日本の地形図データ から、地理院の地形図タイルを使うことにします。PLATEAUについては、そもそもBlenderでも使えるデータが入っていますしね。あと、地形図タイルを使うことの利点は、日本国内ならどこでも好きな場所のデータが手に入ることです。

今回のアドオンの仕様ですが、オブジェクトの作成時に緯度、経度、範囲、ズームの値を指定して、それに合わせて地形図タイルのデータを取得しオブジェクトを作成して表示させることを目指します。

まずは、入力のポップアップを作るところから。

Blenderのテキストエディタを開いて、「テンプレート」から「Python > Addon Add Object」を開いて、名前を付けて保存します。ここでは、最終的に地形モデルのアドオンにするつもりなので、terrain_model_jp.py として作成します。

テンプレートを若干手直しして、下記の内容にします。

bl_info = {
    "name": "New Object2",
    "author": "Shiki Kuraga",
    "version": (1, 0),
    "blender": (3, 3, 0),
    "location": "View3D > Add > Mesh > New Object2",
    "description": "Adds a new Mesh Object",
    "warning": "",
    "support": "TESTING",
    "doc_url": "",
    "category": "Add Mesh",
}


import bpy
from bpy.types import Operator
from bpy.props import FloatProperty, IntProperty
from bpy_extras.object_utils import AddObjectHelper, object_data_add
from mathutils import Vector
from trace import Trace


def add_object(self, context):
    Trace.print("add_object()")
    
    scale_x = 1 #self.scale.x
    scale_y = 1 #self.scale.y

    verts = [
        Vector((-1 * scale_x, 1 * scale_y, 0)),
        Vector((1 * scale_x, 1 * scale_y, 0)),
        Vector((1 * scale_x, -1 * scale_y, 0)),
        Vector((-1 * scale_x, -1 * scale_y, 0)),
    ]

    edges = []
    faces = [[0, 1, 2, 3]]

    mesh = bpy.data.meshes.new(name="Object Mesh 2")
    mesh.from_pydata(verts, edges, faces)
    # useful for development when the mesh may be invalid.
    # mesh.validate(verbose=True)
    object_data_add(context, mesh, operator=self)


class OBJECT_OT_add_object2(Operator, AddObjectHelper):
    """Create a new Mesh Object2"""
    bl_idname = "mesh.add_object2"
    bl_label = "Add Mesh Object2"
    bl_options = {'REGISTER', 'UNDO'}

    prop_lat: FloatProperty(
        name = "Latitude",
        description = "Latitude",
        default = 35.0,
        min = -89.0,
        max = 89.0
    )

    prop_lon: FloatProperty(
        name = "Longitude",
        description = "Longitude",
        default = 135.0,
        min = -180.0,
        max = 180.0
    )

    prop_scope: FloatProperty(
        name = "Scope",
        description = "Scope",
        default = 1000,
        subtype = 'DISTANCE',
        min = 100
    )

    prop_zoom: IntProperty(
        name = "Zoom",
        description = "Zoom",
        default = 14,
        min = 3,
        max = 14
    )

    def execute(self, context):

        add_object(self, context)

        return {'FINISHED'}

    def invoke(self, context, event):
        
        wm = context.window_manager

        # invoke properties dialog for this object
        return wm.invoke_props_dialog(self)

# Registration

def add_object_button2(self, context):
    # insert separator
    self.layout.separator()
    self.layout.operator(
        OBJECT_OT_add_object2.bl_idname,
        text="Add Object2",
        icon='PLUGIN')


## This allows you to right click on a button and link to documentation
#def add_object_manual_map():
#    url_manual_prefix = "https://docs.blender.org/manual/en/latest/"
#    url_manual_mapping = (
#        ("bpy.ops.mesh.add_object2", "scene_layout/object/types.html"),
#    )
#    return url_manual_prefix, url_manual_mapping


def register():
    Trace.print("register()")
    bpy.utils.register_class(OBJECT_OT_add_object2)
#    bpy.utils.register_manual_map(add_object_manual_map)
    bpy.types.VIEW3D_MT_mesh_add.append(add_object_button2)


def unregister():
    Trace.print("unregister()")
    bpy.utils.unregister_class(OBJECT_OT_add_object2)
#    bpy.utils.unregister_manual_map(add_object_manual_map)
    bpy.types.VIEW3D_MT_mesh_add.remove(add_object_button2)


if __name__ == "__main__":
    Trace.on()
    register()

なお、ここでTraceオブジェクトを使っていますが、これは、以前作成したtrace.pyです。加えて、そのスクリプトが自動で読まれるようにしておかないとです。(デフォルトのスクリプト読み込みフォルダに入れるか、読み込みフォルダの追加設定をするか)

これをテキストエディタ内でAlt+Pで実行して試してみます。

きちんとアドオンが登録できれば、3Dビューポートのメニューの「追加 > メッシュ」の先に「Add Object2」の選択肢が現れます。

そして、それを選択するとポップアップが出ました。

「位置」「回転」はAddObjectHelperを継承すると自動的に入るようです。自分で追加したのはLatitude以下です。Zoomについては、自動的に翻訳機構が動いて「ズーム」になりました。

あと、Scopeは距離の設定ですが、最初IntPropertyにしたところ、単位の「m」が表示されなかったので、仕方なくFloatPropertyに変更しました。最低値は100mです。ただこれ、Blenderの設定で表示単位が変わるんですが、その時どうなるかは未検証です。(内部的にはすべてメートルで計算するようになっていれば、このままで良いのですが)

取り敢えずこれで「OK」すると、平面のオブジェクトが生成されます。大きさは、まだScope値を見てません。

オブジェクトが生成されると、左下にプロパティが表示されます。これを変化させると再描画処理が走るようです。わざわざポップアップ画面を出さずに直接この画面でもと思われるかもしれませんが、少なくとも緯度経度、範囲、ズームは最初に定めてしまってからにしないと地図データを何度も取りに行くことになるので非効率的ですよね。ということで、ポップアップ画面を出したのです。

まずはここまでで、続きはまた。更新は不定期ですが、年内には完成させたいものです。

日本の地形モデルメッシュ追加アドオンの開発(1) 【次回(2)】