Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page provides information on the Phoenix software development kit (SDKChaos Phoenix application programming interface (API).

Overview

...

The Chaos Phoenix FD SDK API is included with the installation of Phoenix FD for Autodesk® 3ds  3ds Max® and . It provides a C++ API for several different purposes:

  • Loading of grid and particle data stored in

...

  • AUR, VDB or F3D cache files.
  • Runtime access to the grid volume and particle shading core of a Phoenix Simulator node in 3ds Max, allowing you to read and shade this data in your own plugin.
  • Runtime access to different Phoenix nodes, allowing you to prepare them for rendering on demand, start and stop a simulation, access the parameters of different nodes, load and save presets.
  • Access to the Phoenix color gradients and diagram curves, allowing you to embed them in your own application.

 

Installation

...

The Phoenix FD SDK API is normally installed in "C:\Program Files\Chaos Group\Phoenix FD\3ds Max NNNN for x64\SDK" where NNNN is the version of 3ds Max (20172021, 20162020, etc).

 

Structure

...

The Phoenix FD SDK API includes the following folders:

Fancy Bullets
typecircle
  • \include – Contains the header files needed to interface with Phoenix FD SDKAPI.
  • \lib – Contains the Phoenix FD SDK API binaries for both static and dynamically linked versions of the Phoenix FD SDK API
  • \samples – Contains example projects that use Phoenix FD SDKdifferent functions of the Phoenix API.

 

Anchor
UsingPhoenixFDSDK
UsingPhoenixFDSDK

Using the Phoenix

...

API

...

The Phoenix API

...

Phoenix FD SDK is provided as a static and dynamic library. Depending on your project, you may pick the static or dynamic version of the library. Usually the dynamic version is preferred when there is a dependency to any version of V-Ray SDK, as Phoenix FD SDK API depends on vutils_s.lib.

Using Phoenix FD SDK API as a static library requires:

Fancy Bullets
typecircle
  • \lib\aurloader_s.lib and \lib\vutils_s.lib to be added as an additional dependency to the linker.

Using Phoenix FD SDK API as a dynamic library requires:

Fancy Bullets
typecircle
  • AURLOADER_DYNAMIC_LIB to be added the compiler settings as a preprocessor definition.
  • \lib\aurloader.lib to be added as an additional dependency to the linker.
  • \lib\aurloader.dll to be available at run time to the executable linked to \lib\aurloader.lib

 

  • .

...

Phoenix API Depending on the version of 3ds Max and the version of V-Ray, Phoenix FD SDK is built with the respective version of Microsoft Visual vc14 C++ Runtime:

...

Platform Toolset for all 3ds Max versions and for both V-Ray

...

Autodesk® 3ds Max® 2015

Autodesk® 3ds Max® 2016

Autodesk® 3ds Max® 2017

...

Autodesk® 3ds Max® 2018

Autodesk® 3ds Max® 2019

Autodesk® 3ds Max® 2020

...

With Next and V-Ray 5, with "/MD" Runtime Library flag.


Samples

...

The Phoenix FD SDK API comes with two code sample projects: GridView and CSVParticles.

...

See the License Agreements and Copyrights page for copyright notices.

Here is an archive containing those libraries: external_libs.

Note: This is just a collection of the libraries as we downloaded them from their respective official sites. We don't take any responsibility for the way the actual libraries work or affect your PC.

GridView

...

GridView is a simple smoke rendering implemented in OpenGL. it is located in the \samples\GridView directory.

...

Fancy Bullets
typecircle
  • Place all external libraries in GridView/external_libs.
  • Use CMake to generate project files that best suite you needs. Please take in account the C++ Platform Toolset that is used by your version of Phoenix FD SDKAPI. See the Using Phoenix FD SDKAPI section.
  • Set PHOENIX_SDK_DIR to Phoenix FD SDKAPI, for example "C:\Program Files\Chaos Group\Phoenix FD\3ds Max NNNN for x64\SDK".
  • Generate the project files and build.

CSVParticles

...

CSVParticles exports particle groups stored in Phoenix FD Phoenix *.aur files to *.csv recognized by Thinkbox Krakatoa (http://www.thinkboxsoftware.com/krak-csv-file-format/CSV File Format).

 

Prerequisites:

In order to build this sample, all external libraries must be located in a CSVParticles/external_libs.

...

Fancy Bullets
typecircle
  • Place all external libraries in CSVParticles/external_libs.
  • Use CMake to generate project files that best suite you needs. Please take in account the C++ Platform Toolset that is used by your version of Phoenix FD SDKAPI. See the Using Phoenix FD SDKAPI section.
  • Set PHOENIX_SDK_DIR to Phoenix FD SDKAPI, for example "C:\Program Files\Chaos Group\Phoenix FD\3ds Max NNNN for x64\SDK".
  • Generate the project files and build.

 

 

Viewtracker
hidetrue
expandablefalse
renderusernamesfalse

...