Namespace: Autodesk.Revit.DB.Lighting Class: LightGroupManager

LightGroupManager.SetLightDimmer

Method

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

Remarks:
The dimmer value is in the range [0.0, 1.0] with 0.0 being totally dimmed and 1.0 being totally on

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

Parameter	Type	Description
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]

Return Value

Exceptions

Exception	Condition
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