FluidLoader: GeometryClass

FluidLoader : GeometryClass {6dad24c7,885cba23}

このクラスは流体ローダ ジオメトリ オブジェクトの機能を公開します。3ds Max 2019.2 Update 以降で使用可能です。

このクラスは公開されていますが、3ds Max 2018.4 から 3ds Max 2019.1 Update には実装されていません。

コンストラクタ

FluidLoader()
BifLoader()

プロパティ

このクラスには多くのプロパティがあります。ここでは、[シミュレーション ビュー](Simulation View)ダイアログに表示される順序に従って編成されます。

注: ここに表示されていないプロパティは内部専用とみなされるか、または将来実装するために予約されています。

一般的なプロパティ

<FluidLoader>.showIcon Integer default: 1 -- integer

ビューポートに[流体ローダ](Fluid Loader)アイコンを表示するかどうかを指定します。0 = false (表示しない)、1 = true (表示)です。

<FluidLoader>.iconSize Float default: 10.0 -- worldUnits

ビューポート内の[流体ローダ](Fluid Loader)アイコンのサイズ(ワールド単位)です。

[ローダ プロパティ](Loader Properties)タブのプロパティ

<FluidLoader>.cacheFlagsTab ArrayParameter default: #() -- int array; SubAnim

対応するキャッシュ ファイル(インデックスを基準とする)の使用方法および表示方法を指定する整数からなる配列です。

<FluidLoader>.cacheNameTab ArrayParameter default: #() -- string array; SubAnim

流体ローダによってロードされたキャッシュの名前を含む配列です。これらは、[シミュレーション ビュー](Simulation View)ダイアログ ボックスの[ローダ プロパティ](Loader Properties)タブの[キャッシュ ファイル](Cache Files)リストに表示されるフィアルです。

<FluidLoader>.cacheTab ArrayParameter default: #() -- string array; SubAnim

[流体ローダ](Fluid Loader)によってロードされたキャッシュの絶対パス(最初のキャッシュ ファイルの名前を含む)が含まれている配列です。

<FluidLoader>.materialID_Tab ArrayParameter default: #() -- int array; SubAnim

ロードされたキャッシュに関連付けられたマテリアル ID からなる配列です。マテリアル ID のインデックスは、cacheTab 内のキャッシュのインデックスに対応します。

<FluidLoader>.materialIDIndirect Integer default: 0 -- integer

UI で現在選択されているキャッシュのマテリアル ID を含みます。

<FluidLoader>.playbackMode_Tab ArrayParameter default: #() -- int array; SubAnim

ロードされたキャッシュの[キャッシュの再生](Cache Playback)を含む配列です。再生モードのインデックスは、cacheTab 内のキャッシュのインデックスに対応します。

有効な値は次のとおりです。

<FluidLoader>.playbackModeIndirect Integer default: 0 -- integer

現在選択されているキャッシュの再生モードです。

<FluidLoader>.useLoaderObjectTransform BooleanClass default: true -- boolean

ローダ オブジェクト変換を使用するかどうかを指定します。true の場合は、すべてのキャッシュ ファイルが変換によってオフセットされます。

<FluidLoader>.startFrame_Tab ArrayParameter default: #() -- int array; SubAnim        
<FluidLoader>.endFrame_Tab ArrayParameter default: #() -- int array; SubAnim

[キャッシュの再生](Cache Playback) (playbackMode_Tab)が[カスタム範囲](Custom Range)に設定されているキャッシュの開始フレーム番号と終了フレーム番号を含む配列です。フレーム設定のインデックスは、cacheTab のキャッシュ インデックスに対応します。

<FluidLoader>.startFrameIndirect Integer default: 0 -- integer        
<FluidLoader>.endFrameIndirect Integer default: 0 -- integer

現在選択されているキャッシュの開始フレームおよび終了フレームの設定です。このプロパティが適用されるのは、[キャッシュの再生](Cache Playback)モードが[カスタム範囲](Custom Range)の場合のみです。

<FluidLoader>.startOnly_Tab ArrayParameter default: #() -- int array; SubAnim

