This is the documentation for Enlighten.

9.2.8.2. Lua バインディングのリファレンス

概要

このリファレンスは、使用可能な Lua バンディングのリストを提供します。これらの関数は、Lua コンソール (Tab で開きます) または自動ロードされたスクリプトにより実行できます。

ほとんどの Lua バインディングは、開発を支援し、デモやシーンのコンテンツ検証などの特定のタスクを自動化するために存在します。一般的な機能は、さらに簡単に UI からアクセスできます。

シーンの管理

LoadScene( string )

既定のシーンをロードします。

LoadLights( string )

現在のライト構成から滑らかに補間し、既定のライト構成をロードします。

LoadLightsImmediate( string )

既定のライト構成をロードし、すぐに適用します。

ExtractSceneFromCache( string folderPath )

プリコンピュート API に送られたシーンのステート ダンプを抽出し、GeoRadiosity にリロードします。シーンは抽出されますがプリコンピュートされず、その後 Precompute ボタンを押すと、プリコンピュート プロセス全体 (GeoConvert を含む) が実行されます。

StartPrecompute( )

現在ロードされているシーンをプリコンピュートします。

SetWorldUnitScale( float )

レンダリングで GeoRadiosity が使用するスケールを設定します。このプロパティは、GUI ウィジェットのサイズとカメラの速度を変更します。

SetWorldPermutation( string )

+x-z-y などの文字列でワールドの向きを設定します。

GotoStartPoint( int )

カメラを既定の開始点に移動します。開始点は 3ds Max/Maya で作成します。

PrintSceneDesc( )

現在ロードされているシーンに関する役立つ統計情報を印刷します。

SetLightConfigInterpolationTime( float )

ライト構成の補間時間を既定の秒数に設定します。この時間、古いライト構成はフェード アウトし、新しいロードされたものがフェード インします。

GetCameraPosition( )

現在のカメラの位置と回転を文字列で出力します。

SetCameraPosition( float x, float y, float z)

カメラの XYZ 位置を設定します。

SetCameraPositionAndRotation( float x, float y, float z, float yaw, float pitch, float bank)

カメラの XYZ 位置と、ヨー/ピッチ/バンクを設定します。

レンダリング

SetRendererMode( string )

GeoRadiosity が使用するレンダラー モードを設定します。ロードされたシーンに応じて、Rendering タブで選択可能なモードの一部またはすべてを使用できます。パラメーターは Scene/Solid と同じ形式である必要があり、これら 2 つは GeoRadiosity の Rendering タブのラジオ ボタンの名称です。

CaptureBackBuffer( string fileName, string fileFormat )

バックバッファをキャプチャし、既定の形式でファイルに保存します。1 つ目のパラメーターは、スクリーンショットの保存先へのパスです。パスには _(%SceneName%)###.XXX が追加されます。%SceneName% は現在ロードされているシーンの名前、### は 000 から始まり増分する数字であり、XXX は 2 つ目のパラメーターで指定されるファイル拡張子です。サポートされている形式は、tgapngbmpjpgdds です。たとえば、Arches.scene がロードされている場合、CaptureBackBuffer("C:\MyScreenshots\Screenshot", "png") を初めて呼び出すとファイル C:\MyScreenshots\Screenshot(Arches)_000.png が保存されます。

ToggleRadUpload( )

ラジオシティ結果の GPU へのアップロードを切り替えます。

ToggleFullscreen( )

フルスクリーン レンダリング モードを切り替えます。(フルスクリーン モードは、Alt + Enter を押して切り替えることもできます。)

ToggleShowEditGui( )

GUI 要素のレンダリングを切り替えます。すべての GUI 要素をクリアするために使用できます。

SetFullscreen( boolean )

フルスクリーン レンダリング モードを有効/無効にします。

SetRenderAllMeshes( boolean )

