はじめてのBlenderアドオン開発

Last Update: 2021.12.23

Blender 2.8~3.0

はじめてのBlenderアドオン開発

Blender 2.8~3.0

Last Update: 2021.12.23

5-1. キーボードによるオブジェクト変形

本節では、キーボードのキー入力に応じてアクティブなオブジェクトを並進移動・拡大縮小・回転するアドオンを紹介します。

アドオンのソースコード

import enum

import bpy
from bpy.props import EnumProperty, FloatProperty
from mathutils import Vector


bl_info = {
    "name": "サンプル 5-1: キーボードによるオブジェクト変形",
    "author": "ぬっち(Nutti)",
    "version": (3, 0),
    "blender": (2, 80, 0),
    "location": "3Dビューポート > Sidebar > サンプル 5-1",
    "description": "オブジェクトの並進移動、拡大・縮小、回転をキーボードから行うアドオン",
    "warning": "",
    "support": "TESTING",
    "doc_url": "",
    "tracker_url": "",
    "category": "Object"
}

# Enumクラスを用いた列挙値の定義
EditType = enum.Enum('EditType', 'NONE TRANSLATE SCALE ROTATE')
EditAxis = enum.Enum('EditAxis', 'NONE X Y Z')
EditOption = enum.Enum('EditOption', 'NONE + -')