[キャッシュの再生](Cache Playback) (playbackMode_Tab)が[カスタム開始](Custom Start)に設定されているキャッシュの開始フレーム番号を含む配列です。開始フレーム設定のインデックスは、cacheTab のキャッシュ インデックスに対応します。

<FluidLoader>.startOnlyIndirect Integer default: 0 -- integer

現在選択されているキャッシュの開始フレームの設定です。このプロパティが適用されるのは、[キャッシュの再生](Cache Playback)モードが[カスタム開始](Custom Start)の場合のみです。

<FluidLoader>.playbackFrame_Tab ArrayParameter default: #() -- int array; SubAnim

[キャッシュの再生](Cache Playback) (playbackMode_Tab)が[記録形状を再生](Playback Graph)に設定されているキャッシュの開始フレーム番号を含む配列です。開始フレーム設定のインデックスは、cacheTab のキャッシュ インデックスに対応します。

<FluidLoader>.playbackFrameIndirect Integer default: 0 -- animatable; integer; PlaybackFrame

現在選択されているキャッシュの開始フレームの設定です。このプロパティが適用されるのは、[キャッシュの再生](Cache Playback)モードが[記録形状を再生](Playback Graph)の場合のみです。

<FluidLoader>.displayCacheLimitEnable BooleanClass default: true -- boolean

キャッシュ サイズ制限がオンまたはオフのいずれであるかを指定します。

<FluidLoader>.displayCacheLimit Float default: 8.0 -- float

キャッシュが使用できるメモリの最大量(GB 単位)です。

[表示設定](Display Settings)タブのプロパティ

[液体の設定](Liquid Settings)ロールアップ

<FluidLoader>.displayTypeMode Integer default: 3 -- integer

液体の表示タイプです。値は、次のとおりです。

メッシュ設定(Mesh Settings)

これらの設定は、displayTypeMode が 0 (Bifrost ダイナミック メッシュ)の場合に適用されます。

*Accessor プロパティは、現在選択されているキャッシュの値を取得または設定します。*Tab プロパティは、cacheTab 内の同じインデックスを持つキャッシュに対応します。

<FluidLoader>.meshingDropletRevealFactorAccessor Float default: 0.0 -- float        
<FluidLoader>.meshingDropletRevealFactorTab ArrayParameter default: #(3.0) -- float array; SubAnim

メッシュを生成してスムージングするときにスプラッシュ周辺の詳細を作成して保持します。値を小さくするとメッシュがスムーズになり、値を大きくすると細かく高頻度な詳細になります。

<FluidLoader>.meshingSurfaceRadiusAccessor Float default: 0.0 -- float        
<FluidLoader>.meshingSurfaceRadiusTab ArrayParameter default: #(1.4) -- float array; SubAnim

ベース ボクセル サイズの倍数である、サーフェスを作成するために使用する各パーティクル ブロブの半径です。

<FluidLoader>.meshingDropletRadiusAccessor Float default: 0.0 -- float        
<FluidLoader>.meshingDropletRadiusTab ArrayParameter default: #(1.2) -- float array; SubAnim

ベース ボクセル サイズを基準とする各水滴の半径です。

<FluidLoader>.meshingKernelFactorAccessor Float default: 0.0 -- float        
<FluidLoader>.meshingKernelFactorTab ArrayParameter default: #(2.0) -- float array; SubAnim

サーフェス スムージング カーネルの幅をコントロールします。値を小さくするとよりシャープになり、生成されるメッシュの曲率が大きくなります。値を大きくするとよりスムーズになります。

<FluidLoader>.meshingSmoothingAccessor Integer default: 0 -- integer        
<FluidLoader>.meshingSmoothingTab ArrayParameter default: #(3) -- int array; SubAnim

メッシュで実行されるスムージング ステップの数です。

<FluidLoader>.meshingResolutionFactorAccessor Float default: 0.0 -- float        
<FluidLoader>.meshingResolutionFactorTab ArrayParameter default: #(1.0) -- float array; SubAnim

メッシュを生成する前にパーティクルの解像度を調整するためのスケーリング係数です。値が大きいほど高頻度の詳細が作成されますが、計算時間は長くなります。

