Importomatic ノードで XML ファイル経由でアセットを読み込むことができたので、もう少し複雑なシーンも構築してみます。

使用するネタは CGWorld.jp の記事で使用したシーンです。この時は USD 形式でき出力しましたが、やることはまあ同じなので何となくパラメータを読み替えつつ XML ファイルで出力するようにします。

xml_tmpl = r'''
<scenegraphXml name="Zombie_OnFire" version="0.1.0">
  <!-- channelData startFrame="1" endFrame="10" 
      ref="/tmp/myChannelData" / -->
  <instanceList>
    %s
  </instanceList>
</scenegraphXml>
'''

instance_tmpl = r'''
    <instance type="reference" name="%(name)s" refType="abc" refFile="%(path)s">
      <xform value="%(xform)s"/>
    </instance>
'''

import maya.cmds as cmds

nodes = []
for r in cmds.ls(type='reference'):
    if r == 'sharedReferenceNode':
        continue

    fn = cmds.referenceQuery(r, filename=True)
    ns = cmds.referenceQuery(r, namespace=True)[1:]
    path = cmds.referenceQuery(r, filename=True, withoutCopyNumber=True)
    root = cmds.ls('%s:*_root' % ns)
    xform = cmds.getAttr('%s.worldMatrix' % root[0])
    nodes.append(instance_tmpl % {'name' : ns,
                                  'path' : path,
                                  'xform' : str(xform)[1:-1]})

fp = open(r'/home/chiyama/Documents/katanta/scene_build/layout.xml', 'w')
fp.write(xml_tmpl % '\n'.join(nodes))
fp.close()

このようにして出力したファイルを KATANA で読むと、Maya 上でレイアウトしたシーンを再現することができました。

※そのままでは見た目がよくわからなかったので、全てのオブジェクトにグレーなマテリアルを割り当てています

昨日はアセット用 .abc ファイルと、それに使用する .klf ファイルを一つづつ選んでシーンを構築してみました。

が。

そんなことを実際のシーンでやっていたらめんどくさくて禿げちゃいます。アセット100個、名前を指定しながら読み込むとか無理デスヨネー。
しかも、Maya など前段階の作業でアセットの読み込みはしているため、どのアセットが必要なのか既にわかっているはずです。その情報をそのまま使いたいというのが人情です。

そんな時には XML ファイルを使用して Importomatic ノードでアセットを読み込むことができます。

まず、シーン構築用の XML ファイルを用意します。

<scenegraphXml name="Zombie_OnFire" version="0.1.0">
  <instanceList>
    <instance type="reference" name="zombie" refType="abc"
              refFile="/home/chiyama/Documents/katanta/scene_build/Zombie_OnFire_2B.abc">
      <xform value="1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1"/>
      <lookFile ref="/home/chiyama/Documents/katanta/scene_build/zombie_on_fire.klf" />
    </instance>
  </instanceList>
</scenegraphXml>

そして、これを Importomatic ノードで読み込みます。

無事にアセットは読み込まれたのですが、マテリアルがついてきていません。これは Scene Graph の階層構造が変わってしまってるためでしょう。この辺りは何度か手戻りを繰り返しながら良い感じになるように Lookdev 用ファイルを作り直したり XML ファイルをみなおして調整する必要があります。

まだちょっと調整が必要ではあるものの、これでレイアウトやアニメーションの時に作成した情報を元にアセットを集めてシーンを構築するためのメドがついたことになります。

ショットシーン構築のためにアセットを読み込む方法を試行錯誤していたところ、KATANA 警察の方から Importomatic というのがあるよッ!!というのを教えていただきました。どうやらこのノードをパイプラインに合わせてゴリゴリいじれば良さそうです。

ということで複数の .abc ファイルを読んでみました。

なるほどこれは簡単。そして、Look File のアサインもここでおこなうことができるようです。

アセットの読み込みと Look File のアサインの方法がわかったのでやってみます。

