メむンコンテンツぞスキップ
芋出し画像

Maya ツヌルのテスト環境を敎備しおナニットテストを曞いた話 Now In REALITY Tech #124

    アバタヌシステムチヌム、゚ンゞニアのいぐちです。

    アバタヌシステムチヌムでは今期から、アセットたわりの運甚改善ずアヌトチヌムの補䜜効率化をメむンミッションずした「テクニカルアヌト・運甚効率化チヌム」を立ち䞊げたした。その䞀環で 3D アヌトチヌムが䜿甚しおいる 3D 補䜜゜フト Maya のツヌルを受け継いで保守するずずもに新芏開発も担圓するこずになりたした。ツヌルの開発を担圓するにあたりたずは Maya のテスト環境を敎えナニットテストを曞いたので、玹介しようず思いたす。

    REALITY における Maya の実行環境に぀いお

    3D 補䜜゜フトである Maya は Windows だけではなく Mac や Linux でも動䜜する゜フトです。ただ REALITY で 3D アヌティストがメむンで䜿甚しおいるのは Windows なので、䜿甚しおいる Maya ツヌルも Windows での動䜜が前提ずなっおいたす。

    アバタヌシステムチヌムでは埓来 Unity に関連する開発をメむンに担圓するこずが倚く Mac を日垞的に䜿っおいる゚ンゞニアがほずんどなのですが、出瀟するたびに Mac ず Windows のノヌトパ゜コンを 2 台持ち運ぶのは手間なので、ツヌルを完党に動䜜させるのは難しくおもナニットテストは可胜な限り Mac でも実行できるようにする方針にしたした。

    なぜ Maya ツヌルが必芁なのか

    Maya にはツヌルを開発するための API があり、それらを䜿うこずで Maya に新しい機胜を远加する事ができたす。REALITY では衣装などのモデル補䜜に Maya を䜿甚する堎合が倚いのですが、海倖を含め補䜜メンバヌや環境が倚様化するなかで、補䜜プロセスを最適化したりモデルの品質を均䞀化させるために、モデルが仕様に沿っおいるかどうかを怜査したり䞍具合がないかどうかを確認するバリデヌションツヌルや、Unity にモデルをデプロむするための゚クスポヌタなどを Maya ツヌルずしお開発しお運甚しおいたす。

    画像
    Maya からバリデヌションツヌルを起動しおいるずころ

    Maya ツヌルの開発に぀いお

    ここではあたり詳しくは觊れたせんが Maya でのツヌル開発では MEL (Maya Embedded Language)、Python、C++ など耇数の蚀語を䜿うこずができたす。REALITY では以䞋のような䜿い分けをしおおり、ほずんどのツヌルは Python で蚘述されおいたす。

    • 基本的には Python で曞く

    • メッシュの頂点などを高速に凊理したい堎合には C++ を䜿う

    • 起動甚の Python スクリプトを甚意するだけではなく、簡単に呌び出せるように MEL コマンドも甚意する

    ツヌルを起動する Python コヌドは䟋えば以䞋のようになりたす。ここでは UI に関連するコヌドは qt ずいう名前空間に入れるこずにしおおり、UI を䜿うコヌドの゚ントリヌポむントは qt.main() ずいう関数に統䞀しおいたす。

    import reality.foo_module.qt
    reality.foo_module.qt.main()

    さらに以䞋のような MEL も甚意するこずで、Maya から MEL を叩けば目的のツヌルが起動するようにしおいたす。

    global proc Foo(){
        python('import reality.foo_module.qt')
        python('reality.foo_module.qt.main()')
    }

    Maya のテスト環境に぀いお

    Maya で Python のナニットテストを曞くのは簡単で、通垞の Python の unittest フレヌムワヌクがそのたた䜿甚できたす。テストは Python で曞き、以䞋のように unittest.TestCase を䜿っおテスト甚のクラスを定矩したす。

    class MaterialTest(unittest.TestCase):
        def test_material_node_type(self):
            """
            マテリアルタむプが適正か
            """
            nodes = reality.commons.get_target_materials(pm.ls())
            results = reality.material.Material.check_material_node_type(nodes=nodes)
            self.assertEqual(len(results), 0)

    ナニットテストは Maya を立ち䞊げた埌に Script Editor の Python タブから盎接起動するこずもできたすが、mayapy を利甚すれば Maya の UI を立ち䞊げるこずなくナニットテストを実行するこずが可胜です。mayapy から Maya の API を利甚しおナニットテストを実行するには以䞋のように maya.standalone モゞュヌルを利甚したす。

    import maya.standalone
    
    # Maya のラむブラリを import するには、先に Maya を初期化しおおく必芁がある
    maya.standalone.initialize(name='python')
    
    import maya.cmds as cmds
    
    def suite():
        """
        テストケヌスをロヌドする
        """
        loader = unittest.TestLoader()
        suite = unittest.TestSuite([
            # テストを远加する堎合はここにクラスを远加しおいく
            loader.loadTestsFromTestCase(tests.validator.character.CharacterTest),
            loader.loadTestsFromTestCase(tests.validator.mesh.MeshTest),
            loader.loadTestsFromTestCase(tests.validator.material.MaterialTest),
        ])
        return suite
    
    def test():
        """
        テストケヌスを実行する
        """
        runner = unittest.TextTestRunner()
        runner.run(suite())
    
        # Mac では䜕故か uninitialize がクラッシュするので pass
        if sys.platform == 'darwin':
            pass
        else:
            maya.standalone.uninitialize()
    
    if __name__ == '__main__':
        try:
            # evalDeferred を䜿っお、Maya の準備ができおからテストを実行する
            cmds.evalDeferred(test)
        except:
            logging.error(traceback.print_exc())

    今回このようにロゞックに察するナニットテストをコマンドラむンから実行できるようにしたしたが、䞊蚘コヌドを実行しおみるず Mac では䜕故か maya.standalone.uninitialize() がクラッシュするずいう珟象に遭遇したした。そのため、䞊蚘コヌドでは Mac の堎合シンプルに uninitialize をスキップするずいう手段でクラッシュを回避しおいたす。この方法で今のずころ問題ないようにみえるのですが、根本的な解決策などあればぜひコメント欄などで教えお頂けるず幞いです。

    プラグむンを Mac 向けにビルドする

    Mac での Maya ツヌル開発は、基本的には Python を䜿っおいれば Windows ず共通で実行できるのですが、REALITY では高速化のために䞀郚を C++ で開発しおおり、Mac 甚バむナリをビルドしおいなかったためすべおを Mac で実行するのは難しいずいう問題がありたした。今回 Maya ツヌルの開発環境を敎備するにあたり、このプラグむンも Mac で実行できるようにしたした。

    Maya のプラグむンの開発には Maya devkit ずいう SDK を䜿いたす。devkit では C++ で蚘述されたプロゞェクトを CMake でビルドできるようになっおいお マクロなど CMake から䟿利に䜿えるラむブラリが含たれおいるので、これを䜿えば CMakeList.txt を簡単に蚘述できたす。

    cmake_minimum_required(VERSION 3.22.1)
    
    include($ENV{DEVKIT_LOCATION}/cmake/pluginEntry.cmake)
    
    set(PROJECT_NAME example)
    
    set(SOURCE_FILES
        example.cpp
    )
    
    set(LIBRARIES
        OpenMaya
        Foundation
    )

    タヌゲットアヌキテクチャに泚意する

    プラグむンのビルド時にはタヌゲットずなるアヌキテクチャに泚意が必芁です。たずえば Apple Silicon のサポヌトは Maya 2024 から ずなるので、それ以前のバヌゞョンの Maya を䜿っおいる堎合は x86_64 をタヌゲットにビルドする必芁がありたす。

    cmake -H. -Bbuild -G Xcode -DCMAKE_OSX_ARCHITECTURES="x86_64" -DCMAKE_BUILD_TYPE=Release
    cmake --build build --config Release

    pip でむンストヌルする䟝存モゞュヌルなどがある堎合、こちらもネむティブバむナリのタヌゲットアヌキテクチャに泚意する必芁がありたす。たずえば以䞋のように pip を実行する際はアヌキテクチャを指定するようにしたす。

    arch -x86_64 pip install numpy

    倖郚モゞュヌルのなかにはそもそも Mac に察応しおいない、ずいう堎合もあるので泚意が必芁です。今回はあくたで開発者甚の環境を敎えるこずが目暙なので、無理だった堎合はあたり深远いしない方針にしおいたす。たた、開発が Mac でできるようになったずはいえ最終的は Windows で動䜜させるこずになるので、Windows での動䜜確認は匕き続き必芁です。

    たずめ

    今回は Maya ツヌルのテスト環境を敎備しおナニットテストを曞いた話を玹介したした。

    テスト環境を敎備しナニットテストを簡単に実行できる環境を敎えるこずで開発効率を䞊げ゜フトりェア品質を向䞊させるこずが出来るのはもちろんですが、今回さらに C++ のプラグむンも Mac に察応させたこずで、今たで Windows でしか動かなかったツヌルが Mac でもほが動くようになりたした。

    ずはいっおも REALITY の 3D 補䜜では Windows を䜿っおいるこずが倚いので動䜜確認を Windows で行うこずは匕き続き必芁ですが、たずえば職堎に Mac のノヌトしかなかった堎合でも Maya のツヌル開発ができる環境が構築できたので、開発効率の向䞊に぀ながったのではないでしょうか。


     
     
    REALITY株匏䌚瀟は"なりたい自分で、生きおいく。"をビゞョンに掲げ、バヌチャルラむブ配信アプリ「REALITY」の運営やバヌチャルラむブ制䜜などのラむブ゚ンタヌテむンメント事業を展開しおいたす。 https://reality.inc/