LightType.SetInitialColor
Method
Description:
Replace the current initial color object with the given object
Replace the current initial color object with the given object
Remarks:
The argument object is cloned
The argument object is cloned
Examples
public void SetInitialColorProperty(LightType lightType)
{
InitialColor initialColor = lightType.GetInitialColor();
if (initialColor is CustomInitialColor)
{
CustomInitialColor custom = initialColor as CustomInitialColor;
double colorTemperature = custom.Temperature;
// Set new value for color temperature and set modified initial color to LightType.
custom.Temperature = 3450.0;
lightType.SetInitialColor(custom);
// Create a PresetInitialColor and set it to LightType.
PresetInitialColor preset = new PresetInitialColor(ColorPreset.Halogen);
lightType.SetInitialColor(preset);
}
}
Parameters
| Parameter | Type | Description |
|---|---|---|
| initialColor | InitialColor | An object derived from an InitialColor object The object pointed to is cloned internally |
Return Value
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | A non-optional argument was null |