<FluidLoader>.meshingHoleKillThresholdAccessor Float default: 0.0 -- float        
<FluidLoader>.meshingHoleKillThresholdTab ArrayParameter default: #(0.0) -- float array; SubAnim

この値を大きくすると、流体内部のメッシュ化された穴を除去できます。このような穴は、空間適応シミュレーションで高い[解像度係数](Resolution Factor)値を使用する場合に特に発生します。

<FluidLoader>.meshingFlipFaceNormalAccessor BooleanClass default: false -- boolean        
<FluidLoader>.meshingFlipFaceNormalTab ArrayParameter default: #(false) -- boolean array; SubAnim

true の場合は、メッシュの面法線を反転します。

[パーティクル設定](Particle Settings)

これらの設定は、displayType が 0 (Bifrost ダイナミック メッシュ)および 7 (なし)以外の任意の値の場合に適用されます。

<FluidLoader>.customNode UndefinedClass default: undefined -- node

displayTypeMode が 6 (カスタム)の場合に表示されるパーティクルとして使用するカスタム ノードです。

<FluidLoader>.colorChannelMode Integer default: 13 -- integer

流体のカラーを制御するチャネルです。このプロパティの有効値は、次のとおりです。

<FluidLoader>.colorChannelMax Color default: (color 51.9945 223.992 255) -- RGB color
<FluidLoader>.colorChannelMin Color default: (color 0 27.999 255) -- RGB color

colorChannelMode が「静的」(0)でない場合に表示されるチャネルのデータの最小値および最大値を指定するために使用されるカラーです。

<FluidLoader>.staticColor Color default: (color 0 27.999 255) -- RGB color

colorChannelMode が 0 (静的)の場合に使用されるカラーです。

<FluidLoader>.opacityChannelMode Float default: 0.0 -- float

流体の不透明度を制御するチャネルです。このプロパティの有効値は、次のとおりです。

<FluidLoader>.opacityChannelMax Float default: 1.0 -- float        
<FluidLoader>.opacityChannelMin Float default: 0.0 -- float

opacityChannelMode が「静的」(0)でない場合に表示されるチャネルのデータの最小値および最大値を指定するために使用される不透明度です。

<FluidLoader>.staticOpacity Float default: 1.0 -- float

opacityChannelMode が 0 (「静的」)の場合に使用する不透明度です。

<FluidLoader>.sizeChannelMode Float default: 0.0 -- float

流体のパーティクル サイズを制御するチャネルです。このプロパティの有効値は、次のとおりです。

<FluidLoader>.sizeChannelMax Float default: 1.0 -- float        
<FluidLoader>.sizeChannelMin Float default: 0.0 -- float

sizeChannelMode が 0 (静的)でない場合に、表示されるチャネルのデータの最小値および最大値を指定するために使用される不透明度です。

<FluidLoader>.staticSize Float default: 1.0 -- float

sizeChannelMode が 0 (静的)である場合に使用される液体のパーティクル サイズです。

[表示] (Display)

<FluidLoader>.viewportPercentAccessor Float default: 100.0 -- float

ビューポートに表示する液体パーティクルの総数に対する割合です。

[泡の設定](Foam Settings)ロールアップ

<FluidLoader>.foamDisplayTypeMode Integer default: 3 -- integer

泡の表示タイプです。値は、次のとおりです。

<FluidLoader>.foamColorChannelMode Integer default: 0 -- integer

カラーを制御するために使用するデータ チャネルを指定します。値は次のとおりです。

<FluidLoader>.foamColorChannelMin Color default: (color 255 255 255) -- RGB color        
<FluidLoader>.foamColorChannelMax Color default: (color 47.991 47.991 47.991) -- RGB color

foamColorChannelMode が 0 (静的)でない場合に泡のカラーを制御するために使用するカラーの最小値および最大値です。

<FluidLoader>.foamStaticColor Color default: (color 255 255 255) -- RGB color

foamColorChannelMode が 0 (静的)である場合に使用する泡のカラーです。

<FluidLoader>.foamOpacityChannelMode Integer default: 0 -- integer

