Forest Tools

Overview

Forest Tools is a utility that allows you to convert a forest object to individual instanced geometry. This can be used when you need to share a file with someone who does not have the forest plugin, use a renderer that does not natively support Forest Pack, or export the scene to another program.

In this section:

Procedures

To add Forest Tools to the Utilities panel

  1. From the Command Panel click  to open the Utilities Panel.
  2. Click  to open the Configure Button Sets menu.
  3. From the Utilities list on the left, drag Itoo Software > Forest Tools to an empty button slot on the right. If necessary increase the number of buttons using the Total Buttons spinner.
     
  4. Click OK.

To create instances from a Forest Pack object

  1. Select the Forest object to instantiate.
  2. Open Forest Tools from the Utilities Panel.
  3. In the objects group activate Move to layer and enter a name for the new layer.

    It is also possible to add instances to the current layer or add them to a new group, however creating a new layer is recommended for more efficient scene management.

  4. Optionally select the Freeze checkbox to freeze the layer and select the Boxes checkbox speed up viewport performance by displaying instances as boxes.

  5. Click Instantiate.

To delete existing instances

  1. Select a Forest Object that has previously been used to create instances.
  2. Open Forest Tools from the Utilities Panel.
  3. From the Objects group, click Delete.

To update instances 

  1. Select the Forest object to update.
  2. Open Forest Tools from the Utilities Panel.
  3. If there are instances already in the scene that you need to replace, from the Objects group click on the Auto delete old items checkbox. This will delete any existing instances before creating new ones. Alternatively to remove them immediately click on Delete.
  4. If the forest object is disabled, click Enable and make the necessary changes. If the Forest object is disabled and you do not need to enable it to make the changes, ensure that the Enable before start checkbox is selected.
  5. To automatically disable the Forest object after instances have been created, select the Disable at end checkbox.
  6. Click Instantiate.

To optimise materials for the active renderer

  1. Open Forest Tools from the Utilities Panel.
  2. Click Optimize in the Material Optimizer section. The material optimizer tool will open.
  3. From the Render Engine drop down list, pick the current render engine (this should be automatic).
  4. From the Apply to drop down list, select whether to run the optimizer on the current Selection or the Material Library.
  5. For most situations the default settings are suitable. To exclude specific diffuse maps from being optimized, enter their names, separated by commas, in the Exclude materials using these names text box.
  6. Click Optimize.

To export XML data

  1. Select a Forest Pack object
  2. Go to the Command Panel > Utilities and click Forest Tools.
     
  3. Click Export Data.
     
  4. From the Forest Data Exporter utility set a save path by clicking 
  5. Enable the IDs of the channels you want to export.
  6. Click Export.

 

Interface 

Instantiate

Converts the geometry items of the selected Forest object to instances.

Objects

Individual objects

When enabled, creates instances as stand-alone objects.

Create group

When enabled, adds all instances to a new groups.

 3DS may be very slow handling a huge number of objects in a group, most of times is better to put them as non grouped objects in a separate layer.

Move to layer

When enabled, creates a new layer and moves the instances to it. Use with the following options:

  • Freeze. Freezes the new layar
  • Boxes. Displays new instances as boxes, useful for improving viewport performance with large numbers of instances or complex meshes. 

Auto delete old items

When enabled, old instances are removed before creating new objects.

Delete

Removes instances manually. This only works if the instances and the Forest object and the have not been renamed .

Geometry List

Disable at end

When the instances are created, we don't need anymore the trees created by the Forest object in the scene. To hide them, Forest Tools set the elements of the Geometry List to "Disabled". So, if you would like to recover the Forest mesh, set the Geometry back to "Custom Object". If this checkbox is disabled, Forest Tools doesn't modify the Geometry List.

Enable before start

Sets the Geometry to "Custom Mesh" automatically before creating the instanced objects.

Enable

Used to set the "Custom Mesh" mode in the Geometry List manually (of the selected Forest object).

Forest Exporter

Export Data. Click this button to open the XML exporter tool. Using this menu you can export most of the internal options in a standardised format for use in advanced pipelines and to aid interoperability between software.

Click to set the save path for the XML file.
ID ...
Enables the data channels to be exported. By default all are selected.
Click to select all IDs.
Click to deselect all IDs.
Click to save the XML data to disk.
Click to close the XML export utility.

Accessing Forest Exporter using Maxscript

To export all the Forest objects in a scene to an XML file using maxscript, you use the following command:

Forest_pro.ForestPack.exportData <file> <list of fields separated by spaces>

For example:

Forest_pro.ForestPack.exportData "c:\\tmp\\data.xml" "geomID colorID size"

 

Material Optimizer

Runs the Material Optimizer for the selected Forest objects. See Materials for more information about this tool.