フラグメントレンダラサンプルプラグインを作成する

viewRenderOverrideFromFragments サンプルプラグインは、一連の API の使用法を示すのに使用します。これにより、スクリプトフラグメントとフラグメントグラフを使用してシーンや目的のポストエフェクトをレンダリングできます。スクリプトフラグメントは、標準のビューポートレンダリングエフェクトを適用するために Maya 内部で使用される構築ブロックで、Maya インストールフォルダの bin/ScriptFragment フォルダ内の一連の .xml ファイル内に格納されています。

これらの API を使用すると、Maya 独自の標準構築ブロックと自分自身で作成した構築ブロックを組み合わせて、Maya ビューポートおよびハードウェアレンダラを再使用、修正、拡張することができます。

サンプルプラグインの機能は次のとおりです。

メインシーンをレンダリングする
平面を通してカメラを反転し、オフスクリーンバッファにシーンを再レンダリングし、このオフスクリーンバッファを次のパスのテクスチャとして使用する
四角形の上にテクスチャを配置して、その四角形をメインスクリーンにレンダリングする

サンプルプラグインについては、pyGroundReflectionRenderer.py を参照してください。

このサンプルを使用すると、Renderer ビューポートパネルメニューに Ground Reflections レンダラが作成されます。Ground Reflections レンダラに切り替えると、ビューポートによってオブジェクトおよびその反射がレンダリングされます。

注:

サンプルをロードする前に、pyGroundReflectionRenderer.py ファイルの initializePlugin 関数(行 242)にプラグインのパスを設定する必要があります。

フラグメント xml ファイルは viewRenderOverrideFromFragments プラグインフォルダの ScriptFragment フォルダ内にあります。このレンダラのメインフラグメントグラフは GroundReflections.xml です。指定した .xml ファイルはシェーダ検索パス内になければなりません。

プラグインコードの initializePlugin 関数も、このプラグインの Shaders フォルダをシェーダ検索パスに追加します。

フラグメントマネージャにアクセスして、新しいフラグメントグラフを追加するには、次のように MRenderer.getFragmentManager()を呼び出します。

omr.MRenderer.getFragmentManager().addFragmentGraphFromFile("GroundReflections.xml")

MSceneRender を使用してシーンレンダーを作成し、フラグメントグラフの名前を指定します(ここでは “GroundReflections”)。

class FragmentSceneRender(omr.MSceneRender):
    def __init__(self, name):
        super(FragmentSceneRender, self).__init__(name, "GroundReflections")

MRenderOverride を作成してフラグメントレンダラを作成し、以下を呼び出してこのレンダラを登録します。

omr.MRenderer.registerOverride(fragmentRenderer)

MRenderOverride を作成する場合は、MSceneRender から派生したカスタムレンダー操作が含まれている MRenderOperation のリストを指定します。

class FragmentRenderOverride(omr.MRenderOverride):

    def __init__(self, name):
        self.operatioIndex = 0
        self.operations =  [FragmentSceneRender("sceneAndGroundReflections"),
                           omr.MHUDRender(),
                           omr.MPresentTarget("present")]

preSceneRender 関数をオーバーライドする場合は、MSceneRender::getParameters()を呼び出して、一連のレンダーパラメータを取得します。MRenderParameters を参照してください。

def preSceneRender(self, context):
    params = self.getParameters()

まだ存在していない場合は、オプションノードを作成します。

optionsNodeName = 'groundReflectionOptions'
optionObj = nameToNode(optionsNodeName)
if optionObj is None:
    optionObj = nameToNode(cmds.createNode(RenderOverrideOptions.kTypeName, name=optionsNodeName, skipSelect=True))

次にオプションノードからプラグを取得し、MRenderParameters::setParameter()を呼び出して、カスタム MSceneRender (カスタムシーンレンダラ操作)で使用されるレンダーフラグメントに値を渡します。

if optionObj is not None:
    # set the fragment's enabled input
    optionPlug = om.MPlug(optionObj, RenderOverrideOptions.enableReflections)
    if optionPlug is not None:
        enabled = getBoolPlugValue(optionPlug)
        params.setParameter('EnableReflection', enabled)

GroundReflections フラグメントグラフには DepthTarget などのフラグメント、およびフラグメントグラフ Reflection_Renderer を含む ReflectionPass などの他のフラグメントグラフが含まれています。フラグメントグラフ Reflection_Renderer には、simpleBlitScript、MayaShadedBeauty、DrawPreUIOption などのフラグメントが含まれています。GroundReflections フラグメントグラフでは、ハードコードされた C++ プロシージャフラグメント VE_ReflectCamera も使用されます。

注: ReflectionPass フラグメントグラフは、わかりやすくするために名前が変更された既定のフラグメントグラフです。その中のサブフラグメントは、Maya の標準シーンレンダラで使用されます。

エフェクト、エフェクトのパラメータ、関連付けられたテクスチャを設定するには

サンプルフラグメントグラフ内のフラグメントの一部は、スクリプトフラグメントです。これらは、レンダリング操作を実行する場合に使用されるコマンドを含む、グラフ内のリーフフラグメントです。これらのコマンドの中には、パスにエフェクトを割り当てて、エフェクトパラメータをコントロールできるものがあります。

エフェクトを設定するには SetEffect コマンドを使用します。

これらのコマンドの使用例については、VE_PlanarReflection_RenderFragment.xml を参照してください。
```
<SetEffect name="DilateH" path="DistanceDilate" technique="DilateHoriz" />
<SetEffectParameter effect="DilateH" name="gAmount" value="_UseDistanceDilate_Amount" />
<SetTexture effect="DilateH" name="gSourceTex" value="PointClamp" texture="@DistanceMap" />
<SetEffectParameter effect="DilateH" name="gSourceSamp" value="PointClamp" />
<SetTarget index="0" value="tempDilate" />
<Render name="Quad" />
```
エフェクトはフラグメントでない MShaderInstance のインスタンスと同等ですが、スクリプト内で直接使用することはできません。name アトリビュートはこのエフェクトを参照する場合に使用される名前です。path アトリビュートはエフェクトファイルのパスおよび名前です。ファイル拡張子を指定する必要はありません。Maya では、使用されているデバイスに基づいて適切な拡張子が検索されます(DX11 の場合は .fx、コアプロファイルの場合は .ogsfx、コアプロファイル以外の OpenGL の場合は .cgfx)。technique アトリビュートは、使用する必要があるエフェクトファイル内のテクニックを示します。1 つのファイル内に複数のテクニックが存在することがあります。
SetEffectParameter コマンドを使用してエフェクト値を設定してから、SetTexture コマンドを使用してエフェクトで使用されるテクスチャを設定します。

参照しているシェーダがマクロを使用する場合は、macrolist 値を設定してシェーダのコンパイル方法をコントロールすることもできます。
```
<SetEffect name="BlurH" path="Blur" technique="BlurHoriz" macrolist="BLUR_AMOUNT=12" />
```
スクリプトの最後にこのコマンドを呼び出して、元のビューポート 2.0 オーバーライドエフェクトを復元します。SetEffect コマンドを使用する場合は、ビューポート 2.0 でローカルオーバーライドエフェクトを設定します。
```
<RestoreOverrideEffect />
```

フラグメント レンダラ サンプル プラグインを作成する

エフェクト、エフェクトのパラメータ、関連付けられたテクスチャを設定するには

フラグメントレンダラサンプルプラグインを作成する