LightGroupManager
Description:
This class represents a set of light groups that are used for easier management of various lighting scenarios
This class represents a set of light groups that are used for easier management of various lighting scenarios
public class LightGroupManager : IDisposable
public void AddRemoveLightGroupInManager(Document document, FamilyInstance lightOne, FamilyInstance lightTwo)
{
if (document.IsFamilyDocument) // it supports project document only.
return;
LightGroupManager groupMgr = LightGroupManager.GetLightGroupManager(document);
// Add a light group with a light
LightGroup lightGroup = groupMgr.CreateGroup("Group_One");
lightGroup.AddLight(lightOne.Id);
// Add another light group with another light.
lightGroup = groupMgr.CreateGroup("Group_Two");
lightGroup.AddLight(lightTwo.Id);
// Retrieve the added light group in the manager.
IList<LightGroup> existingGroups = groupMgr.GetGroups();
foreach (LightGroup group in existingGroups)
{
string groupName = group.Name;
}
// Remove one light group from the manager.
groupMgr.DeleteGroup(existingGroups[0].Id);
}
| Name | Return Type | Description |
|---|---|---|
| CreateGroup(String) | LightGroup | Create a new LightGroup object with the given name |
| DeleteGroup(ElementId) | None | Remove the given LightGroup object from the set of LightGroup objects |
| Dispose() | None | Releases all resources used by the |
| GetGroups() | IList<LightGroup> | Get the set of contained LightGroup objects The set of LightGroup objects |
| GetLightDimmer(ElementId, ElementId) | double | Gets the dimmer value for the given light for rendering the given view |
| GetLightGroupManager(Document) | LightGroupManager | Creates a light group manager object from the given document |
| IsLightGroupOn(ElementId, ElementId) | bool | Returns true if the given light group is on |
| IsLightOn(ElementId, ElementId) | bool | Returns true if the given light is on for rendering the given view |
| SetLightDimmer(ElementId, ElementId, Double) | None | Sets the dimmer value for the given light for rendering the given view |
| SetLightGroupOn(ElementId, ElementId, Boolean) | None | Turns the given light group on or off for rendering the given view depending on the bool argument |
| SetLightOn(ElementId, ElementId, Boolean) | None | Turns the given light on or off for rendering the given view depending on the bool argument |
| Name | Return Type | Description |
|---|---|---|
| IsValidObject | bool | Specifies whether the .NET object represents a valid Revit entity. |