LayerTable

LayerTable class

Inheritence: Rhino.FileIO.CommonComponentTable<T>RhinoDocCommonTable<Layer>LayerTable
Derived Classes:

Namespace: Rhino.DocObjects.Tables
LayerTable: references

Properties (10)

ActiveCount

Returns number of layers in the layer table, excluding deleted layers.

ComponentType

Returns the actual component type of a table.

Count

Returns number of layers in the layer table, including deleted layers.

Count

Returns the count of all items, including deleted ones.

CurrentLayer

At all times, there is a "current" layer. Unless otherwise specified, new objects are assigned to the current layer. The current layer is never locked, hidden, or deleted. Returns reference to the current layer. Note that this reference may become invalid after a call to AddLayer().

CurrentLayerIndex

At all times, there is a "current" layer. Unless otherwise specified, new objects are assigned to the current layer. The current layer is never locked, hidden, or deleted. Returns: Zero based layer table index of the current layer.

Document

Document that owns this table.

Document

Document that owns this table.

Item

Conceptually, the layer table is an array of layers. The operator[] can be used to get individual layers. A layer is either active or deleted and this state is reported by Layer.IsDeleted.

Methods (52)

Add()

Adds a new layer with default definition to the layer table.

Add(Layer layer)

Adds a new layer with specified definition to the layer table.

Add(string layerName,Color layerColor)

Adds a new layer with specified definition to the layer table.

AddPath(string layerPath,Color layerColor)

Adds all of the layer in the specified layer path, beginning with the root. Layer paths contain one or more valid layers names, with each name separated by <b>ModelComponent.NamePathSeparator</b> . For example, "Grandfather::Father::Son".

AddPath(string layerPath)

AddReferenceLayer()

Adds a new reference layer with default definition to the layer table. Reference layers are not saved in files.

AddReferenceLayer(Layer layer)

Adds a new reference layer with specified definition to the layer table Reference layers are not saved in files.

Clear()

Marks all items as deleted.

CreateLayer(Layer newLayer, LayerType layerType, uint worksessionReferenceModelSerialNumber, uint linkedInstanceDefinitionSerialNumber)

Basic tool used by the add layer methods.

Delete(IEnumerable<int> layerIndices, bool quiet)

Deletes layers.

Delete(int layerIndex, bool quiet)

Deletes layer.

Delete(Layer layer, bool quiet)

Deletes layer.

Delete(Layer layer)

Deletes layer.

Delete(Guid layerId, bool quiet)

Deletes layer.

Delete(T item)

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

Duplicate(IEnumerable<int> layerIndices, bool duplicateObjects, bool duplicateSublayers)

Duplicates, or copies, one or more layers. Duplicated layers are added to the document.

Duplicate(int layerIndex, bool duplicateObjects, bool duplicateSublayers)

Duplicates, or copies, a layer. Duplicated layers are added to the document.

Find(string layerName, bool ignoreDeletedLayers)

Finds the layer with a given name. If multiple layers exist that have the same name, the first match layer index will be returned.
Deleted layers have no name.

Find(Guid layerId, bool ignoreDeletedLayers, int notFoundReturnValue)

Finds a layer with a matching ID.

Find(Guid layerId, bool ignoreDeletedLayers)

Finds a layer with a matching ID.

Find(Guid parentId, string layerName, bool ignoreDeletedLayers)

Finds a layer with a given name and matching parent ID.

Find(Guid parentId, string layerName, int notFoundReturnValue)

Finds a layer with a given name and matching parent ID.

FindByFullPath(string layerPath, bool ignoreDeletedLayers)

FindByFullPath(string layerPath, int notFoundReturnValue)

Searches for a layer using the fully qualified name, that includes ancestors.
Deleted layers have no name.

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 Layer object based on Index. This search type of search is discouraged. We are moving towards using only IDs for all tables.

FindName(string layerName, int startIndex)

Finds the next layer that has an index equal or higher than the searched value.
Search in case-insensitive.

FindName(string layerName)

Finds the layer with a given name. If multiple layers exist that have the same name, the first match layer index will be returned.
Deleted layers have no name.
The default layer is NOT included in the search. If required, use the overload with startIndex input.

FindNameHash(NameHash nameHash)

Finds a Layer given its name hash.

FindNext(int index, string layerName, bool ignoreDeletedLayers)

FindNext(int index, string layerName)

Use FindName(name, index).

ForceLayerVisible(int layerIndex)

Makes a layer and all of its parent layers visible.

ForceLayerVisible(Guid layerId)

Makes a layer and all of its parent layers visible.

GetEnumerator()

Returns the enumerator that yields all items.

GetSelected(out List<int> layerIndices)

Returns the indices of layers that are selected on the Layer user interface.

GetSorted()

Gets an array of layer indices that are sorted by the values of <b>Layer.SortIndex</b> .

GetUnusedLayerName()

Gets the next unused layer name used as default when creating new layers.

GetUnusedLayerName(bool ignoreDeleted)

Gets the next unused layer name used as default when creating new layers.

Modify(Layer newSettings, int layerIndex, bool quiet)

Modifies layer settings.

Modify(Layer newSettings,Guid layerId, bool quiet)

Modifies layer settings.

Purge(int layerIndex, bool quiet)

Deletes a layer and all geometry objects on a layer

Purge(Guid layerId, bool quiet)

Deletes a layer and all geometry objects on a layer.

Select(IEnumerable<int> layerIndices, bool bDeselect)

Selects layers in the Layer user interface.

SetCurrentLayerIndex(int layerIndex, bool quiet)

At all times, there is a "current" layer. Unless otherwise specified, new objects are assigned to the current layer. The current layer is never locked, hidden, or deleted.

Sort(IEnumerable<int> layerIndices)

Updates the layer sort order

SortByLayerName(bool bAscending)

Sort layers, in the layer table, by their name in either ascending or descending order. This function sorts layers in the same manner as Rhino's Layers panel.

Undelete(int layerIndex)

Undeletes a layer that has been deleted by DeleteLayer().

UndoModify(int layerIndex, uint undoRecordSerialNumber)

Restores the layer to its previous state, if the layer has been modified and the modification can be undone.

UndoModify(int layerIndex)

Restores the layer to its previous state, if the layer has been modified and the modification can be undone.

UndoModify(Guid layerId, uint undoRecordSerialNumber)

Restores the layer to its previous state, if the layer has been modified and the modification can be undone.

UndoModify(Guid layerId)

Restores the layer to its previous state, if the layer has been modified and the modification can be undone.

Nothing found