# 特殊オブジェクト編集モードのオペレータ
class SAMPLE51_OT_SpecialObjectEditMode(bpy.types.Operator):

    bl_idname = "mesh.sample51_special_object_edit_mode"
    bl_label = "特殊オブジェクト編集モード"
    bl_description = "特殊オブジェクト編集モードへ移行します"

    # Trueの場合は、特殊オブジェクト編集モード中
    __running = False

    @classmethod
    def is_running(cls):
        return cls.__running

    # インスタンス変数の設定
    def __init__(self):
        self.edit_type = EditType['NONE']
        self.edit_axis = EditAxis['NONE']
        self.edit_opt = EditOption['NONE']

    # 発生したイベントをもとに、次の状態を返却するプライベートなメンバ関数
    # 本来であれば本処理を工夫し、本書のコラムに書いたバグを無くすべきだが、
    # 処理を単純化するためにバグをそのまま残している
    # 引数
    #   ev_value: イベントの値
    #   on: 'PRESS'イベント発生時の状態遷移先
    #   off: 'PRESS'以外のイベント発生時の状態遷移先
    def __change_state(self, ev_value, on, off):
        if ev_value == 'PRESS':
            return on
        elif ev_value == 'RELEASE':
            return off
        return off

    def modal(self, context, event):
        op_cls = SAMPLE51_OT_SpecialObjectEditMode
        prefs = context.preferences.addons[__name__].preferences
        sc = context.scene

        # エリアを再描画
        if context.area:
            context.area.tag_redraw()

        # 特殊オブジェクト編集モードが終了する場合の処理
        if not self.is_running():
            print("サンプル 5-1: 特殊オブジェクト編集モードを終了しました。")
            return {'FINISHED'}

        # マウスの右クリック・左クリック・マウス移動のイベントは無視し、
        # 他の処理へ通知可能とする。
        # マウス移動のイベントを無視しないと、ボタンのクリックが正常に行われない。
        if event.type in ['LEFTMOUSE', 'RIGHTMOUSE', 'MOUSEMOVE']:
            return {'PASS_THROUGH'}

        # 処理するキーイベントのリスト
        # 要素1: キーの識別子
        # 要素2: オブジェクトの変形処理の状態を格納するためのインスタンス変数名
        # 要素3: 'PRESS'イベント発生時の状態遷移先
        # 要素4: 'PRESS'以外のイベント発生時の状態遷移先
        ev_key_list = (
            # 編集タイプ(並進移動、拡大・縮小、回転)
            (
                prefs.translate, "edit_type",
                EditType['TRANSLATE'], EditType['NONE']
            ),
            (prefs.scale, "edit_type", EditType['SCALE'], EditType['NONE']),
            (prefs.rotate, "edit_type", EditType['ROTATE'], EditType['NONE']),
            # 軸(X軸、Y軸、Z軸)
            (prefs.x_axis, "edit_axis", EditAxis['X'], EditAxis['NONE']),
            (prefs.y_axis, "edit_axis", EditAxis['Y'], EditAxis['NONE']),
            (prefs.z_axis, "edit_axis", EditAxis['Z'], EditAxis['NONE']),
            # 方向(正方向、負方向)
            (prefs.increment, "edit_opt", EditOption['+'], EditOption['NONE']),
            (prefs.decrement, "edit_opt", EditOption['-'], EditOption['NONE'])
        )
        # キーボードのキーイベントが発生しているかを確認し、現在の状態を更新
        for ev_key in ev_key_list:
            if event.type == ev_key[0]:
                # self.__dict__には、クラスのインスタンス変数の一覧が、ディクショナリ型
                # (キー:値)=(インスタンス変数名:インスタンス変数への参照)として
                # 保存されている
                self.__dict__[ev_key[1]] = self.__change_state(
                    event.value, ev_key[2], ev_key[3])

        # オブジェクト変換処理のための条件が揃っていない時は何もしない
        if self.edit_type == EditType['NONE']:
            return {'RUNNING_MODAL'}
        if self.edit_axis == EditAxis['NONE']:
            return {'RUNNING_MODAL'}
        if self.edit_opt == EditOption['NONE']:
            return {'RUNNING_MODAL'}

        # オブジェクトに変形処理を適用
        # 移動
        if self.edit_type == EditType['TRANSLATE']:
            value = Vector((0.0, 0.0, 0.0))
            for i, axis in enumerate(['X', 'Y', 'Z']):
                if self.edit_axis == EditAxis[axis]:
                    # オブジェクトを正方向に1.0だけ移動
                    if self.edit_opt == EditOption['+']:
                        value[i] = sc.sample51_movement
                    # オブジェクトを負方向に-1.0だけ移動
                    elif self.edit_opt == EditOption['-']:
                        value[i] = -sc.sample51_movement
            # bpy.ops.transform.translate(): 選択中のオブジェクトを並進移動する
            # 引数
            #   value: 並進移動量
            bpy.ops.transform.translate(value=value)
        # 拡大・縮小
        if self.edit_type == EditType['SCALE']:
            value = Vector((1.0, 1.0, 1.0))
            for i, axis in enumerate(['X', 'Y', 'Z']):
                if self.edit_axis == EditAxis[axis]:
                    # オブジェクトのサイズを1.1倍に拡大
                    if self.edit_opt == EditOption['+']:
                        value[i] = sc.sample51_magnification
                    # オブジェクトのサイズを0.9倍に縮小
                    elif self.edit_opt == EditOption['-']:
                        value[i] = sc.sample51_reduction
            # bpy.ops.transform.resize(): 選択中のオブジェクトを拡大・縮小する
            # 引数
            #   value: 拡大・縮小量
            bpy.ops.transform.resize(value=value)
        # 回転
        elif self.edit_type == EditType['ROTATE']:
            for i, axis in enumerate(['X', 'Y', 'Z']):
                if self.edit_axis == EditAxis[axis]:
                    # 回転方向を設定
                    # 正方向に0.1(ラジアン)回転
                    if self.edit_opt == EditOption['+']:
                        value = sc.sample51_rotation
                    # 負方向に-0.1(ラジアン)回転
                    elif self.edit_opt == EditOption['-']:
                        value = -sc.sample51_rotation
                    # bpy.ops.transform.rotate(): 選択中のオブジェクトを回転する
                    # 引数
                    #   value: 回転量
                    #   orient_axis: 回転軸
                    bpy.ops.transform.rotate(value=value, orient_axis=axis)

        return {'RUNNING_MODAL'}

    def invoke(self, context, event):
        op_cls = SAMPLE51_OT_SpecialObjectEditMode

        if context.area.type == 'VIEW_3D':
            # 開始ボタンが押された時の処理
            if not self.is_running():
                op_cls.__running = True
                context.window_manager.modal_handler_add(self)
                print("サンプル 5-1: 特殊オブジェクト編集モードを開始しました。")
                return {'RUNNING_MODAL'}
            # 終了ボタンが押された時の処理
            else:
                op_cls.__running = False
                return {'FINISHED'}
        else:
            return {'CANCELLED'}


