LightTable
Inheritance Hierarchy
System.Object
Rhino.FileIO.CommonComponentTable. LightObject.
Rhino.DocObjects.Tables.RhinoDocCommonTable. LightObject.
Rhino.DocObjects.Tables.LightTable
Namespace: Rhino.DocObjects.Tables
Assembly: RhinoCommon (in RhinoCommon.dll)
Syntax
public class LightTable : RhinoDocCommonTable<LightObject>
The LightTable type exposes the following members.
Properties
Name
Description
Public Property
ComponentType
(Overrides
CommonComponentTable.T..ComponentType
.)Public Property
Count
Number of lights in the light table. Does not include Sun or Skylight.
(Overrides
CommonComponentTable.T..Count
.)Public Property
Document
Document that owns this light table.
Public Property
Item
Public Property
Skylight
Public Property
Sun
Gets the Sun instance that is applied to the document.
If the RDK is loaded, an instance is always returned.
Methods
Name
Description
Public Method
Add(Light)
Public Method
Add(Light, ObjectAttributes)
Public Method
Clear
Marks all items as deleted.
(Inherited from CommonComponentTable.T..)
Public Method
Delete(LightObject)
(Overrides
CommonComponentTable.T..Delete(T)
.)Public Method
Delete(Int32, Boolean)
Public Method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected Method
Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public Method
Find
Public Method
FindId
Uses the guid to find a model component. Deleted objects cannot be found by id. The guid is the value that is stored in the .Id property. In a single document, no two active objects have the same guid. If an object is replaced with a new object, then the guid persists. For example, if the _Move command moves an object, then the moved object inherits its guid from the starting object. If the Copy command copies an object, then the copy gets a new guid. This guid persists through file saving/opening operations. This function will not find grip objects.
(Inherited from CommonComponentTable.T..)
Public Method
FindIndex
Retrieves a object based on Index. This search type of search is discouraged. We are moving towards using only IDs for all tables.
Public Method
FindName
Finds the LightObject with a given name.
Deleted lights have no name.
Public Method
FindNameHash
Finds a LightObject given its name hash.
Public Method
GetEnumerator
(Overrides
CommonComponentTable.T..GetEnumerator.
.)Public Method
GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public Method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected Method
MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public Method
Code Example
Modify(Guid, Light)
Public Method
Modify(Int32, Light)
Public Method
ToString
Returns a string that represents the current object.
(Inherited from Object.)
Public Method
Undelete
Restores a light that has been deleted.