ビューポート表示内の泡の不透明度を制御するために使用されるデータ チャネルです。値は次のとおりです。

<FluidLoader>.foamOpacityChannelMin Float default: 0.0 -- float        
<FluidLoader>.foamOpacityChannelMax Float default: 1.0 -- float

foamOpacityChannelMode が 0 (静的)でない場合に使用する最小および最大の不透明度です。

<FluidLoader>.foamStaticOpacity Float default: 1.0 -- float

foamOpacityChannelMode が 0 (静的)である場合に使用する泡の不透明度です。

<FluidLoader>.foamSizeChannelMode Integer default: 5 -- integer

泡パーティクルのサイズを制御するために使用するデータ チャネルを指定します。値は次のとおりです。

<FluidLoader>.foamSizeChannelMax Float default: 1.0 -- float        
<FluidLoader>.foamSizeChannelMin Float default: 0.0 -- float

foamSizeChannelMode が 0 (静的)でない場合に使用する最小および最大のサイズ範囲です。

<FluidLoader>.foamStaticSize Float default: 1.0 -- float

foamSizeChannelMode が 0 (静的)である場合に使用する泡パーティクルのサイズです。

[表示] (Display)

<FluidLoader>.foamViewportPercentAccessor Float default: 100.0 -- float

ビューポートに表示する泡パーティクルの総数に対する割合です。

[レンダリング設定](Render Settings)タブのプロパティ

<FluidLoader>.renderChannelMapIndex ArrayParameter default: #(2) -- int array; SubAnim

流体ローダのレンダリング チャネルのインデックスを含む配列です。これは、[レンダリング設定](Render Settings)タブの[チャネルを追加](Add Channels)にリストされているチャネルに対応します。

<FluidLoader>.renderChannelMapName ArrayParameter default: #("velocity") -- string array; SubAnim

流体ローダのレンダリング チャネルの名前を含む配列です。これは、[レンダリング設定](Render Settings)タブの[チャネルを追加](Add Channels)にリストされているチャネルに対応します。

[液体の設定](Liquid Settings)ロールアップ

<FluidLoader>.liquidRenderType Integer default: 6 -- integer

[レンダリングの形式](Render As)の設定です。値は次のとおりです。

<FluidLoader>.liquidRenderSizeChannel String default: "Static" -- string        
<FluidLoader>.liquidSizeChannelType Integer default: 0 -- integer

レンダリングに使用するサイズ チャネルの名前およびタイプを指定します。

<FluidLoader>.liquidRenderStaticSize Float default: 1.0 -- float

liquidRenderSizeChannel が[静的] (Static)の場合に液体のパーティクル サイズを指定します。

<FluidLoader>.liquidRenderSizeMax Float default: 1.0 -- float        
<FluidLoader>.liquidRenderSizeMin Float default: 0.0 -- float        
<FluidLoader>.liquidRenderSizeMaxDomain Float default: 1.0 -- float        
<FluidLoader>.liquidRenderSizeMinDomain Float default: 0.0 -- float

レンダリングされた液体パーティクルの最小サイズと最大サイズおよびサイズのドメインを指定します。

<FluidLoader>.liquidCustomRenderNode UndefinedClass default: undefined -- node; LiquidRenderCustomNode

liquidRenderType が[カスタム] (custom)の場合に、液体パーティクルのレンダリングに使用されるシーン ノードを保持します。

[泡の設定](Foam Settings)ロールアップ

<FluidLoader>.foamRenderType Integer default: 0 -- integer; LiquidRenderType

泡の[レンダリングの形式](Render As)の設定です。値は次のとおりです。

<FluidLoader>.foamRenderSizeChannel String default: "Static" -- string
<FluidLoader>.foamSizeChannelType Integer default: 0 -- integer

[レンダリングの形式] (Render As)の設定が[平面] (Plane)、[クロス] (Cross)、[ボックス] (Box)、[球] (Sphere)、または[カスタム] (Custom)の場合に、サイズ データに使用するチャネルです。

foamSizeChannelType の有効値は、次のとおりです。

<FluidLoader>.foamRenderStaticSize Float default: 1.0 -- float