# UI
class SAMPLE51_PT_SpecialObjectEditMode(bpy.types.Panel):

    bl_label = "特殊オブジェクト編集モード"
    bl_space_type = 'VIEW_3D'
    bl_region_type = 'UI'
    bl_category = "サンプル 5-1"
    bl_context = "objectmode"

    @classmethod
    def poll(cls, context):
        # オブジェクトが選択されている時のみ表示
        for o in bpy.data.objects:
            if o.type == 'MESH' and o.select_get():
                return True
        return False

    def draw(self, context):
        op_cls = SAMPLE51_OT_SpecialObjectEditMode

        sc = context.scene
        layout = self.layout

        # [開始] / [停止] ボタンを追加
        if not op_cls.is_running():
            layout.operator(
                SAMPLE51_OT_SpecialObjectEditMode.bl_idname, text="開始", icon="PLAY"
            )
        else:
            layout.operator(
                SAMPLE51_OT_SpecialObjectEditMode.bl_idname, text="終了", icon="PAUSE"
            )
            layout.prop(sc, "sample51_movement", text="移動量")
            layout.prop(sc, "sample51_magnification", text="拡大率")
            layout.prop(sc, "sample51_reduction", text="縮小率")
            layout.prop(sc, "sample51_rotation", text="回転量")


def key_pref_list(self, context):
    # キーの識別子
    key_id = [
        'ZERO', 'ONE', 'TWO', 'THREE', 'FOUR', 'FIVE', 'SIX', 'SEVEN', 'EIGHT',
        'NINE', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L',
        'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z',
        'LEFT_CTRL', 'LEFT_ALT', 'LEFT_SHIFT', 'RIGHT_ALT', 'RIGHT_CTRL',
        'RIGHT_SHIFT', 'TAB', 'SPACE', 'BACK_SPACE', 'DEL', 'SEMI_COLON',
        'PERIOD', 'COMMA', 'QUOTE', 'MINUS', 'SLASH', 'BACK_SLASH', 'EQUAL',
        'LEFT_ARROW', 'DOWN_ARROW', 'RIGHT_ARROW', 'UP_ARROW'
    ]
    # 表示文字列(説明文を兼ねる)
    key_name = [
        "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "A", "B", "[C]",
        "[D]", "E", "F", "G", "H", "I", "J", "K", "L", "M", "[N]", "O", "P",
        "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", "[Left Ctrl]",
        "[Left Alt]", "[Left Shift]", "[Right Alt]", "[Right Ctrl]",
        "[Right Shift]", "[Tab]", "[Space]", "[Back Space]", "[Delete]", "[;]",
        "[.]", "[,]", "[`]", "[-]", "[/]", "[¥]", "[=]", "←", "↓", "→", "↑"
    ]

    return [
        (id, name, name, i)
        for i, (name, id) in enumerate(zip(key_name, key_id))
    ]


# 登録済みのキーを取得
def get_reserved_key_list(self):
    list_ = []

    list_.append(get_pref_translate(self))
    list_.append(get_pref_scale(self))
    list_.append(get_pref_rotate(self))
    list_.append(get_pref_x_axis(self))
    list_.append(get_pref_y_axis(self))
    list_.append(get_pref_z_axis(self))
    list_.append(get_pref_increment(self))
    list_.append(get_pref_decrement(self))

    return list_


# プリファレンスの設定情報 [移動] の値を取得
def get_pref_translate(self):
    key_list = key_pref_list(self, None)
    return self.get(
        'translate',
        [key[3] for key in key_list if key[0] == 'T'][0]
    )


# プリファレンスの設定情報 [移動] の値を設定
def set_pref_translate(self, value):
    reserved = get_reserved_key_list(self)
    # 他の操作にキーが割り当たっている場合は、値を設定しない
    if value not in reserved:
        self['translate'] = value


# プリファレンスの設定情報 [拡大縮小] の値を取得
def get_pref_scale(self):
    key_list = key_pref_list(self, None)
    return self.get(
        'scale',
        [key[3] for key in key_list if key[0] == 'S'][0]
    )


