Creates a primitive light.
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#).
SIGetPrimLight( PresetObj, [Name], [Parent], [3DObject], [3DObjSpotInterest], [PrimObj], [PrimObjSpotInterest] ); |
Parameter | Type | Description |
---|---|---|
PresetObj | String or a preset object (see SIGetPreset) | Any preset for the Light Primitives |
Name | String | Name of the light. |
Parent | String | Parent object for the light. |
3DObject | Light | Returns the light object. |
3DObjSpotInterest | Null | Returns the interest for Spot and Light_Box lights (or Nothing for all other types). |
PrimObj | Primitive | Returns the light primitive. |
PrimObjSpotInterest | Primitive | Returns the spot interest primitive for Spot and Light_Box lights (or Nothing for all other types). |
SIGetPrimLight "Infinite", "MyLight" |