Setting Values After a Scene Has Loaded (Auxiliary Files)

An auxiliary data file contains a sequence of values to that can be set once a scene finished loading. All parameters are set sequentially prior to registered OnEndSceneOpen events.

Auxiliary data is especially useful for batch rendering as it provides a simple way to modify various parameters of a scene without having to modify the scene file.

Note

You cannot apply auxiliary data to SI3D scenes and models directly. You have to import the SI3D scene or model and save it in the Softimage scene format first.

Loading and Applying Auxiliary Data

To apply auxiliary data in Softimage, you have to specify which file contains the values you want to set with the -auxiliary_data switch.

If your auxiliary data file is named c:\myData.txt, type the following at the command line:
```
xsi -auxiliary_data c:\myData.txt
```
This creates a new check box labeled Apply Auxiliary Data in the Open Scene dialog box.
Turn this option on to apply the auxiliary data when a scene is opened. This is a very convenient way to test if your auxiliary data is applied correctly.

To apply auxiliary data with scripting

You can use scripting to apply previously loaded auxiliary data. For example, if you want to apply auxiliary data to your scene called c:\MyProject\Scenes\MyScene.scn, use the following command:

OpenScene "c:\MyProject\Scenes\MyScene.scn",,TRUE

Note

Auxiliary data is not applied by default in both cases (through the interface and scripting).

To apply auxiliary data from the command line

You can apply auxiliary data automatically to a scene from the command line by typing either of these lines at the prompt:

xsi c:\MyProject\Scenes\MyScene.scn -auxiliary_data c:\myData.txt

XSIBatch -r -scene c:\MyProject\Scenes\MyScene.scn -auxiliary_data c:/myData.txt

Defining an Auxiliary Data File

The auxiliary data file format is a plain ASCII file that must start with the following header:

XSI_AuxiliaryDataFile ASCII 1 0

The header identifies the file as a v1.0 Auxiliary data file in plain ASCII. At the time being, there is no other format but we might introduce other file formats in the future.

Lines following the header can be:

Comments (lines starting with //)

Comments cannot be put anywhere else but on the start of a line, unlike C++ style comments.
White space (carriage returns, tabs, or spaces)
Parameters

Parameters use the same syntax as the argument of the SetValue command called with VBScript. For instance using this line in your auxiliary file:
```
"Passes.Default_Pass.RenderOptions.EndFrame", 1
```
... has the same effect as calling using this command in Softimage:
```
SetValue "Passes.Default_Pass.RenderOptions.EndFrame", 1
```
Note
Make sure that every parameter in the auxiliary data file fits on a single line.

Except where otherwise noted, this work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License