# プリファレンスの設定情報 [拡大縮小] の値を設定
def set_pref_scale(self, value):
    reserved = get_reserved_key_list(self)
    if value not in reserved:
        self['scale'] = value


# プリファレンスの設定情報 [回転] の値を取得
def get_pref_rotate(self):
    key_list = key_pref_list(self, None)
    return self.get(
        'rotate', [key[3] for key in key_list if key[0] == 'R'][0]
    )


# プリファレンスの設定情報 [回転] の値を設定
def set_pref_rotate(self, value):
    reserved = get_reserved_key_list(self)
    if value not in reserved:
        self['rotate'] = value


# プリファレンスの設定情報 [X軸] の値を取得
def get_pref_x_axis(self):
    key_list = key_pref_list(self, None)
    return self.get(
        'x_axis', [key[3] for key in key_list if key[0] == 'X'][0]
    )


# プリファレンスの設定情報 [X軸] の値を設定
def set_pref_x_axis(self, value):
    reserved = get_reserved_key_list(self)
    if value not in reserved:
        self['x_axis'] = value


# プリファレンスの設定情報 [Y軸] の値を取得
def get_pref_y_axis(self):
    key_list = key_pref_list(self, None)
    return self.get('y_axis', [key[3] for key in key_list if key[0] == 'Y'][0])


# プリファレンスの設定情報 [Y軸] の値を設定
def set_pref_y_axis(self, value):
    reserved = get_reserved_key_list(self)
    if value not in reserved:
        self['y_axis'] = value


# プリファレンスの設定情報 [Z軸] の値を取得
def get_pref_z_axis(self):
    key_list = key_pref_list(self, None)
    return self.get('z_axis', [key[3] for key in key_list if key[0] == 'Z'][0])


# プリファレンスの設定情報 [Z軸] の値を設定
def set_pref_z_axis(self, value):
    reserved = get_reserved_key_list(self)
    if value not in reserved:
        self['z_axis'] = value


# プリファレンスの設定情報 [+] の値を取得
def get_pref_increment(self):
    key_list = key_pref_list(self, None)
    return self.get(
        'increment', [key[3] for key in key_list if key[0] == 'RIGHT_ARROW'][0]
    )


# プリファレンスの設定情報 [+] の値を設定
def set_pref_increment(self, value):
    reserved = get_reserved_key_list(self)
    if value not in reserved:
        self['increment'] = value


# プリファレンスの設定情報 [-] の値を取得
def get_pref_decrement(self):
    key_list = key_pref_list(self, None)
    return self.get(
        'decrement', [key[3] for key in key_list if key[0] == 'LEFT_ARROW'][0]
    )


# プリファレンスの設定情報 [-] の値を設定
def set_pref_decrement(self, value):
    reserved = get_reserved_key_list(self)
    if value not in reserved:
        self['decrement'] = value


# プリファレンスのアドオン設定情報
class SAMPLE51_Preferences(bpy.types.AddonPreferences):

    bl_idname = __name__

    translate: EnumProperty(
        name="Translate",
        description="並進移動の処理を行うキー",
        items=key_pref_list,
        get=get_pref_translate,
        set=set_pref_translate
    )
    scale: EnumProperty(
        name="Scale",
        description="拡大・縮小の処理を行うキー",
        items=key_pref_list,
        get=get_pref_scale,
        set=set_pref_scale
    )
    rotate: EnumProperty(
        name="Rotate",
        description="回転の処理を行うキー",
        items=key_pref_list,
        get=get_pref_rotate,
        set=set_pref_rotate
    )
    x_axis: EnumProperty(
        name="X軸",
        description="X軸に関する処理を行うキー",
        items=key_pref_list,
        get=get_pref_x_axis,
        set=set_pref_x_axis
    )
    y_axis: EnumProperty(
        name="Y軸",
        description="Y軸に関する処理を行うキー",
        items=key_pref_list,
        get=get_pref_y_axis,
        set=set_pref_y_axis
    )
    z_axis: EnumProperty(
        name="Z軸",
        description="Z軸に関する処理を行うキー",
        items=key_pref_list,
        get=get_pref_z_axis,
        set=set_pref_z_axis
    )
    increment: EnumProperty(
        name="+",
        description="インクリメント方向の操作を行うキー",
        items=key_pref_list,
        get=get_pref_increment,
        set=set_pref_increment
    )
    decrement: EnumProperty(
        name="-",
        description="デクリメント方向の操作を行うキー",
        items=key_pref_list,
        get=get_pref_decrement,
        set=set_pref_decrement
    )

    def draw(self, context):
        layout = self.layout

        layout.label(text="キー割り当て: ")
        row = layout.row()
        col = row.column()
        col.prop(self, "translate")
        col.prop(self, "scale")
        col.prop(self, "rotate")
        col = row.column()
        col.prop(self, "x_axis")
        col.prop(self, "y_axis")
        col.prop(self, "z_axis")
        col = row.column()
        col.prop(self, "increment")
        col.prop(self, "decrement")


