Page History
...
Functions | Description | ||||||
A_SetSystem Parameters: system:<integer> Available options are: 0 - Object space 1 - World space 2 - Grid (voxel) space Return value: none | Specifies which coordinate system will be used. | ||||||
A_Inject Parameters: where:<point3> amount:<float> [temperature:<float>] [smoke:<float>] [velocity:<point3>] [RGB:<point3>] Return value : none | Injects fluid in a given point. Using this function, you can create your own procedural sources. The result of the function CAN NOT be achieved by calling one or more A_SetX functions, because they do not affect the quantity of the fluid, but only the parameters carried by the fluid. The injection of fluid in some point causes changes in the content only of the nearest 8 cells, but produces an outgoing flow in the entire grid. Nevertheless the function is not slower than the ordinary A_SetX function, because the outgoing flow appears later, when the simulation is executed. If A_GetV function is executed immediately after A_Inject in some near point, the velocity will not be changed. | ||||||
A_SetV Parameters: x:<integer> y:<integer> z:<integer> velocity:<point3> Return value : none | Sets the velocity of a cell. If a Simulator name is used, the function will write to the loaded cache, otherwise the function will write into the grid of the running simulator, if any. | ||||||
A_SetRGB Parameters: x:<integer> y:<integer> z:<integer> RGB:<point3> Return value : none | Sets the RGB of a cell. If a Simulator name is used, the function will write to the loaded cache, otherwise the function will write into the grid of the running simulator, if any. | ||||||
A_SetT Parameters: x:<integer> y:<integer> z:<integer> temperature:<float> Return value : none | Sets the Temperature of a cell. If a Simulator name is used, the function will write to the loaded cache, otherwise the function will write into the grid of the running simulator, if any. | ||||||
A_SetSm Parameters: x:<integer> y:<integer> z:<integer> smoke:<float> Return value : none | Sets the Smoke of a cell. If a Simulator name is used, the function will write to the loaded cache, otherwise the function will write into the grid of the running simulator, if any. | ||||||
A_SetFl Parameters: x:<integer> y:<integer> z:<integer> fuel:<float> Return value : none | Sets the Fuel of a cell. If a Simulator name is used, the function will write to the loaded cache, otherwise the function will write into the grid of the running simulator, if any. | ||||||
A_GetFl Parameters where:<Point3> Return Value: <float> | Gets the Fuel in a given point. If a Simulator name is used, the function will read from the loaded cache, otherwise the function will read from the running simulator, if any. | ||||||
A_GetV Parameters where:<Point3> Return Value: <point3> | Gets the Velocity in a given point. If a Simulator name is used, the function will read from the loaded cache, otherwise the function will read from the running simulator, if any. | ||||||
A_GetRGB Parameters where:<Point3> Return Value: <point3> | Gets the RGB in a given point. If a Simulator name is used, the function will read from the loaded cache, otherwise the function will read from the running simulator, if any. | ||||||
A_GetT Parameters where:<Point3> Return Value: <float> | Gets the Temperature in a given point. If a Simulator name is used, the function will read from the loaded cache, otherwise the function will read from the running simulator, if any. | ||||||
A_GetSm Parameters [node:<Simulator>] where:<Point3> Return Value: <float> | Gets the Smoke value in a given point. If a Simulator name is used, the function will read from the loaded cache, otherwise the function will read from the running simulator, if any. | ||||||
Parameters node:<Simulator> [cache: <String>] [startframe: <integer>] | Starts the simulation. Passing just the simulator node will start a new simulation. If you pass the path to a cache file, the effect is that of the Load & Start button in the Simulation rollout: the simulation state will be loaded from the cache and the simulation will continue from the specified Start Frame. If you manually pass the startframe index too, it takes precedence over the Load function and the simulation will be restored from the given frame, the same way that the Restore button works. This function will decide between simulation and re-simulation depending on the state of the Particle Resimulation and Grid Resimulation switches. | ||||||
A_StopSim Parameters node:<Simulator> | Stops the simulation | ||||||
A_Wait Parameters node:<Simulator> | This function halts the execution of the script until the specified simulator has finished running. Usually this function is used along A_StartSim when you want to run certain actions after the simulation is finished.
| ||||||
A_CreateParticle Parameters Particle group:<string> where:<Point3> [Radius:<float>] [Velocity:<Point3>] Return Value: none | Creates a new particle in a given position with given properties. | ||||||
A_Freeze Parameters: x:<integer> y:<integer> z:<integer> | Freezes the given cell. The frozen cell acts as a Solid object | ||||||
A_Unfreeze Parameters: x:<integer> y:<integer> z:<integer> | Unfreezes the given cell. Keep in mind that the simulator counts the freezing operations and you have to execute the same number of unfreezing operations to successfully unfreeze a cell | ||||||
A_QuickSetup Parameters: setup: <integer> Available options are: 0 - fire 9 - tap water Return Value: none | Creates a Quick Setup with the selected objects (the Quick Setup presets can be applied over a selection of several objects). | ||||||
Parameters node: <Simulator> preset path: <String> | Loads the specified render preset file. This is the same as using the Render Presets... menu from the Rendering rollout of the Simulator. The preset path can be a full path or use the $(dir) macro, which denotes the current scene file's directory. For example, the following will load "preset.tpr" from the current scene directory: A_LoadRenderPreset (getnodebyname "PhoenixFDFire001") "$(dir)\preset.tpr" | ||||||
A_SaveRenderPreset Parameters node: <Simulator> preset path: <String> | Saves a Phoenix FD render preset to a file with the current render and preview settings. This is the same as using the Render Presets... menu from the Rendering rollout of the Simulator. The preset path can be a full path or use the $(dir) macro, which denotes the current scene file's directory. | ||||||
A_LoadSimPreset Parameters node: <Simulator> preset path: <String> | Loads the specified simulation preset file. This is the same as using the Simulation Presets... menu from the Simulation rollout of the Simulator. The preset path can be a full path or use the $(dir) macro, which denotes the current scene file's directory. For example, the following will load "preset.tpr" from the current scene directory: A_LoadSimPreset (getnodebyname "PhoenixFDFire001") "$(dir)\preset.tpr" | ||||||
A_SaveSimPreset Parameters node: <Simulator> preset path: <String> | Saves a Phoenix FD simulation preset to a file. This is the same as using the Simulation Presets... menu from the Simulation rollout of the Simulator. The preset path can be a full path or use the $(dir) macro, which denotes the current scene file's directory. | ||||||
[available since Phoenix FD 4.10.04] A_GetGridSize Parameters node: <Simulator> channel name: <String> Return Value: <point3> | Retrieves the grid size of the running Simulator or the loaded cache file if a simulation is not running. Useful when using adaptive grid, in which case this.xc, this.yc and this.zc will return only the initial grid size. The name of the grid channel is reserved for future use. Currently all grid channels are the same size. |
Per-node functions
...
Phoenix FD also provides an an interface for getting grid data and loading render presets by typing in directly from the Simulator node.
Info |
---|
Example usage: $PhoenixFDFire001.getFuel (Point3 15 15 15) |
The available functions are:
getVersion – [available since Phoenix FD 4.10.04] Gets the currently installed Phoenix FD version.
setCoordSys – Specifies which coordinate system will be used.
...
1 - World space
2 - Grid (voxel) space
getGridSize – [available since Phoenix FD 4.10.04] Retrieves the grid size of the running Simulator or the loaded cache file if a simulation is not running.
loadRenderPreset – Loads a previously saved Phoenix FD render preset from a file.
saveRenderPreset – Saves a Phoenix FD render preset to a file with the current render and preview settings.
loadSimPreset – Loads a previously saved Phoenix FD simulation preset from a file.
saveSimPreset – Saves a Phoenix FD simulation preset to a file with the current render and preview settings.
getVelocity – Gets the Velocity value in a given point.
getRGB – Gets the RGB value in a given point.
getTemperature – Gets the Temperature value in a given point.
getSmoke – Gets the Smoke value in a given point.
getFuel – Gets the Fuel value in a given point.
...
reloadFrame – Forces a load on the cache frame for the current timeline time
getFrameInfo – Returns a string with information on the currently loaded cache frame. This is the info that you can find in the Simulation rollout's Cache File Content box.