Object Hierarchy | Related C++ Class: Argument
Inheritance
SIObject
Argument
Introduced
2.0
Description
The Argument object represents an argument (or "parameter") of a Softimage Command. For example the DeleteObj command takes 1 argument ("InputObj"). You add arguments to custom commands using the ArgumentCollection.Add, ArgumentCollection.AddWithHandler or ArgumentCollection.AddObjectArgument method.
Argument objects are used in three circumstances in Softimage:
- For defining command arguments at creation time When a command is created, arguments are added to the Command object and the Argument.Value is set to define the default value for that argument. This default value is persisted and is used as the argument value in the case that no value is specified at invocation time.
- For specifying argument values when invoking a command. When a command is invoked, Argument.Value is used to specify the value of the argument that will be passed to the command. You may also define an ArgumentHandler to get a default value based on the selection or the scene content. You can create an argument with a handler using the ArgumentCollection.AddWithHandler method.
-In the third case it is possible to change the definition of a custom command after it has been installed. In this case Argument.Value is used to specify new default values for the command, and it is possible to add and remove arguments. Then Command.Update is called to commit the changes.
For a detailed description of the workflow for creating custom commands, see the Command object.
Methods
Properties
|
|
|
|
Examples
• See Argument.1.js
• See Argument.2.vbs
• See Argument.3.vbs
Autodesk Softimage 2011