foamSizeChannelType が 0 (静的)である場合に使用する泡パーティクルのサイズです。

<FluidLoader>.foamRenderSizeMax Float default: 1.0 -- float        
<FluidLoader>.foamRenderSizeMin Float default: 0.0 -- float

使用する泡パーティクル サイズの範囲です。

<FluidLoader>.foamRenderSizeMaxDomain Float default: 1.0 -- float        
<FluidLoader>.foamRenderSizeMinDomain Float default: 0.0 -- float

使用する泡ドメイン サイズの範囲です。

<FluidLoader>.foamCustomRenderNode UndefinedClass default: undefined -- node

foamRenderType = 5 (カスタム)の場合に泡メッシュをレンダリングするために使用するカスタム ノードです。

Arnold 固有のレンダリング プロパティ

これらのパラメータは、liquidRenderType が[Arnold サーフェス](Arnold Surface)の場合に使用できます。

<FluidLoader>.arnoldSurfaceType : integer
<FluidLoader>.arnoldRenderComponentType : integer
<FluidLoader>.arnoldDropletRevealFactor : float
<FluidLoader>.arnoldSurfaceRadius : float
<FluidLoader>.arnoldDropletRadius : float
<FluidLoader>.arnoldResolutionFactor : float
<FluidLoader>.arnoldHoleKillThreshold : float
<FluidLoader>.arnoldFilteringDilate : float
<FluidLoader>.arnoldFilteringSmooth : float
<FluidLoader>.arnoldFilteringSmoothMode : integer
<FluidLoader>.arnoldFilteringSmoothIterations : integer
<FluidLoader>.arnoldFilteringErode : float
<FluidLoader>.arnoldMeshSubdivisions : integer
<FluidLoader>.arnoldMeshSmoothing : boolean          
<FluidLoader>.arnoldImplicitStepSize : float
<FluidLoader>.arnoldImplicitSamples : integer

Arnold ポイントの泡の設定

次のパラメータは、foamRenderType が[Arnold ポイント](Arnold Point)の場合に使用できます。

<FluidLoader>.arnoldPointRadiusChannel : integer
<FluidLoader>.arnoldPointRadius : float
<FluidLoader>.arnoldPointStepSize : float
<FluidLoader>.arnoldPointChunkSize : integer

Arnold サーフェスの泡の設定

次のパラメータは、foamRenderType が[Arnold サーフェス](Arnold Surface)の場合に使用できます。

<FluidLoader>.arnoldFoamSurfaceType : integer
<FluidLoader>.arnoldFoamDropletRevealFactor : float
<FluidLoader>.arnoldFoamSurfaceRadius : float
<FluidLoader>.arnoldFoamDropletRadius : float
<FluidLoader>.arnoldFoamResolutionFactor : float
<FluidLoader>.arnoldFoamHoleKillThreshold : float
<FluidLoader>.arnoldFoamFilteringDilate : float
<FluidLoader>.arnoldFoamFilteringSmooth Float default: 1.0 -- float        
<FluidLoader>.arnoldFoamFilteringSmoothMode : integer
<FluidLoader>.arnoldFoamFilteringSmoothIterations : integer
<FluidLoader>.arnoldFoamFilteringErode : float
<FluidLoader>.arnoldFoamMeshSubdivisions : integer
<FluidLoader>.arnoldFoamMeshSmoothing : boolean
<FluidLoader>.arnoldFoamImplicitStepSize : float
<FluidLoader>.arnoldFoamImplicitSamples : integer

UI で公開されていないプロパティ

<FluidLoader>.enableGPUPoints BooleanClass default: true -- boolean

ポイントが GPU でレンダリングされるかどうかを指定します。標準ポイントのサイズは 8 つのみであり、レンダリングは低速です。このプロパティは既定でオンになっています。

インタフェース

インタフェース: FluidLoaderObject id:{0x036af2c15,0x01d077672}

プロパティ:

なし

メソッド:

 <boolean>AddCache <string>path <&index>index
         index is Out parameter

