siArgumentHandler

siArgumentHandler

Description

Specifies the different ArgumentHandler objects available for Custom Commands. Please refer to the example on the ArgumentHandler page for a demo of these objects.

C# Syntax

StringModule.siArgHandlerAnimatableParameters                               // AnimatableParameters
StringModule.siArgHandlerCollection                                         // Collection
StringModule.siArgHandlerFrame                                              // Frame
StringModule.siArgHandlerFrameRate                                          // FrameRate
StringModule.siArgHandlerMarkedParameters                                   // MarkedParameters
StringModule.siArgHandlerSingleObj                                          // SingleObj

Constant	Value	Description
siArgHandlerAnimatableParameters	AnimatableParameters	This ArgumentHandler is identical to the MarkedParameters argument handler, except it filters out any parameters in the list which are not animatable. This is a convenient way to avoid having to write extra error handling code in the command implementation.
siArgHandlerCollection	Collection	When no argument value is specified this ArgumentHandler passes the current Selection to the Command. When a string is specified it is resolved into an XSICollection containing all the specified objects. Wildcards and lists of objects are supported with the same syntax as used by SelectObj. For example "", ".polymsh", "cube1,grid2,light1".
siArgHandlerFrame	Frame	When no argument value is specified this ArgumentHandler sends the current frame number as the value of the Argument. If a value (or default value) is specified for the Argument then this Argument Handler does nothing.
siArgHandlerFrameRate	FrameRate	When no argument value is specified this ArgumentHandler sends the current frame rate, for example 25. If a value (or default value) is specified for the Argument then this Argument Handler does nothing.
siArgHandlerMarkedParameters	MarkedParameters	This ArgumentHandler is similar to the Collection argument handler, except it deals with Marked Parameters (see Marked Parameters. When no argument value is specified this ArgumentHandler passes an XSICollection containing all the Parameters that have been marked on the selected objects. Note: Only the Selected objects are considered when determining the marking list. When a string value is specified Softimage attempts to resolve this into an XSICollection with the specified arguments. Wild cards such as "*" and "/" are supported. For example "Grid1,Grid2/Name" will resolve into the Parameters Grid1.Name and Grid2.Name.
siArgHandlerSingleObj	SingleObj	When no argument value is specified this ArgumentHandler passes NULL (an empty object) as the value. When a string is specified Softimage attempts to resolve it to an object. For example "MyGrid" would be converted to the X3DObject representing that Grid. In effect its behavior is similar to calling Dictionary.GetObject. When an object is specified the Argument Handler just passes it directly to the Command.

Applies To

Argument.Handler

ArgumentCollection.AddWithHandler

Argument::PutHandler

ArgumentArray::AddWithHandler

See Also

ArgumentHandler

Autodesk Softimage v7.5