。。。。と、その前に。Importomatic を使用してシーンを構築する場合、Look File 作成時にも Importomatic を使用してアセットを読み込んでおいた方が良いようです。もしかしたら、ちゃんとやれば Alembic_In で読んでいてもいいのかもしれないですが私のケースでは Importomatic で読んだアセットに対して Look File を作らないとマテリアルが再現されませんでした。Attribute も確認したのですが、違いを見つけることができなかったので何故こうしなければいけないのかは謎です。

このようにして作成した .klf ファイルを使ってマテリアルをアサインし、レンダリングしてみました。無事に再現されています。

※エイヤッと記事にはしたものの、どうもこの方法でショットシーンを作ることは無さそうです。まあテクニックの一つとしてこんなこともできるんだ的な感じということで;;;

ショットシーンを構築する際、一つ一つ手でアセット読み込み用のノードグラフを作ってファイルを読んで。。。とやっていたら大変すぎます。そこで、アセット読み込み用のテンプレートを用意し、スクリプトを使ってアセットの読み込みをできるようにします。

KATANA の場合、Alembic ファイルを読み込んだり LookFile をアサインするといった定例処理をノードとして組むので、CG ソフトのように Export Selection と Import や Merge をやる方法では対応できなさそうです。このあたりは 3DCG ツールというよりも Nuke のようなコンポジットソフトに感覚が近いです。

さてどうするかな。。。。と調べていたら、ノードの情報を XML 形式で入出力できるようです。これがきちんと動くなら、使えそうです。

まずは元になるノードグラフを作成します。今回はターンテーブル作成に使用したものを使います。

この、Alembic_In, LookFileAssign, LookFileResolve を使用します。

Python タブで以下のコードを実行すると、/home/chiyama/Documents/katanta/scene_build/template.xml に上記三つのノード情報が格納されたファイルが作成されます。

from Katana import NodegraphAPI
nodes = [NodegraphAPI.GetNode('Alembic_In'),
         NodegraphAPI.GetNode('LookFileAssign'),
         NodegraphAPI.GetNode('LookFileResolve')]

xmlNode = NodegraphAPI.BuildNodesXmlIO(nodes)

fp = open('/home/chiyama/Documents/katanta/scene_build/template.xml', 'w')
fp.write(xmlNode.writeString())
fp.close()

試しにこのファイルをそのまま使ってシーンにノードを作ってみます。空のシーンで

fp = open('/home/chiyama/Documents/katanta/scene_build/template.xml', 'r')
xmlData = fp.read()
fp.close()

xmlNode, result = NodegraphAPI.LoadElementsFromString(xmlData)
newNode = KatanaFile.Paste(xmlNode, NodegraphAPI.GetRootNode())[0]

と実行すると、見事にノードグラフが再現されました。

ここまでくればもう好きにやりたい放題です。

今回は以下のようなテンプレートファイルにしました。