絶対パスで指定されたキャッシュを流体ローダに追加します。パスには、キャッシュ内のファイルのパスまたはキャッシュ ディレクトリ自体のパスを指定できることに注意してください。キャッシュの配列内のキャッシュのインデックス(.cacheTab プロパティ)は、参照パラメータ index に格納されて返されます。

 <boolean>RemoveCache <index>index

キャッシュ リストの指定したインデックスにあるキャッシュを削除します(.cacheTab プロパティ)。このリストの基数は 1 であることに注意してください。成功した場合は true、失敗した場合は false を返します(インデックスが存在しない場合など)。

 <integer>NumberCaches()

流体ローダ内のキャッシュの数を返します。

<boolean>GetCacheIndex <string>name <&index>index
       index is Out parameter

名前で指定したキャッシュのインデックスを、参照パラメータ index に格納して返します。指定したキャッシュがある場合は true、ない場合は false を返します。

 <boolean>GetPathAndFile <index>index <&string>path
         path is Out parameter

指定した index にあるキャッシュの絶対パスを参照パラメータ path に格納して返します。これで返されるのはパスのみです。ファイル名は返されません。インデックスがある場合は true、ない場合は false を返します。

 <boolean>GetCacheName <index>index <&string>name
         name is Out parameter

index で指定されたインデックスにあるキャッシュ名を、参照パラメータ name に格納して返します。 これは、キャッシュ ファイルの名前やパスではなく、シミュレーション ビューの UI に表示される名前であることに注意してください。インデックスがある場合は true、ない場合は false を返します。

<boolean>SetCacheName <index>index <string>name

index で指定されたインデックスにあるキャッシュ名を、指定した name に設定します。これは、キャッシュ ファイルの名前やパスではなく、シミュレーション ビューの UI に表示される名前であることに注意してください。インデックスがある場合は true、ない場合は false を返します。

 <boolean>GetCachePath <index>index <&string>path
         path is Out parameter

指定した index にあるキャッシュの絶対パスおよびファイル名を、参照パラメータ path に格納して返します。インデックスがある場合は true、ない場合は false を返します。

 <boolean>GetCacheType <index>index <&enum>type
         type enums: {#unknown|#liquid|#smoke|#foam|#mesh}
         type is Out parameter

指定した index にあるキャッシュのキャッシュ タイプを、参照パラメータ type に格納して返します。インデックスがある場合は true、ない場合は false を返します。

 <boolean>GetCacheRange <index>index <&integer>start <&integer>end
         start is Out parameter
         end is Out parameter

指定した index にあるキャッシュのフレーム範囲を、参照パラメータ start および end に格納して返します。インデックスがある場合は true、ない場合は false を返します。

 <boolean>GetCacheEnable <index>index <&boolean>enable
         enable is Out parameter         

 <boolean>SetCacheEnable <index>index <boolean>enable

指定した index にあるキャッシュの有効なプロパティを取得または設定します。このプロパティは、シミュレーション ビューの UI に[使用] (Use)チェックボックスとして表示されます。インデックスがある場合は true、ない場合は false を返します。

 <boolean>GetCacheDisplay <index>index <&boolean>display
         display is Out parameter

 <boolean>SetCacheDisplay <index>index <boolean>display

指定した index にあるキャッシュの表示プロパティを取得または設定します。このプロパティは、キャッシュがビューポートに表示されるかどうかを決定します。インデックスがある場合は true、ない場合は false を返します。

 <boolean>GetCacheMatID <index>index <&index>matID
         matID is Out parameter

 <boolean>SetCacheMatID <index>index <index>matID

指定した index にあるキャッシュのマテリアル ID を取得または設定します。インデックスがある場合は true、ない場合は false を返します。

 <boolean>GetCachePlaybackMode <index>index <&enum>mode
         mode enums: {#originalRange|#customStart|#customRange|#playbackGraph}
         mode is Out parameter

 <boolean>SetCachePlaybackMode <index>index <enum>mode
         mode enums: {#originalRange|#customStart|#customRange|#playbackGraph}

指定した index にあるキャッシュの再生モードを取得または設定します。インデックスがある場合は true、ない場合は false を返します。

アクション:

なし

親ページ: 最大流体クラス