MRが楽しい

MRやVRについて学習したことを書き残す

Blender2.8で利用可能なpythonスクリプトを作る その45(カーブオブジェクトの長さ)

本日は Blender の技術調査枠です。
Blender2.8で利用可能なpythonスクリプトを作ります。

カーブオブジェクトの長さ

カーブオブジェクトの長さを計算します。
複製したカーブオブジェクトをメッシュオブジェクトに変換して計算を行います。
メッシュオブジェクトは自動で削除されます。
・get_length_curve.py

# bpyインポート
import bpy

# 指定カーブオブジェクトの長さを取得する
def get_length_curve(arg_objectname="Default") -> float:
    """カーブオブジェクトの長さを計算する

    Args:
        arg_objectname (str, optional): 指定オブジェクト名. Defaults to "Default".

    Returns:
        float: カーブオブジェクトの長さ
    """

    # 指定オブジェクトを取得する
    # (get関数は対象が存在しない場合 None が返る)
    selectob = bpy.data.objects.get(arg_objectname)

    # 指定オブジェクトが存在するか確認する
    if selectob == None:
        # 指定オブジェクトが存在しない場合は処理しない
        return False
        
    # オブジェクトがカーブであるか確認する
    if selectob.type != 'CURVE':
        # 指定オブジェクトがカーブでない場合は処理しない
        return False
    
    # 全てのオブジェクトを走査する
    for ob in bpy.context.scene.objects:
        # 非選択状態に設定する
        ob.select_set(False)
    
    # 指定オブジェクトを選択状態に変更する
    selectob.select_set(True)

    # オブジェクトを複製する
    bpy.ops.object.duplicate_move()

    # 複製オブジェクトを取得する
    duplicatob = bpy.context.scene.objects[-1]
    
    # 指定オブジェクトを選択状態に変更する
    selectob.select_set(False)

    # 指定オブジェクトを選択状態に変更する
    duplicatob.select_set(True)

    # カーブオブジェクトをメッシュオブジェクトに変換する
    bpy.ops.object.convert(target='MESH')

    # メッシュ情報を再取得する
    mesh = duplicatob.data

    # 辺情報を取得する
    edges = mesh.edges.values()

    # 頂点情報を取得する
    vertices = mesh.vertices.values()

    # 辺の長さの変数を初期化する
    curve_lenght = 0.0

    for edge in edges:
        # 辺の開始と終端の頂点を取得する
        vert_start, vert_end = edge.vertices

        # 辺の長さを計算する
        edge_length = (vertices[vert_start].co - vertices[vert_end].co).length

        # カーブ全体の長さに辺の長さを加算する
        curve_lenght = curve_lenght + edge_length

    # 複製オブジェクトを削除する
    bpy.data.objects.remove(duplicatob)

    return curve_lenght

# 関数の実行例
length = get_length_curve(arg_objectname="BezierCurve")
print("Curve_Length : " + str(length))

f:id:bluebirdofoz:20200629185605j:plain

アドオンバージョン

上記スクリプトをアドオン化してみました。
追加されるパネルのオブジェクトリストからカーブオブジェクトを選択し、実行ボタンをクリックします。
すると、数値欄に対象カーブオブジェクトの長さが表示されます。
・Addon_get_length_curve.py

# bl_infoでプラグインに関する情報の定義を行う
bl_info = {
    "name": "HoloMon Curve Check Addon",             # プラグイン名
    "author": "HoloMon",                             # 制作者名
    "version": (1, 0),                               # バージョン
    "blender": (2, 80, 0),                           # 動作可能なBlenderバージョン
    "support": "TESTING",                            # サポートレベル
    "category": "3D View",                           # カテゴリ名
    "location": "View3D > Sidebar > HoloMon",        # ロケーション
    "description": "Addon Curve Check",              # 説明文
    "location": "",                                  # 機能の位置付け
    "warning": "",                                   # 注意点やバグ情報
    "doc_url": "",                                   # ドキュメントURL
}

# 利用するタイプやメソッドのインポート
import bpy
from bpy.types import Operator, Panel, PropertyGroup
from bpy.props import PointerProperty, FloatProperty

# 継承するクラスの命名規則は以下の通り
# [A-Z][A-Z0-9_]*_(継承クラスごとの識別子)_[A-Za-z0-9_]+
# クラスごとの識別子は以下の通り
#   bpy.types.Operator  OT
#   bpy.types.Panel     PT
#   bpy.types.Header    HT
#   bpy.types.MENU      MT
#   bpy.types.UIList    UL

