Introduced
1.0
Description
Adds a custom parameter to a custom parameter set.
Scripting Syntax
SIAddCustomParameter( [InputObj], [ScriptName], [VarType], DefaultValue, [MinValue], [MaxValue], [Classification], [Capabilities], [SuggMin], [SuggMax], [ParamName], [Description] )
Parameters
|
Parameter |
Type |
Description |
|
InputObj |
List of custom parameter sets Default Value: Current selection |
|
|
ScriptName [in/out] |
Script name of the custom parameter to be added. This is normally a short name, like "rotx". A script name cannot have spaces in it. Default Value: "ParamName" |
|
|
VarType [in/out] |
Type of the parameter Default Value: siDouble |
|
|
DefaultValue [in/out] |
Default parameter value |
|
|
MinValue [in/out] |
minimum value of the parameter Default Value: 0.0 |
|
|
MaxValue [in/out] |
maximum value of the parameter Default Value: 1.0 |
|
|
Classification |
Determines the classification of the parameter (gives Softimage some hint about the purpose of the Parameter--see the siParamClassification enum for more details) Default Value: siClassifUnknown |
|
|
Capabilities [in/out] |
Determines the capabilities of the parameter (see the siCapabilities enum for more details) Default Value: 5 (siAnimatable + siPersistable) |
|
|
SuggMin [in/out] |
Suggested minimum value of the parameter (for UI controls) Default Value: MinValue |
|
|
SuggMax [in/out] |
Suggested maximum value of the parameter (for UI controls) Default Value: MaxValue |
|
|
ParamName |
A name for the parameter that can be more descriptive than the script name. For example "Rotation X" instead of "rotx". |
|
|
Description |
Description of the parameter |
See Also
Examples
• See SIAddCustomParameter.1.vbs
• See SIAddCustomParameter.2.vbs
Autodesk Softimage 2011