Page History
This page provides information on the command line interface of the Phoenix FD Standalone Previewer tool.
...
The command-line mode of the Phoenix FD Standalone Previewer allows you to execute the application without a graphics window and graphical user interface, draw a preview of a cache or sequence of caches, and save corresponding image files.
...
Note that arguments are preceded by "-" and followed by "=" if they require a value. All arguments and values are case insensitive.
| UI Text Box | ||||
|---|---|---|---|---|
| ||||
Default Path: C:\Program Files\Chaos Group\Phoenix FD\3ds Max 20xx for x64\bin\phoenix_previewer.exe |
...
Mandatory Arguments
...
-input= – Specifies the input .aur, .vdb or .f3d file(s) name or pattern. You can use "####" as a frame number and the files will be treated as a sequence. Paths must be absolute. If blank spaces are included wrap the path in apostrophes.
...
-output= – Specifies the output .png .jpg .bmp or .tiff file(s) name or pattern. You can use "####" as a frame number and the files will be treated as a sequence. Paths must be absolute. If blank spaces are included wrap the path in apostrophes.
| UI Text Box | size | medium|
|---|---|---|
| ||
Example: phoenix_previewer.exe -input=C:\Desktop\cache.aur -output=C:\Desktop\image.png |
...
auto – Signifies the use of default Grid Channels with Auto Range and Auto Reduction.
UI Text Box size medium type info Example: -prv_voxels=auto
cust – Requires the provision of a value for Detail Reduction and additional lists of sub-arguments for each Grid Channel, in the following format:
-prv_voxels=cust,[detailreduction],[channel1name]:[lowrange]:[highrange]:[lowColorR]:[lowColorG]:[lowColorB]:[highColorR]:[highColorG]:[highColorB],[channel2name]:[lowrange]:[highrange]:[lowColorR]:[lowColorG]:[lowColorB]:[highColorR]:[highColorG]:[highColorB]
Any number of Grid Channels can be listed with their options. Note that sub-arguments are delimited with a comma, except the sub-arguments for each Grid Channel which are delimited with a colon. Color values are listed with three floats between 0.0 and 1.0 for each of the Red, Green and Blue components. Color values are optional for each Grid Channel and can be omitted.UI Text Box size mediumtype info Example: -prv_voxels=cust,0,fuel:0:1000,smoke:500:600:0.5:0.5:0.5:1.0:0.0:0.0
Valid Grid Channel names: "fuel", "smoke", "temp", "vel", "rgb", "visc".
...
auto – Signifies the use of Auto Range and Auto Reduction.
UI Text Box medium type info Example: -viewVelStreamlines=auto
cust – Requires the provision of additional sub-arguments for Detail Reduction, the Low and High Range of the Streamlines, and the Low and High Color values in the following format:
-viewVelStreamlines=cust,[detailreduction],[lowrange],[highrange],[lowColorR],[lowColorG],[lowColorB],[highColorR],[highColorG],[highColorB]
Note that sub-arguments are delimited with a comma. Color values are listed with three floats between 0.0 and 1.0 for each of the Red, Green and Blue components. Color values can be omitted.UI Text Box size medium type info Example: -viewVelStreamlines=cust,0,10,1000,0.5,0.5,0.5,1.0,0.0,0.0
...
auto – Signifies the use of default Particle Systems, with default Color Scale Channels and Color Scale Max value.
UI Text Box size mediumtype info Example: -prv_particles=auto
cust – Requires the provision of a value for Detail Reduction and a list of sub-arguments for each Particle System, in the following format:
-prv_particles=cust,[detailreduction],[systemname1]:[colorscalechannel]:[colorscalemaxvalue]:[colorR]:[colorG]:[colorB],[systemname2]:[colorscalechannel]:[colorscalemaxvalue]:[colorR]:[colorG]:[colorB]
Any number of Particle Systems can be listed with their options. Note that sub-arguments are delimited with a comma, except the Color Scale Channel and Max value which are delimited with a colon. Color values are listed with three floats between 0.0 and 1.0 for each of the Red, Green and Blue components. Color values are optional for each Particle System and can be omitted.UI Text Box medium type info Example: -prv_particles=cust,0,liquid:1:1000:0.0:1.0:0.0,wetmap:3:600:1.0:0.0:0.0
Valid Particle System names: "liquid", "splashes", "mist", "foam", "wetmap" or other custom Particle System names.
Valid Color Scale Channels: 0 for No Scale, 1 for Speed, 2 for Size, 3 for Age, 4 for Viscosity.
...
auto – Signifies the use of default GPU Preview settings with Auto Reduction.
UI Text Box size mediumtype info Example: -gpu_viewport=auto
cust – Requires the provision of a value for for Detail Reduction, in the following format:
-gpu_viewport=cust,[detailreduction]
Note that sub-arguments are delimited with a comma.UI Text Box size medium type info Example: -gpu_viewport=cust,5
-showmesh= – Specifies options for the Mesh Preview. Omitting this argument disables the mode. In order to use this option you need to provide a list of sub-arguments following the "=" sign. The first sub-argument must be "auto" or "cust".
auto – Signifies the use of default Mesh Preview settings - the Liquid grid channel will meshed with an Isosurface Level of 0.5, which is the default for Phoenix Liquid simulations.
UI Text Box type info Example: -showmesh=auto
cust – Requires the name of the grid channel to be meshed, and then the Isosurface Level, using the following format:
UI Text Box type info Example: -showmesh=cust,temp:800
Valid Grid Channel names: "fuel", "smoke", "temp", "vel", "rgb", "visc".
You can find more information about the usual ranges of the Grid Channels here, and this way you can find what Isosurface Level would be appropriate.
color - Specifies the color used for the Mesh Preview.
UI Text Box type info Example: -showmesh=cust,smoke:0.5,color:125,80,255
The color values need to be in the range between 0 and 255, inclusive.
-prv_sect= – Specifies options for the Slice Preview. Omitting this argument or not providing a value means that the Slice Preview will be disabled. In order to use this option you need to provide a list of sub-arguments following the "=" sign.
The first sub-argument must be the desired axis, while the second must be the desired level.
| UI Text Box | |||
|---|---|---|---|
| |||
Example: -prv_sect=0,100 |
...
The first sub-argument must be the width and the second must be the height.
| UI Text Box | |||
|---|---|---|---|
| |||
Example: -prv_out_resolution=640,480 |
...
The first sub-argument must be the projection type 1 for perspective and 0 for orthographic. The second must be the yaw of the camera in degrees and the third must be the pitch of the camera in degrees. The fourth argument is the distance between the camera and orbit point. The last 3 arguments are the x, y and z components of the orbit point's position. Note that sub-arguments are separated by commas.
| UI Text Box | ||||
|---|---|---|---|---|
| ||||
Example: -prv_cam=1,90.0,0.0,100.0,0.0,0.0,0.0 |
...
| UI Text Box | ||
|---|---|---|
| ||
Note that the camera position will be based on the cache's bounding box. If you are loading a sequence of files the camera position will be based on the bounding box of the first cache in the sequence. |
-ifyz= – Specifies that the Y and Z axis must be flipped. By default the application uses Z-up convention. Any value after the "=" will enable this functionality.
| UI Text Box | ||||
|---|---|---|---|---|
| ||||
Example: -ifyz=1 |
Full Examples
...
| UI Text Box | size | medium|
|---|---|---|
| ||
phoenix_previewer -input=D:\PhoenixFDLiquid001_####.aur -output=D:\sim_image_####.png -prv_voxels=cust,5,temp:450:2000 -viewVelStreamlines=auto -prv_sect=0,150 |
...
| UI Text Box | size | medium|
|---|---|---|
| ||
phoenix_previewer -input=D:\PhoenixFDLiquid001_####.aur -output=D:\sim_image_####.png -prv_particles=auto -start=0 -end=10 |
...