Custom Parameter Sets

 
 
 

A custom parameter set, also known as a custom property, provides a nice home for custom and proxy parameters, letting you organize them into meaningful groups. For example, you can have one custom parameter set for facial expressions, another for skeleton poses, and so on. In this way, you create your own custom property editor that includes only the parameters you want.

You can create as many custom parameter sets as you like for namable elements in your scenes.

This topics explains how to create a simple custom parameter set using the Softimage interface. However as an alternative to the technique described here, it is often preferrable to use the SDK to create self-installing custom properties — see Custom Properties [SDK Guide].

Simple parameter sets exist only in the scene in which they were created. They are not installed at the application level. You can copy a them to other objects in the same scene, or save a preset to apply them to objects in other scenes, but you have no control over the formatting or logic of the property editor.

Simple custom parameter sets are useful for creating a one-time control system for use in a single scene, or for prototyping a control system for more general use. You can convert them to script-based custom parameter sets later, if you wish.

Creating Custom Parameter Sets

  1. Select the element for which you want to create a parameter set. If you want to propagate the custom parameter set to an object's children, select the object in branch mode (middle-click).

  2. Choose Create Parameter New Custom Parameter Set from the Animate toolbar or choose the same command from the Animation menu in the Animation panel.

  3. In the New Custom Parameter Set dialog box, enter a Name for your custom parameter set.

    When you click OK, a node is created for this set under the object in the explorer.

    You can rename a custom parameter set in the same way as other elements in the explorer. See Renaming Scene Elements in the Explorer [Windows and Views].

  4. Add custom and/or proxy parameters to it as described in Creating Custom Parameters and Proxy Parameters.

Copying Custom Parameter Sets

When you copy a custom parameter set, its current parameters and values are duplicated on another object. You can then edit the values of the two parameter sets independently of each other. The two parameter sets do not share a data structure: if you change the name of one custom parameter set or add new parameters, the other set is not affected.

To copy a custom parameter set by dragging and dropping

  1. Select the custom parameter set by clicking on its name in an explorer.

  2. Press Ctrl while you drag-and-drop the custom parameter set onto another object. To apply the custom parameter in branch mode, drag with the middle-mouse button.

To copy a custom parameter set by pasting

  1. Select the custom parameter set by clicking on its name in an explorer.

  2. Choose Edit Copy from the main menu or press Ctrl+C.

  3. Select the object to which you want to apply the custom parameter set. To apply the custom parameter in branch mode, middle-click to select the object.

  4. Choose Edit Paste from the main menu or press Ctrl+V.

Using Custom Parameter Sets

After you've added custom or proxy parameters to a custom parameter set, you can use these parameters in the same way as any other parameter in Softimage.

For example, you can set values with the sliders, save keys, apply expressions, store actions, plot, and so on.

To open a custom parameter set

Do one of the following:

  • Click a custom parameter set's icon in the explorer. A property editor for only that parameter set opens.

    or

  • Select an object and choose Explore Custom/Proxy Parameter Sets from the main command area. This opens an explorer displaying all custom parameter sets for the object. Click a custom parameter set's icon to open it.

    or

  • Select the object and choose Create Parameter Edit Custom Parameter Sets from the Animate toolbar or choose the same command from the Animation menu in the Animation panel. A property editor opens with pages for each of the object's custom parameter sets.

    or

  • Select the object, right-click the Selection button on the Select panel, and choose Custom Properties. Again, a property editor opens with pages for each of the object's custom parameter sets.

    or

  • Select the object and choose Edit Custom Properties from the Edit panel. A property editor opens with pages for each of the object's custom parameter sets.

Tip

If you click the focus icon in this property editor, you can leave it open to display the custom parameters for any object you select.

Converting Simple Custom Parameter Sets to Self-installing

To convert a simple custom parameter set to a self-installing one, see Migrating Properties to Self-Installing [SDK Guide].

Deleting Custom Parameter Sets

  • Select it in the explorer and press Delete. The set and all the custom or proxy parameters in it are deleted.

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