<katana release="3.0v6" version="3.0.1.000002">
  <node name="__SAVE_exportedNodes" type="Group">
    <node baseType="Alembic_In" name="%(NAMESPACE)s_Alembic_In" selected="true" type="Alembic_In" x="413.984309" y="-302.346567">
      <port name="out" type="out"/>
      <group_parameter name="%(NAMESPACE)s_Alembic_In">
        <string_parameter name="name" useNodeDefault="false" value="/root/world/geo/%(NAMESPACE)s"/>
        <string_parameter name="abcAsset" useNodeDefault="false" value="%(ABC_FILE)s"/>
        <number_parameter name="addForceExpand" value="1"/>
        <string_parameter name="addBounds" value="root"/>
        <number_parameter name="fps" value="24"/>
        <number_parameter name="addToCameraList" value="0"/>
        <group_parameter name="timing">
          <string_parameter name="mode" value="Current Frame"/>
          <number_parameter expression="globals.inTime" isexpression="true" name="holdTime"/>
          <number_parameter expression="globals.inTime" isexpression="true" name="inTime"/>
          <number_parameter expression="globals.outTime" isexpression="true" name="outTime"/>
        </group_parameter>
        <group_parameter name="advanced">
          <number_parameter name="useOnlyShutterOpenCloseTimes" value="0"/>
        </group_parameter>
      </group_parameter>
    </node>
    <node baseType="GenericAssign" name="%(NAMESPACE)s_LookFileAssign" selected="true" type="LookFileAssign" x="413.084537" y="-370.293177">
      <port name="input" source="%(NAMESPACE)s_Alembic_In.out" type="in"/>
      <port name="out" type="out"/>
      <group_parameter name="LookFileAssign">
        <string_parameter name="CEL" value="(/root/world/geo/%(NAMESPACE)s)"/>
        <string_parameter name="location" value=""/>
        <group_parameter name="args">
          <group_parameter name="lookfile">
            <group_parameter name="asset">
              <number_parameter name="enable" value="1"/>
              <string_parameter name="value" value="%(KLF_FILE)s"/>
              <string_parameter name="default" value=""/>
              <string_parameter name="type" value="StringAttr"/>
            </group_parameter>
          </group_parameter>
        </group_parameter>
      </group_parameter>
    </node>
    <node baseType="LookFileResolve" name="%(NAMESPACE)s_LookFileResolve" selected="true" type="LookFileResolve" x="413.084529" y="-420.346567">
      <port name="A" source="%(NAMESPACE)s_LookFileAssign.out" type="in"/>
      <port name="out" type="out"/>
      <group_parameter name="LookFileResolve">
        <string_parameter name="passName" value=""/>
      </group_parameter>
    </node>
  </node>
</katana>

そして、以下のコードを実行します。

fp = open('/home/chiyama/Documents/katanta/scene_build/template.xml', 'r')
xmlTemplate = fp.read()
fp.close()

xmlData = xmlTemplate % {'NAMESPACE' : 'foobar',
                         'ABC_FILE' : '/home/chiyama/Documents/usdtest/assets/Zombie_OnFire_2B.abc',
                         'KLF_FILE' : '/home/chiyama/Documents/katanta/lookdev/zombie_on_fire.klf'}

xmlNode, result = NodegraphAPI.LoadElementsFromString(xmlData)
newNode = KatanaFile.Paste(xmlNode, NodegraphAPI.GetRootNode())[0]

できたノードグラフはこちら。

これで、ネームスペースと .abc ファイル、.klf ファイルを指定してアセットを読み込むことができるようになりました。これを使えば Katana 上でショットシーンを自動生成することはできそうです(これが一般的な方法かはわからないのですが)。

MaterialAssign から MaterialResolve をして OpScript でアトリビュートを上書きする流れが、KATANA の内部を理解する上でとても良い事例になりそうなので詳細を順を追って解説します。

まず最初に、Merge でオブジェクト用ツリーとマテリアル用ツリーを一つにまとめます。この時、オブジェクトにはマテリアル情報はまだ何も登録されていません。

materialAssign というアトリビュートはあるものの、空になっています。

ここで、MaterialAssign を用いて pCylinderShape1 にマテリアルを割り当てると materialAssign アトリビュートに値がセットされます。

次に MaterialResolve ノードを通すと、オブジェクトに material アトリビュートが追加され、かわりに materialAssign アトリビュートが空になります。

この時にはマテリアル内の値は元々のマテリアルにあったものそのままです。

最後に OpScript で Alembic に含まれていた値をマテリアルの値にセットします。

ちょっと注意が必要なのが、マテリアル内のシェーダーネットワークのアトリビュートはリアルタイムに更新されず、Refresh ボタンを押すことで最新の情報が更新されることです。KATANA は情報のリアルタイム更新周りはあまり力を入れていないようで、慣れないとたまにオヤッ!?と思うことがあります。ただ、リアルタイム更新周りを充実させるとどんどんアプリケーションが重くなっていき、起動が遅くなったり普段のオペレーションに支障が出てくるようになるので個人的には今の方が好きです。

