Input Files

SpeedTree Engine works primarily with a new file type called STE (SpeedTree Engine), introduced in SpeedTree Cinema 8.2. STE is a special variant of SPM, designed specifically for use with SpeedTree Engine. When STE files are exported, all possible textures the tree model might use are included, which is a different set than the SPM file uses. This different (and often much larger) texture set adds:

• Seasons: Every possible season configuration (e.g. summer, winter, and fall versions of the leaf textures), not just the textures visible at the time of export, as is done with traditional mesh exports like OBJ or FBX. This makes it possible to randomly access seasons from within the Engine API.

• Artistic Tuning: The effects of individual texture adjustments in Cinema (e.g. brightness, contrast, saturation) are captured and saved as their own pre-processed textures.

• Variations: When enabled upon export, the color variations of each material, as defined in Cinema, are also saved. One new texture per variation.

All of these can result in a good number of additional textures, but it’s necessary in order to capture the Cinema material definitions accurately. It ensures Cinema will work correctly with external applications and renderers.

SpeedTree Engine will also load traditional SPM (SpeedTree Procedural Models) files which are the type primarily loaded and saved by SpeedTree Cinema. However, SPM files will not contain the same accurate material information that STEs do and should be avoided in cases where materials are important. Use SPM files only when geometry or hierarchy information is needed or for quick prototyping/testing.

STE files are exported from SpeedTree Cinema 8 just like the common mesh formats (e.g. FBX or Alembic) via “Export Mesh…” from the File pulldown menu entry. They will export with every texture used as well as a companion STMAT file.

Engine will also process STMAT (SpeedTree Material) files, which are straightforward XML files that contain SpeedTree material definitions. STE files always have companion STMAT files because of the extra materials created during the STE export process (e.g. material variations). SPM files, however, do not have companion STMAT files.

Engine also contains functions for reading STMAT files directly that will return an array of the materials they contain.

Note: Always prefer STE files to SPM when materials matter.