If you’re writing a script, you can use SIAddCustomParameter to write a parameter name and description used only in scripts.
You can also leave spaces between words in the parameter name using this method. For more information, see the SDK Guide.
You can create simple custom parameters sets using the commands on the Create > Parameter menu of the Animate toolbar. These commands are also available on the Animation > Parameters menu on the Animation panel.
After you have created a simple parameter set, you can convert it to a script-based one, for example, if you want to distribute it to others or to have more control over the layout and logic. See Script-based Custom Parameter Sets.
Creating Custom Parameter Sets
To create a custom parameter set
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 [Interface and Tools].
4. Add custom and/or proxy parameters to it as described in Creating Custom Parameters and Creating Proxy Parameters.
To delete a custom parameter set
• Select it in the explorer and press Delete. The set and all the custom or proxy parameters in it are deleted.
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.
Custom parameters are parameters that you create to hold the data you define (data types, default values, and other options). Once you have created a custom parameter, you can connect it to other parameters in your scene to create custom controls (see Connecting Custom Parameters). You can create custom parameters for objects, models, clusters on objects, groups, and the scene root.
Custom parameters need to live in custom parameter sets. If you don’t already have a custom parameter set for an object, a default set is created when you create a custom parameter.
By default, custom parameters are added to the custom parameter set that was last created on a selected object. This can be useful if you’re adding custom parameters on an object that has multiple custom parameter sets.
1. Select the element or a custom parameter set to which you want to add custom parameters.
- If the element has no custom parameter set, a new one named CustomPset is created. You can rename this set later (in the explorer).
- If the element has only one custom parameter set, the new custom parameters are automatically added to it.
- If element has multiple custom parameter sets, select the parameter set to which you want to add the parameter. If you select the element instead of a specific set, the parameter is created in the custom parameter set that was last created.
2. Choose Create > Parameter > New Custom Parameter from the Animate toolbar, or press Shift+p, or choose the same command from the Animation menu in the Animation panel.
3. In the New Custom Parameter dialog box, set the options as desired:
- Parameter Name is the name used in property editors, explorers, scripting, and expressions to identify the parameter.
If there is already a parameter with the same name in the same custom parameter set, the property editor will display the name that you type but the name used in scripts and expressions will have a number is appended to it. For example, if there is already a parameter in the set named Sparky, the scripting names of additional parameters will be Sparky1, Sparky2, etc.
|
If you’re writing a script, you can use SIAddCustomParameter to write a parameter name and description used only in scripts. You can also leave spaces between words in the parameter name using this method. For more information, see the SDK Guide. |
- Value Type is the type of data the parameter can hold, such as Floating Point Number (that is, a decimal value), Text, Boolean, etc.
|
Select Text for the Value Type to store annotations for a custom parameter set—see Adding Notes to a Custom Parameter Set. |
- Value Range sets the minimum and maximum values for numeric parameters.
- UI Range gives you a slider range that is a subset of the full parameter range. For example, an angle can have any value but you may want the slider to only go from –180 to 180.
If you select Enable, the slider range uses the UI Minimum and Maximum values; otherwise, the whole parameter range is used.
For a description of the other options, see New Custom Parameter Dialog Box [Properties Reference].
4. Click OK. A new custom parameter is created and added to the custom parameter set.
5. You can now connect the custom parameter to linked parameters, expressions, or scripts—see Connecting Custom Parameters.
After you have created a custom parameter, you can change its name, value ranges, and UI ranges.
|
If you want to change the order of the custom parameters in the set, you must should convert the property to a script-based one — see Script-based Custom Parameter Sets. |
1. Do one of the following:
- Mark the custom parameter you want to edit and choose Create > Parameter > Edit Parameter Definition from the Animate toolbar.
If you mark multiple custom parameters, the Edit Custom Command property editor displays only the information from the custom parameter you marked first, but then all the marked parameters will take on the changes you make.
or
- In the explorer, right-click the custom parameter name and choose Edit Parameter Definition.
2. In the Edit Custom Parameter property editor, the current name and values are displayed, which you can edit as you like; however, you cannot edit the Value Type.
Any connections you have set up with expressions, linked parameters, or scripts are maintained.
|
If you have the custom parameter set property editor open, make sure to close and reopen it to see the changes you made to the custom parameters. |
Adding Notes to a Custom Parameter Set
You can add notes or comments to a custom parameter set by adding a Value Type Text parameter (see Creating Custom Parameters). Notes are a handy way of leaving information specific to using the custom parameter set you have created.
To leave notes using the Value Type - Text parameter
1. Select the custom parameter set.
2. Choose Create > Parameter > Custom Parameter from the Animate toolbar.
3. In the property editor, name this parameter Notes or something similar.
4. Add a text parameter by selecting Text from the Value Range list and click OK.
5. Open the custom parameter set and type the information you want to leave in the corresponding parameter’s text box.
You can delete custom and proxy parameters (animatable and non-animatable) individually.
|
You can see non-animatable parameters in the explorer if you activate the All Nodes (Scripting) filter in the explorer’s command bar. |
To delete custom parameters
1. Mark the custom parameter to delete.
2. Choose Create > Parameter > Remove Custom Parameter from the Animate toolbar, or choose the same command from the Animation menu in the Animation panel.
|
You cannot delete a custom parameter if its value is driven by the animation mixer. |
Autodesk Softimage v.7.5