Maya のリグなどから KATANA にカスタムアトリビュートを渡し、その値によってシェーダのパラメータを変えてみます。これができれば、Maya と KATANA を接続する際の最大の難関が突破できたことになります(多分)。

そして、この方法を調べるのがものすごい大変でした、、、まだまだ KATANA のことを理解してないなぁと痛感します。

まずは、Maya から Alembic データを出力するときにカスタムアトリビュートを追加します。これは簡単で、出力するメッシュにカスタムアトリビュートを追加して値を入れ(もちろんキーフレームアニメーションも可/ベイクはした方がよいでしょう)、Export ダイアログ中で Attributes にカスタムアトリビュート名を追加して出力するだけです。

出力したファイルを KATANA で読んでマテリアルをアサインするところまではこれまでと同じです。

カスタムアトリビュートの値をシェーダーに持っていく前に MaterialResolve でオブジェクトにマテリアル情報を焼き付けておきます。こうすることで、オブジェクトに付加されたアトリビュートとしてシェーダのパラメータにアクセスできるようになります。

その後、OpScript を使用して Alembic のカスタムアトリビュートをマテリアルのパラメータにセットします。この時、既にオブジェクトにマテリアル関連のアトリビュートが追加されているため、この値を操作しているだけということに注目します。

そのようにしてレンダリングしたのが下の画像です。左から base が 0.0, 0.5, 1.0 となっていて、それに合わせて色が変わっています。

リグの情報をジオメトリキャッシュに埋め込んで、その情報を元にシェーダのパラメータを指定したいような場合がよくあります。たとえば皺用ディスプレイスメントとか色を変化させるような場合ですね。

この場合、AttributeSet ノードを使用してアトリビュートを上書きすることで実現できます。

今回はマテリアルの色を上書きしてみます。

AttributeSet ノードを作成した後、パラメータを上書きしたいノード(/root/materials/zombie_Mtl)を指定し、上書きしたいアトリビュートを attributeName で指定します。これは Attributes タブから簡単に探すことができます。

今回は base という float 値なので attributeType を float にし、numberValue は 1×1 で値を 0.0 にします。

すると、元の suaface_shader ノードでは 1.0 を指定して赤色になっていたジオメトリが黒色になりました。
値は他のパラメータと同様アニメーションカーブをアサインできたり、Expression で他のところから値を取得することができるので、好きなところから値を参照することができます。

これまで作ってきたような単純な例ならいいのですが、本番で使おうとするとこの何十倍も複雑なシーンを扱わなければいけなくなります。

そんなときでも Node Graph を整理するための便利ノードが幾つか用意されています。

Backdrop ノード

ノードを処理単位で枠で囲ってコメントを書くことができるノードです。これは通常のノードを作るのと同様、Tab→Backdrop でも作成できますし、囲いたいノードを選択した状態で Edit→Fit Backdrop Node to Selected Nodes でも作成できます。

作成後、ダブルクリックでノードの編集用ダイアログが開き、そこでメッセージや色の指定ができます。

Grouping ノード

Node Graph の一部をグループ化して、見た目上一つのノードとして扱うことができるノードです。

グループ化したいノードを選択してから ‘g’ キーを押すと、シュルシュルッと一つのノードにまとまります。

見た目は一つのノードですが、内部の構成はそのまま残っていてノードの + ボタンを押すと中を確認することができます。

Dot ノード

これは既に使っていますね。ノード間を接続しているエッジを曲げたり分岐したりするのに使います。Tab→Dot で作成できます。

これらのノードを使用して Node Graph の構成を綺麗に保つことはとても大事です。試行錯誤中はどうしてもノードが汚くなってしまいがちですが、そのままでは他の人が見た時にどこで何の処理をしているのか把握するのが難しくなってしまいますし、作った本人ですら時間が経つと細かい内容を忘れてしまいます。

そのようなことが無いよう、常日頃から綺麗なノード構成になるよう心掛けておくことが大事です。心の乱れはグラフの乱れ、グラフの乱れは作品の乱れ。南無～