ジオメトリ オブジェクトのすべてのメッシュのレンダリングを有効にします。デフォルトで、GeoRadiosityは各 Geometry オブジェクトの最初のメッシュだけをレンダリングします。これは通常、最初のメッシュが「レンダー メッシュ」であり、後続のメッシュは LOD レベル、ターゲット メッシュなどのためです。ただし、一部の作成パイプラインでは単一の Geometry オブジェクトに複数のレンダリング用メッシュを配置することがあります。SetRenderAllMeshes 関数は、デフォルトの動作をオーバーライドし、すべてのメッシュのレンダリングを強制します。これは特に、各メッシュの役割が不明な未知の作成パイプラインで作成されたシーンで ExtractSceneFromCache 関数を使用する際に役立ちます。

SetLargestSceneSize( float )

近い面と遠い面の距離の元となるシーンのサイズ パラメーターの最大値を設定します。Cornellbox_10_units_100_boxes のような非常に大きなシーンを正しくレンダリングするために必要です。(このようなシーンの場合、app.SetLargestSceneSize(10000.0); を使用します)

ポスト プロセス

レンダリング パイプラインの最後に、シーンがトーンマッピングされた部分とされていない部分に分割されます。それぞれの部分に対し、1 つずつ彩度を上下させる制御があります。

float GetTonemapSaturationPerc( )

現在の彩度の制御を返します。1 = 通常、0 = グレースケール

SetTonemapSaturationPerc( float )

彩度の制御を設定します。

float GetNonTonemapSaturationPerc( )

トーンマッピングされていない部分の GetTonemapSaturationPerc( ), と同じです。

SetNonTonemapSaturationPerc( float )

トーンマッピングされていない部分の GetTonemapSaturationPerc( ), と同じです。

SetRadTonemapping( boolean )

間接ライティングのトーンマッピングを行うかどうかです。

デバッグ

SetGlobalLodLevel( int )

レンダリングする LOD レベルを設定します。負の値では無効になります (デフォルト)。

GetGlobalLodLevel( )

現在設定されている LOD レベルを取得します。

SetProbeSetLod( int index, int level )

特定のプローブ セットのプローブ解決のための指定 LOD レベルを設定します。最初のパラメーターはプローブ セット インデックス、2 つ目は LOD レベルです。プローブ セット インデックスに -1 を指定すると、すべてのプローブ セットに対する LOD が設定されます。

DisplayHtmlReport( )

デフォルト ブラウザでレポートを開き、各システムとシーン全体での Enlighten のメモリ使用量の明細を表示します。

LoadRadTaskDumps( int platform, int workspace )

GeoRadTestBed により生成された出力をロードします。Enlighten のコンソール バージョンの出力をテストするために使用されます。各プラットフォームではそれぞれ異なる名前でファイルを保存します。必要なプラットフォームとワークスペースを選択するには、以下の表の整数値を渡してください。

プラットフォーム

 

Windows

0

アルベド ワークスペース タイプ

 

フル アルベド ワークスペース

0

クラスタ アルベド ワークスペース

1

その他

ShowErrorDialog( string )

Lua スクリプトのコンソール エラー メッセージを有効にします。

GetEnvVariable( string )

環境変数を文字列として取得します (PC のみ)。

LoadScript( string )

既定の Lua スクリプトをロードし、実行します。

LoadEnvScriptFile( string )

既定の環境変数に格納されたファイル名から Lua スクリプトをロードし、実行します (PC のみ)。

BindKeyToAction( string, int )

文字列のキーを既定の関数ポインターとバインドします。以下に例を示します。

loadLights = function() app.LoadLights( myLightsString ); end
app.BindKeyToAction("1", loadLights);

DefaultScriptEnvVariable( )

デフォルトの Lua スクリプト名を取得します (現在は GEO_RAD_SCRIPT)。

InMediasRes( )

カメラをワールド バウンディング ボックスの中心に配置します。

HoldView( )

レジストリにカメラ設定 (位置と向き) を格納します (Windows のみ)。

FetchView( )

レジストリからカメラ設定 (位置と向き) を復元します (Windows のみ)。

RunDelayedScript( int frameDelay, string luaString )

(luaString) で渡される Lua コードが、frameDelay でレンダリングされたフレーム数が渡された後で呼び出されます。