LightFamily
Description:
This class encapsulates light family information.
This class encapsulates light family information.
Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.Lighting.LightFamily
System.Object
Autodesk.Revit.DB.Lighting.LightFamily
public class LightFamily : IDisposable
public void GetLightDataInFamilyDocument(Document familyDoc)
{
// LightFamily API should work only in light fixture family document.
if (familyDoc.OwnerFamily.FamilyCategory.BuiltInCategory == BuiltInCategory.OST_LightingFixtures)
return;
// Get the light family from the static method.
LightFamily lightFamily = LightFamily.GetLightFamily(familyDoc);
// Get the light source shape style and distribution style
LightShapeStyle shapeStyle = lightFamily.GetLightShapeStyle();
LightDistributionStyle distributionStyle = lightFamily.GetLightDistributionStyle();
// Get the light photometric for each family type
for (int index = 0; index < lightFamily.GetNumberOfLightTypes(); index++)
{
string typeName = lightFamily.GetLightTypeName(index); // the type name
LightType lightData = lightFamily.GetLightType(index); // the light data for each type
// How to get and set data in LightType object, please read help document for LightType class.
}
}
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| Dispose() | None | Releases all resources used by the LightFamily | |
| Equals | None | Determines whether the specified object is equal to the current object. (Inherited from Object ) | Object |
| GetHashCode | None | Serves as the default hash function. (Inherited from Object ) | Object |
| GetLightDistributionStyle() | LightDistributionStyle | Returns a LightDistributionStyle value for the light distribution | |
| GetLightFamily(Document) | LightFamily | Creates a light family object from the given family document | |
| GetLightShapeStyle() | LightShapeStyle | Returns a LightShapeStyle value for the light shape | |
| GetLightSourceTransform() | Transform | Returns a Transform value for the transform of light source. | |
| GetLightType(Int32) | LightType | Return a LightType object for the light type at the given index | |
| GetLightTypeName(Int32) | String | Return the name for the light type at the given index | |
| GetNumberOfLightTypes() | Int32 | Return the number of light types contained in this light family | |
| GetType | None | Gets the Type of the current instance. (Inherited from Object ) | Object |
| SetLightDistributionStyle(LightDistributionStyle) | None | Set the light distribution style to the given shape distribution | |
| SetLightShapeStyle(LightShapeStyle) | None | Set the light shape style to the given shape style | |
| ToString | None | Returns a string that represents the current object. (Inherited from Object ) | Object |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| IsValidObject | Boolean | Specifies whether the .NET object represents a valid Revit entity. |