# Panelクラスの作成
# 参考URL:https://docs.blender.org/api/current/bpy.types.Panel.html
class HOLOMON_PT_addon_curve_check(Panel):
    # パネルのラベル名を定義する
    # パネルを折りたたむパネルヘッダーに表示される
    bl_label = "Curve Check Addon Panel"
    # クラスのIDを定義する
    # 命名規則は CATEGORY_PT_name
    bl_idname = "HOLOMON_PT_addon_curve_check"
    # パネルを使用する領域を定義する
    # 利用可能な識別子は以下の通り
    #   EMPTY:無し
    #   VIEW_3D:3Dビューポート
    #   IMAGE_EDITOR:UV/画像エディター
    #   NODE_EDITOR:ノードエディター
    #   SEQUENCE_EDITOR:ビデオシーケンサー
    #   CLIP_EDITOR:ムービークリップエディター
    #   DOPESHEET_EDITOR:ドープシート
    #   GRAPH_EDITOR:グラフエディター
    #   NLA_EDITOR:非線形アニメーション
    #   TEXT_EDITOR:テキストエディター
    #   CONSOLE:Pythonコンソール
    #   INFO:情報、操作のログ、警告、エラーメッセージ
    #   TOPBAR:トップバー
    #   STATUSBAR:ステータスバー
    #   OUTLINER:アウトライナ
    #   PROPERTIES:プロパティ
    #   FILE_BROWSER:ファイルブラウザ
    #   PREFERENCES:設定
    bl_space_type = 'VIEW_3D'
    # パネルが使用される領域を定義する
    # 利用可能な識別子は以下の通り
    # ['WINDOW'、 'HEADER'、 'CHANNELS'、 'TEMPORARY'、 'UI'、
    #  'TOOLS'、 'TOOL_PROPS'、 'PREVIEW'、 'HUD'、 'NAVIGATION_BAR'、
    #  'EXECUTE'、 'FOOTER'の列挙型、 'TOOL_HEADER']
    bl_region_type = 'UI'
    # パネルタイプのオプションを定義する
    # DEFAULT_CLOSED:作成時にパネルを開くか折りたたむ必要があるかを定義する。
    # HIDE_HEADER:ヘッダーを非表示するかを定義する。Falseに設定するとパネルにはヘッダーが表示される。
    # デフォルトは {'DEFAULT_CLOSED'}
    bl_options = {'DEFAULT_CLOSED'}
    # パネルの表示順番を定義する
    # 小さい番号のパネルは、大きい番号のパネルの前にデフォルトで順序付けられる
    # デフォルトは 0
    bl_order = 0
    # パネルのカテゴリ名称を定義する
    # 3Dビューポートの場合、サイドバーの名称になる
    # デフォルトは名称無し
    bl_category = "HoloMon"
 
    # 描画の定義
    def draw(self, context):
        # Operatorをボタンとして配置する
        draw_layout = self.layout
        # 要素行を作成する
        select_row = draw_layout.row()
        # オブジェクト選択用のカスタムプロパティを配置する
        select_row.prop(context.scene.holomon_curvecheck, "prop_objectslect", text='')
        # 要素行を作成する
        length_row = draw_layout.row()
        # カーブオブジェクトの長さ表示用のカスタムプロパティを配置する
        length_row.prop(context.scene.holomon_curvecheck, "prop_curvelength")
        # 操作を無効化しておく
        length_row.enabled = False
        # 要素行を作成する
        button_row = draw_layout.row()
        # オブジェクト指定のサイズ縮小を実行するボタンを配置する
        button_row.operator("holomon.curvecheck")

# Operatorクラスの作成
# 参考URL:https://docs.blender.org/api/current/bpy.types.Operator.html
class HOLOMON_OT_addon_curve_check(Operator):
    # クラスのIDを定義する
    # (Blender内部で参照する際のIDに利用)
    bl_idname = "holomon.curvecheck"
    # クラスのラベルを定義する
    # (デフォルトのテキスト表示などに利用)
    bl_label = "CURVE CHECK"
    # クラスの説明文
    # (マウスオーバー時に表示)
    dl_description = "Curve Check Addon Description"
    # クラスの属性
    # 以下の属性を設定できる
    #   REGISTER      : Operatorを情報ウィンドウに表示し、やり直しツールバーパネルをサポートする
    #   UNDO          : 元に戻すイベントをプッシュする(Operatorのやり直しに必要)
    #   UNDO_GROUPED  : Operatorの繰り返しインスタンスに対して単一の取り消しイベントをプッシュする
    #   BLOCKING      : 他の操作がマウスポインタ―を使用できないようにブロックする
    #   MACRO         : Operatorがマクロであるかどうかを確認するために使用する
    #   GRAB_CURSOR   : 継続的な操作が有効な場合にオペレーターがマウスポインターの動きを参照して、操作を有効にする
    #   GRAB_CURSOR_X : マウスポインターのX軸の動きのみを参照する
    #   GRAB_CURSOR_Y : マウスポインターのY軸の動きのみを参照する
    #   PRESET        : Operator設定を含むプリセットボタンを表示する
    #   INTERNAL      : 検索結果からOperatorを削除する
    # 参考URL:https://docs.blender.org/api/current/bpy.types.Operator.html#bpy.types.Operator.bl_options
    bl_options = {'REGISTER', 'UNDO'}


    # Operator実行時の処理
    def execute(self, context):
        # カスタムプロパティから指定中のオブジェクトを取得する
        target_obj = context.scene.holomon_curvecheck.prop_objectslect

        # 指定中のオブジェクトを確認する
        if target_obj == None:
            # オブジェクトが指定されていない場合はエラーメッセージを表示する
            self.report({'ERROR'}, "No objects selected.")
            return {'CANCELLED'}

        # 指定のカーブオブジェクトの長さを取得する
        length = get_length_curve(arg_selectobj=target_obj)

        # カスタムプロパティにカーブの長さを設定する
        context.scene.holomon_curvecheck.prop_curvelength = length

        return {'FINISHED'}

