CPSet Wizard

| Plug-in Info | Add Parameter | Layout (Optional)

Creates a rough template for a script-based custom parameter set, including stubs for callback functions. To use this wizard:

Do one of the following:
- To build the parameter set from scratch, select an element on which to apply the custom property and choose Create Parameter Custom Property Wizard from the Animate toolbar.
- To base the scripted parameter set on a simple one in your scene, open the simple parameter set in a property editor, then right-click in the light gray header bar of the property editor and choose Migrate to Self-installed.

The CPSet Wizard property editor opens.

On the Plug-in Info tab, enter general information about your parameter set.
Use the Add Parameter tab to create each element you want in your parameter set. First select the desired ParamType, then enter the appropriate information, and finally click Add Item. To separate items on different tabs, set ParamType to Tab. You should try to add items in the order in which you want them to appear, but you can always change the order later in step 6.
If desired, use the Layout (Optional) tab to define how your parameter set appears in a property editor.
To preview your parameter set, click Generate Property. A script file is created and opened in a text editing window, and the parameter set's property editor is displayed.
If desired, return to the CPSet Wizard to refine your parameter set, for example, to add more items or modify the items listed in the Parameters grid, and then repeat the previous step.

If you close the wizard, you can re-open it by clicking the CPSetWizard node under the Scene_Root in an explorer.
Once you are satisfied with the rough template, finish your parameter set by editing the generated script. For example, you can:
- Define the actions performed by callback functions.
- Give a parameter a label that is different than the script name (such as a friendly name with spaces in it).
- Dynamically change the layout based on user options.
- Define combo boxes and other more advanced controls.
- Refine the layout, for example, place multiple controls on the same line.
- Tweak the appearance of the controls, for example, hide a label, set the number of decimal places in a slider, and so on.

Once you have modified the script manually, do not regenerate the property. Doing so will overwrite your modifications.

Plug-in Info

Property Name	The name to use for your custom parameter set.
Author	Identifies the author of the custom parameter set. Enter your name or your organization if desired. This information is displayed when you click Details in the Plug-in Manager.
Script Language	The scripting language used to generate your custom parameter set.
Add to Menu	Specifies a menu location to add the property.

Existing Custom Property

Model Property	The name (model.object.property) of a simple, non-script-based parameter set that you want to convert to self-installing. Click the browse (...) to pick an existing property from a scene explorer.
Output Directory	The path where you want the script file created.
Generate Property	Generates a script that defines the custom parameter set according to the options you have specified. The script opens in a text editing window, and the parameter set's property editor is displayed.

Add Parameter

Define Item

ParamType	The type of data the item can hold. You can also use this option to define buttons, tabs, and so on. Depending on the ParamType, some of the attributes below may not be available.
Name/Label	The name used in property editors, explorers, scripting, and expressions to identity the parameter. Spaces and other illegal characters are replaced by underscores.
ReadOnly	When on, the value of the custom parameter cannot be modified interactively by users. Read-only parameters can still by modified by scripting commands or the object model.
Animatable	Determines whether the parameter can be animated.
Callback	Creates a stub for a function that gets called when users adjust the parameter. The function is called PropertyName_ParameterName_OnChanged( ), PropertyName_TabName_OnTab( ), or PropertyName_ButtonName_OnClicked( ), depending on the type of item. The callback function is called when the value is changed in any way, including by a script command, while the property editor is open. In certain situations, it may also be called when playback is started or stopped while the property editor is open.
Default	The default value of the parameter.

Value Range

Min	The minimum value for a numeric parameter.
Max	The maximum value for a numeric parameter.

UI Range

The slider for a numeric parameter can have a smaller range than the Min and Max parameter values. In such cases, users can enter values outside the slider range using the keyboard.

UIRange	Allows the slider range to be smaller than the Value Range. If this is off, the slider uses the Value Range.
UI Min	The minimum values of the slider in the custom parameter-set property editor.
UI Max	The maximum value of the slider in the custom parameter-set property editor.
Add Item	Adds an item to the parameter set based on the options above. All items that have been added so far are listed in the Parameters section below.

Parameters

Lists the items that have been added to the parameter set and their attributes in a grid. You can modify items by clicking in a cell and typing a new value.

Generate Property

Generates a script that defines the custom parameter set according to the options you have specified. The script opens in a text editing window, and the parameter set's property editor is displayed.

Layout (Optional)

If desired, use the Layout (Optional) tab to define how your parameter set appears in a property editor:

To add a parameter to the layout, select it under Parameters and click Add.
To change the order of items, select them under Layout and click Up or Down.
To group items in tabs or group boxes, enter a name in the Name box and click Add Tab or Add Group. Use Up and Down to move items between the braces to add them to the groupings.
To put multiple parameters or groups on the same row, click Add Row and then use Up and Down to move items between the braces of the Row item.
To remove any item, select it under Layout and click Remove.

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