Interface PRTExport

Interfaces > Core Interfaces > PlacementTool

The PRTExport interface exposes PRT export functionality for fluids. Note that defaults for the PRT export feature are stored in the 3dsmax.ini file, in the [Fluids] section, and may be directly edited there.

Available in 3ds Max 2018 Update 4 and higher.

Properties:

None

Methods:

    <bool>SetPRTFileVersion <integer>version

PRT files have two versions, 1 or 2. 3ds Max supports both, but version 2 is recommended as it provides additional axis orientation information. Returns true on success.

    <integer>GetPRTFileVersion()

Returns the .prt file version in effect: 1 or 2.

    <bool>SetExportOption <enum>channel <bool>export
       channel enums: {#position|#density|#velocity|#vorticity|#id|#age|#airDistance|#churn|#curvature|#droplet|#expansionRate|#stictionStrength|#stictionBandwidth|#uv}

If export is true, the specified channel is exported into the .prt file if it exists in the .bif simulation data. Returns true if successfully set.

    <bool>GetExportOption <enum>channel
       channel enums: {#position|#density|#velocity|#vorticity|#id|#age|#airDistance|#churn|#curvature|#droplet|#expansionRate|#stictionStrength|#stictionBandwidth|#uv}

Returns true if the specified channel is set to export, false otherwise.

    <bool>SetExportName <enum>channel <&TSTR>name       channel 
       channel enums: {#position|#density|#velocity|#vorticity|#id|#age|#airDistance|#churn|#curvature|#droplet|#expansionRate|#stictionStrength|#stictionBandwidth|#uv}
       name is In parameter

Sets the name to use for the given channel in the .prt file. For example, if you want the Bifrost "density" channel to be called "FluidDensity" in the .prt, call:

SetExportName #density "FluidDensity"

    <bool>GetExportName <enum>channel <&TSTR>name
       channel enums: {#position|#density|#velocity|#vorticity|#id|#age|#airDistance|#churn|#curvature|#droplet|#expansionRate|#stictionStrength|#stictionBandwidth|#uv}
       name is Out parameter

Gets the name used for the specified channel, returned in the name parameter. Returns true on success.

    <void>ResetSettings()

Resets the .prt export settings to startup condition; this resets to factory settings then loads the .ini file "Fluids" section settings.

Actions:

None