Skip to main content

SpeedTree Artist Docs

SpeedTree Addon - 0.1.0

About SpeedTree Addon​

The SpeedTree AYON integration lets you:

  • Export your vegetation files in fbx format with xml file as versioned publishes for others to load and update in the third-party software.

Working with AYON in SpeedTree​

Launch SpeedTree via AYON Launcher​

Once your admin configures AYON to work with SpeedTree, you'll find the SpeedTree icon in the launcher.

Initialize Workfile​

Admins can configure the SpeedTree addon to automatically initialize a workfile when launching SpeedTree from the launcher. If your admin has set it up, you won't need to choose the spm to start your project.

For more info, see Custom Template Path.

note

Once SpeedTree launched and spm project is automatically created, a Blank.spm file or any predefined template spm is saved as a local temp file by default. Make sure to use the Work Files tool to save your files; otherwise, your work inside Blank.spm will be lost if you close the SpeedTree application.

AYON Global Tools​

You can access AYON toolset in SpeedTree via floating window containing AYON tools.

note

Due to the limitations of the SpeedTree API, the AYON menu must function as a standalone floating UI element. Since it cannot be integrated or accessed directly from the host application, users are unable to close the window using the standard close icon.

Create and Publish Products​

Publishing Model​

Navigate to AYON -> Publish -> Create to create publish instance for the foliage which need to be published.

Switching to AYON -> Publish and hitting Publish button will produce a 3d model (FBX) along with .xml file storing the data of the foliage.

Load Product​

Load Workfile​

Navigate to AYON -> Load to load any already published workfile products which replaces your current active scene and become new work file version automatically.

note

Due to API limitations of Speedtree there is currently only limited support of AYON Loader tool which can be only used for opening workfile products e.g. ingested into the Project using Tray Publisher beforehand allowing for customization to some degree.