LightGroupManager.SetLightDimmer Method

LightGroupManagerSetLightDimmer Method

Sets the dimmer value for the given light for rendering the given view

Namespace: Autodesk.Revit.DB.Lighting
Assembly: RevitAPI (in RevitAPI.dll) Version: 26.0.4.0 (26.0.4.0)
Syntax
public void SetLightDimmer(
	ElementId viewId,
	ElementId lightId,
	double dimmingValue
)
Public Sub SetLightDimmer ( 
	viewId As ElementId,
	lightId As ElementId,
	dimmingValue As Double
)
public:
void SetLightDimmer(
	ElementId^ viewId, 
	ElementId^ lightId, 
	double dimmingValue
)
member SetLightDimmer : 
        viewId : ElementId * 
        lightId : ElementId * 
        dimmingValue : float -> unit

Parameters

viewId  ElementId
The Id of the view
lightId  ElementId
The Id of the light to turn on or off
dimmingValue  Double
The dimmer value to set int the range of [0.0, 1.0]
Exceptions
ExceptionCondition
ArgumentException The given element Id does not correspond to a 3d view -or- The given element Id does not correspond to a light instance -or- The given dimming value is not in the range [0.0, 1.0]
ArgumentNullException A non-optional argument was null
Remarks
The dimmer value is in the range [0.0, 1.0] with 0.0 being totally dimmed and 1.0 being totally on
See Also

M:Autodesk.Revit.DB.Lighting.LightGroupManager.SetLightDimmer(Autodesk.Revit.DB.ElementId,Autodesk.Revit.DB.ElementId,System.Double)