GetPrimWave
Creates a wave and applies it to the given objects.
Note: This command uses output
arguments. C# and some scripting languages (such as JScript,
PerlScript and Python) don't support arguments passed by reference
so you need to use the best workaround for your situation:
For scripting languages this command returns an ISIVTCollection which you can
use to get the output arguments.
For C# you can use the XSIApplication.ExecuteCommand
method to call this command. ExecuteCommand packs the output
arguments into a C# System.Object containing an Array of the output arguments (see
Calling
Commands from C#).
GetPrimWave( PresetObj, [InputObjs], [Name], [Parent], [Primitive] ); |
| Parameter | Type | Description | ||||
|---|---|---|---|---|---|---|
| PresetObj | String or a preset object (see SIGetPreset) | The Wave preset (one of the Control Object Primitives)
Default Value: "Wave"
|
||||
| InputObjs | String | List of objects to which the wave is applied. | ||||
| Name | String | Name of the wave. | ||||
| Parent | String | Parent object for the wave. | ||||
| Primitive | Primitive | Returns the wave primitive. |
dim list, wav set list = GetValue( "SelectionList" ) set wav = GetPrimWave( "Wave", list, , , prim ) SetValue prim & ".type", 1.000 |