# PropertyGroupクラスの作成
# 参考URL:https://docs.blender.org/api/current/bpy.types.PropertyGroup.html
class HOLOMON_addon_curve_check_properties(PropertyGroup):
    # オブジェクト選択時のチェック関数を定義する
    def prop_object_select_poll(self, context, ):
        # カーブオブジェクトのみ選択可能
        if(context and context.type in ('CURVE', )):
            return True
        return False

    # シーン上のパネルに表示するオブジェクト選択用のカスタムプロパティを定義する
    prop_objectslect: PointerProperty(
        name = "Select Object",         # プロパティ名
        type = bpy.types.Object,        # タイプ
        description = "",               # 説明文
        poll = prop_object_select_poll, # チェック関数
    )

    # シーン上のパネルに表示するオブジェクト選択用のカスタムプロパティを定義する
    prop_curvelength: FloatProperty(
        name = "Curve Length",         # プロパティ名
        description = "",               # 説明文
    )


# 登録に関する処理
# 登録対象のクラス名
regist_classes = (
    HOLOMON_PT_addon_curve_check,
    HOLOMON_OT_addon_curve_check,
    HOLOMON_addon_curve_check_properties,
)

# 作成クラスと定義の登録メソッド
def register():
    # カスタムクラスを登録する
    for regist_cls in regist_classes:
        bpy.utils.register_class(regist_cls)
    # シーン情報にカスタムプロパティを登録する
    bpy.types.Scene.holomon_curvecheck = PointerProperty(type=HOLOMON_addon_curve_check_properties)

# 作成クラスと定義の登録解除メソッド
def unregister():
    # シーン情報のカスタムプロパティを削除する
    del bpy.types.Scene.holomon_curvecheck
    # カスタムクラスを解除する
    for regist_cls in regist_classes:
        bpy.utils.unregister_class(regist_cls)


# 指定カーブオブジェクトの長さを取得する
def get_length_curve(arg_selectobj: bpy.types.Object) -> float:
    """カーブオブジェクトの長さを計算する

    Args:
        arg_selectobj (bpy.types.Object): 指定オブジェクト

    Returns:
        float: カーブオブジェクトの長さ
    """

    # 指定オブジェクトが存在するか確認する
    if arg_selectobj == None:
        # 指定オブジェクトが存在しない場合は処理しない
        return False
        
    # オブジェクトがカーブであるか確認する
    if arg_selectobj.type != 'CURVE':
        # 指定オブジェクトがカーブでない場合は処理しない
        return False
    
    # 全てのオブジェクトを走査する
    for ob in bpy.context.scene.objects:
        # 非選択状態に設定する
        ob.select_set(False)
    
    # 指定オブジェクトを選択状態に変更する
    arg_selectobj.select_set(True)

    # オブジェクトを複製する
    bpy.ops.object.duplicate_move()

    # 複製オブジェクトを取得する
    duplicatob = bpy.context.scene.objects[-1]
    
    # 指定オブジェクトを選択状態に変更する
    arg_selectobj.select_set(False)

    # 指定オブジェクトを選択状態に変更する
    duplicatob.select_set(True)

    # カーブオブジェクトをメッシュオブジェクトに変換する
    bpy.ops.object.convert(target='MESH')

    # メッシュ情報を再取得する
    mesh = duplicatob.data

    # 辺情報を取得する
    edges = mesh.edges.values()

    # 頂点情報を取得する
    vertices = mesh.vertices.values()

    # 辺の長さの変数を初期化する
    curve_lenght = 0.0

    for edge in edges:
        # 辺の開始と終端の頂点を取得する
        vert_start, vert_end = edge.vertices

        # 辺の長さを計算する
        edge_length = (vertices[vert_start].co - vertices[vert_end].co).length

        # カーブ全体の長さに辺の長さを加算する
        curve_lenght = curve_lenght + edge_length

    # 複製オブジェクトを削除する
    bpy.data.objects.remove(duplicatob)

    return curve_lenght


# 実行時の処理
if __name__ == "__main__":
    # 作成クラスと定義を登録する
    register()

f:id:bluebirdofoz:20200629185550j:plain