RhinoCommon documentation has a new look. The old site can still be found here.

/

Rhino.DocObjects.Tables

/

LightTable

LightTable class

Inheritence: Rhino.FileIO.CommonComponentTable<T>RhinoDocCommonTable<LightObject>LightTable
Derived Classes:

Namespace: Rhino.DocObjects.Tables
LightTable: references

Properties (9)

ComponentType

ComponentType

Returns the actual component type of a table.

Count

Number of lights in the light table. Does not include Sun or Skylight.

Count

Returns the count of all items, including deleted ones.

Document

Document that owns this light table.

Document

Document that owns this table.

Item

Skylight

Sun

Gets the Sun instance that is applied to the document.
If the RDK is loaded, an instance is always returned.

Methods (16)

Add(Light light, ObjectAttributes attributes)

Add(Light light)

Clear()

Marks all items as deleted.

Delete(int index, bool quiet)

Delete(LightObject item)

Delete(T item)

Deletes an item. Items that are deleted are still keeping their space, but the 'IsDeleted' flag is checked.

Find(Guid id, bool ignoreDeleted)

FindId(Guid id)

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.

FindIndex(int index)

Retrieves a object based on Index. This search type of search is discouraged. We are moving towards using only IDs for all tables.

FindName(string name)

Finds the LightObject with a given name.
Deleted lights have no name.

FindNameHash(NameHash nameHash)

Finds a LightObject given its name hash.

GetEnumerator()

GetEnumerator()

Returns the enumerator that yields all items.

Modify(int index,Light light)

Modify(Guid id,Light light)

Undelete(int index)

Restores a light that has been deleted.

Nothing found