This page provides information on the Chaos Phoenix application programming interface (API).
The Chaos Phoenix API is included with the installation of Phoenix for Autodesk® Maya®. It provides C++ API for several different purposes:
Phoenix API is normally installed in the folder C:\Program Files\Chaos Group\Phoenix FD\Maya NNNN for x64\SDK where NNNN is the version of Maya (2020, 2019, etc).
The Phoenix API includes the following folders:
|
The Phoenix API 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 API depends on vutils_s.lib.
Using Phoenix API as a static library requires:
|
Using Phoenix API as a dynamic library requires:
|
Depending on the version of Maya, Phoenix API is built with the respective version of Microsoft Visual C++ Runtime:
Host Application | C++ Platform Toolset |
---|---|
Autodesk® Maya® 2018 Autodesk® Maya® 2019 Autodesk® Maya® 2020 Autodesk® Maya® 2022 | vc14 |
With "/MD" Runtime Library flag.
The Phoenix API comes with two code sample projects: GridView and CSVParticles.
Prerequisites:
The project uses CMake for generating project files. Additionally the following third party libraries have been used:
GLEW (http://glew.sourceforge.net/)
GLFW (http://www.glfw.org/) Tested with GLFW Version 3.0.4.
Zlib (http://www.zlib.net/). Needed if static version of Phoenix API is being used.
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 is a simple smoke rendering implemented in OpenGL. it is located in the \samples\GridView directory.
Prerequisites:
In order to build this sample, all external libraries must be located in a GridView/external_libs.
Build steps:
|
CSVParticles exports particle groups stored in Phoenix *.aur files to *.csv recognized by Thinkbox Krakatoa™ (http://www.thinkboxsoftware.com/krak-csv-file-format/).
Prerequisites:
In order to build this sample, all external libraries must be located in a CSVParticles/external_libs.
Build steps:
|