LightGroupManager

Public Class

This class represents a set of light groups that are used for easier management of various lighting scenarios

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.Lighting.LightGroupManager

Namespace: Autodesk.Revit.DB.Lighting

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class LightGroupManager : IDisposable

The LightGroupManager type exposes the following members.

Properties

Name

Description

---

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

---

Methods

Name

Description

---

Public Method

CreateGroup

Create a new LightGroup object with the given name

---

Public Method
DeleteGroup

Remove the given LightGroup object from the set of LightGroup objects

---

Public Method

Dispose

Releases all resources used by the LightGroupManager

---

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

---

Public Method

GetGroups

Get the set of contained LightGroup objects The set of LightGroup objects

---

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

---

Public Method
GetLightDimmer

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

---

Public Method
Static Member

GetLightGroupManager

Creates a light group manager object from the given document

---

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

---

Public Method

IsLightGroupOn

Returns true if the given light group is on

---

Public Method

IsLightOn

Returns true if the given light is on for rendering the given view

---

Public Method
SetLightDimmer

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

---

Public Method

SetLightGroupOn

Turns the given light group on or off for rendering the given view depending on the bool argument

---

Public Method

SetLightOn

Turns the given light on or off for rendering the given view depending on the bool argument

---

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

---

Example

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);
}