def init_props():
    sc = bpy.types.Scene

    # プロパティパネル上での設定情報
    sc.sample51_movement = FloatProperty(
        name="移動量",
        description="移動量",
        default=1.0,
        max=5.0,
        min=0.01
    )
    sc.sample51_magnification = FloatProperty(
        name="拡大率",
        description="拡大率",
        default=1.1,
        max=10.0,
        min=1.0
    )
    sc.sample51_reduction = FloatProperty(
        name="縮小率",
        description="縮小率",
        default=0.9,
        max=1.0,
        min=0.01
    )
    sc.sample51_rotation = FloatProperty(
        name="回転量",
        description="回転量",
        default=0.1,
        max=2.0,
        min=0.01
    )


def clear_props():
    sc = bpy.types.Scene

    del sc.sample51_rotation
    del sc.sample51_magnification
    del sc.sample51_reduction
    del sc.sample51_movement


classes = [
    SAMPLE51_OT_SpecialObjectEditMode,
    SAMPLE51_PT_SpecialObjectEditMode,
    SAMPLE51_Preferences,
]


def register():
    for c in classes:
        bpy.utils.register_class(c)
    init_props()
    print("サンプル 5-1: アドオン『サンプル 5-1』が有効化されました。")


def unregister():
    clear_props()
    for c in classes:
        bpy.utils.unregister_class(c)
    print("サンプル 5-1: アドオン『サンプル 5-1』が無効化されました。")


if __name__ == "__main__":
    register()

関連する内容

アドオンの仕様

キー 処理
[T] + [X] + [→] X軸正方向に平行移動
[T] + [X] + [←] X軸負方向に平行移動
[T] + [Y] + [→] Y軸正方向に平行移動
[T] + [Y] + [←] Y軸負方向に平行移動
[T] + [Z] + [→] Z軸正方向に平行移動
[T] + [Z] + [←] Z軸負方向に平行移動
[S] + [X] + [→] X軸方向に拡大
[S] + [X] + [←] X軸方向に縮小
[S] + [Y] + [→] Y軸方向に拡大
[S] + [Y] + [←] Y軸方向に縮小
[S] + [Z] + [→] Z軸方向に拡大
[S] + [Z] + [←] Z軸方向に縮小
[R] + [X] + [→] X軸周りの正方向に回転
[R] + [X] + [←] X軸周りの負方向に回転
[R] + [Y] + [→] Y軸周りの正方向に回転
[R] + [Y] + [←] Y軸周りの負方向に回転
[R] + [Z] + [→] Z軸周りの正方向に回転
[R] + [Z] + [←] Z軸周りの負方向に回転

アドオンの機能を使用する

1 プリファンレンスのアドオンの設定から、特殊オブジェクト編集モード時の処理に割り当てるキーを変更します。
2 [3Dビューポート] スペースのSidebarから、[サンプル 5-1] > [特殊オブジェクト編集モード] > [開始] ボタンをクリックします。
3 1で割り当てたキーを押し、特殊オブジェクト編集モード中にキーに割り当てた処理が実行されることを確認します。
4 パネル [サンプル 5-1] > [特殊オブジェクト編集モード] から、各処理の移動量・拡大率・縮小率・回転量を指定できます。
5 パネル [サンプル 5-1] > [特殊オブジェクト編集モード] に配置されている [終了] ボタンを押すと、特殊オブジェクト編集モードを終了します。