Properties
Returns number of layers in the layer table, excluding deleted layers.
Overrides: CommonComponentTable<T>.ComponentType
Returns number of layers in the layer table, including deleted layers.
Overrides: CommonComponentTable<T>.Count
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().
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.
Indexers
this[]
#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.
Remarks:
Detaching a worksession reference model, or purging a linked instance definition, removes its layers but leaves the table slots they occupied empty. The slots cannot be closed up, because table indices are persistent references that objects store - object attributes hold a layer index - so renumbering would repoint existing objects at the wrong layer. Count spans the empty slots, and they accumulate for the life of the document - one per purge.
An index that lands on an empty slot returns the document's default layer rather than throwing. Nothing about that layer says it is a stand-in: it reports the name "Default" and ordinary values for every other property, so enumerating a table that has been purged several times reports several layers that are not there. The one distinguishing mark is the index - a stand-in reports Index -1, never the index you asked for - so test index == Layers[index].Index before treating an entry as real. Enumerating the table with foreach goes through the document manifest rather than the raw table array, so it does not visit empty slots at all and is the safer way to walk the table. See RH-97389.
Parameters:
| index (int) | zero based array index. |
Returns: Reference to the layer. If layer_index is out of range, the current layer is returned. Note that this reference may become invalid after AddLayer() is called.
Methods
Adds a new layer with default definition to the layer table.
Returns: index of new layer.
Adds a new layer with specified definition to the layer table.
Parameters:
| layer (Layer) | definition of new layer. The information in layer is copied. If layer.Name is empty the a unique name of the form "Layer 01" will be automatically created. |
Returns: >=0 index of new layer -1 layer not added because a layer with that name already exists.
Adds a new layer with specified definition to the layer table.
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 ModelComponent.NamePathSeparator. For example, "Grandfather::Father::Son".
Parameters:
| layerPath (string) | The layer path. |
| layerColor (Color) | The color of newly created layers. The colors of layers that already exist will not be changed. |
Returns: The index of the last layer created if successful, RhinoMath.UnsetIntIndex on failure.
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 ModelComponent.NamePathSeparator. For example, "Grandfather::Father::Son".
Parameters:
| layerPath (string) | The layer path. |
Returns: The index of the last layer created if successful, RhinoMath.UnsetIntIndex on failure.
Adds a new reference layer with default definition to the layer table. Reference layers are not saved in files.
Returns: index of new layer.
Adds a new reference layer with specified definition to the layer table Reference layers are not saved in files.
Parameters:
| layer (Layer) | definition of new layer. The information in layer is copied. If layer.Name is empty the a unique name of the form "Layer 01" will be automatically created. |
Returns: >=0 index of new layer -1 layer not added because a layer with that name already exists.
Clear
public void Clear()
Marks all items as deleted.
[CLSCompliant(false)]
public int CreateLayer(Layer newLayer, LayerType layerType, uint worksessionReferenceModelSerialNumber, uint linkedInstanceDefinitionSerialNumber)
Basic tool used by the add layer methods.
Parameters:
| newLayer (Layer) | Settings for new layer. These are copied to the layer table entry and any user data on layer is moved to the layer table entry. |
| layerType (LayerTable.LayerType) | Type type of layer to create. |
| worksessionReferenceModelSerialNumber (uint) | Worksession reference model serial number, where: 0: Layer is not a reference layer. 1: Layer is a reference layer but not part of a worksession reference file. 2-1000: Reserved for future use. >1000: Worksession reference model serial number. |
| linkedInstanceDefinitionSerialNumber (uint) | Linked instance definition serial number, where: 0: Layer is not from a liked instance definition. 1-1000: Reserved for future use. >1000: Linked instance definition serial number. |
Returns: The index of the last layer created if successful, RhinoMath.UnsetIntIndex on failure.
Deletes layer.
Parameters:
| layerId (Guid) | Id of the layer to be deleted. |
| quiet (bool) | If true, no warning message box appears if a layer the layer cannot be deleted because it is the current layer or it contains active geometry. |
Returns: true if successful. false if layerIndex is out of range or the layer cannot be deleted because it is the current layer or because it layer contains active geometry.
Deletes layer.
Parameters:
| layerIndex (int) | zero based index of layer to delete. This must be in the range 0 <= layerIndex < LayerTable.Count. |
| quiet (bool) | If true, no warning message box appears if a layer the layer cannot be deleted because it is the current layer or it contains active geometry. |
Returns: true if successful. false if layerIndex is out of range or the layer cannot be deleted because it is the current layer or because it layer contains active geometry.
Deletes layer.
Parameters:
| layer (Layer) | Layer to be deleted. |
| quiet (bool) | If true, no warning message box appears if a layer the layer cannot be deleted because it is the current layer or it contains active geometry. |
Returns: true if successful. false if layerIndex is out of range or the layer cannot be deleted because it is the current layer or because it layer contains active geometry.
Deletes layer.
Parameters:
| layer (Layer) | Layer to be deleted. |
Returns: true if successful. false if layerIndex is out of range or the layer cannot be deleted because it is the current layer or because it layer contains active geometry.
Overrides: CommonComponentTable<T>.Delete
Deletes layers.
Parameters:
| layerIndices (IEnumerable<int>) | An enumeration containing the indices of the layers to delete. |
| quiet (bool) | If true, no warning message boxes will appear. |
Returns: the number of layers that were deleted.
public int[] Duplicate(IEnumerable<int> layerIndices, bool duplicateObjects, bool duplicateSublayers)
Duplicates, or copies, one or more layers. Duplicated layers are added to the document.
Parameters:
| layerIndices (IEnumerable<int>) | The indices of layers to duplicate. |
| duplicateObjects (bool) | If true, then layer objects will also be duplicated and added to the document. |
| duplicateSublayers (bool) | If true, then all sub-layers of the layer will be duplicated. |
Returns: The indices of the newly added layers if successful, an empty array on failure.
Duplicates, or copies, a layer. Duplicated layers are added to the document.
Parameters:
| layerIndex (int) | The index of the layer to duplicate. |
| duplicateObjects (bool) | If true, then layer objects will also be duplicated and added to the document. |
| duplicateSublayers (bool) | If true, then all sub-layers of the layer will be duplicated. |
Returns: The indices of the newly added layers if successful, an empty array on failure.
[EditorBrowsable(EditorBrowsableState.Never)]
public int Find(Guid layerId, bool ignoreDeletedLayers, int notFoundReturnValue)
Finds a layer with a matching ID.
Parameters:
| layerId (Guid) | A valid layer ID. |
| ignoreDeletedLayers (bool) | If true, deleted layers are not checked. |
| notFoundReturnValue (int) | Should be -1 to get the index of the OpenNURBS default layer, or UnsetIntIndex to get an always-out-of-bound value. |
Returns: The index of the found layer, or notFoundReturnValue.
[EditorBrowsable(EditorBrowsableState.Never)]
public int Find(Guid layerId, bool ignoreDeletedLayers)
obsoletenotFoundReturnValue should be specified. Add a third argument, its previous value was -1 but consider RhinoMath.UnsetIntIndex.
Finds a layer with a matching ID.
[EditorBrowsable(EditorBrowsableState.Never)]
public int Find(Guid parentId, string layerName, bool ignoreDeletedLayers)
obsoleteignoreDeletedLayers is no longer supported for research by name. Use the overload with notFoundReturnValue (-1 was the previous default).
Finds a layer with a given name and matching parent ID.
Parameters:
| parentId (Guid) | A valid layer ID. |
| layerName (string) | name of layer to search for. The search ignores case. |
| ignoreDeletedLayers (bool) | If true, deleted layers are not checked. NOT SUPPORTED FOR NAME SEARCH, only for Guids. |
Returns: >=0 index of the layer with the given name -1 no layer has the given name.
[EditorBrowsable(EditorBrowsableState.Never)]
public int Find(Guid parentId, string layerName, int notFoundReturnValue)
Finds a layer with a given name and matching parent ID.
Parameters:
| parentId (Guid) | A valid layer ID. |
| layerName (string) | name of layer to search for. The search ignores case. |
| notFoundReturnValue (int) | Should be -1 to get the index of the OpenNURBS default layer, or UnsetIntIndex to get an always-out-of-bound value. |
Returns: The index of the found layer, or notFoundReturnValue.
[EditorBrowsable(EditorBrowsableState.Never)]
public int Find(string layerName, bool ignoreDeletedLayers)
obsoleteignoreDeletedLayers is no longer supported for research by name. Use the overload with notFoundReturnValue (-1 was the previous default).
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.
[EditorBrowsable(EditorBrowsableState.Never)]
public int FindByFullPath(string layerPath, bool ignoreDeletedLayers)
obsoleteignoreDeletedLayers is no longer supported for research by name. Use the overload with notFoundReturnValue (-1 was the previous default).
Searches for a layer using the fully qualified name, that includes ancestors.
Deleted layers have no name.
Parameters:
| layerPath (string) | The full layer name. |
| notFoundReturnValue (int) | Should be -1 to get the index of the OpenNURBS default layer, or UnsetIntIndex to get an always-out-of-bound value. |
Returns: The index of the found layer, or notFoundReturnValue.
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.
Retrieves a Layer object based on Index. This search type of search is discouraged. We are moving towards using only IDs for all tables.
Parameters:
| index (int) | The index to search for. |
Returns: A Layer object, or null if none was found.
Finds the next layer that has an index equal or higher than the searched value.
Search in case-insensitive.
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.
Parameters:
| layerName (string) | name of layer to search for. The search ignores case. |
Returns: A layer, or null.
Finds a Layer given its name hash.
Parameters:
| nameHash (NameHash) | The name hash of the Layer to be searched. |
Returns: An Layer, or null on error.
[EditorBrowsable(EditorBrowsableState.Never)]
public int FindNext(int index, string layerName, bool ignoreDeletedLayers)
obsoleteignoreDeletedLayers is no longer supported for research by name. Use the overload with notFoundReturnValue (-1 was the previous default).
Use FindName(name, index).
Makes a layer and all of its parent layers visible.
Parameters:
| layerId (Guid) | The layer ID to be made visible. |
Returns: true if the operation succeeded.
Makes a layer and all of its parent layers visible.
Parameters:
| layerIndex (int) | The layer index to be made visible. |
Returns: true if the operation succeeded.
Overrides: CommonComponentTable<T>.GetEnumerator
GetSelected
#Returns the indices of layers that are selected on the Layer user interface.
Gets an array of layer indices that are sorted by the values of Layer.SortIndex.
Returns: An array of layer indices.
Gets the next unused layer name used as default when creating new layers.
Returns: An unused layer name string.
obsolete'ignoreDeleted' is now redundant. Layers are now permanently removed. Use the overload with this argument.
Gets the next unused layer name used as default when creating new layers.
Parameters:
| ignoreDeleted (bool) | If this is true then Rhino may use a name used by a deleted layer. |
Returns: An unused layer name string.
Modifies layer settings.
Modifies layer settings.
Parameters:
| newSettings (Layer) | This information is copied. |
| layerIndex (int) | zero based index of layer to set. This must be in the range 0 <= layerIndex < LayerTable.Count. |
| quiet (bool) | if false, information message boxes pop up when illegal changes are attempted. |
Returns: true if successful. false if layerIndex is out of range or the settings attempt to lock or hide the current layer.
Deletes a layer and all geometry objects on a layer.
Parameters:
| layerId (Guid) | Id of the layer to purge. |
| quiet (bool) | If true, no warning message box appears if a layer the layer cannot be deleted because it is the current layer. |
Returns: true if successful. false if layerIndex is out of range or the layer cannot be deleted because it is the current layer.
Deletes a layer and all geometry objects on a layer
Parameters:
| layerIndex (int) | zero based index of layer to delete. This must be in the range 0 <= layerIndex < LayerTable.Count. |
| quiet (bool) | If true, no warning message box appears if a layer the layer cannot be deleted because it is the current layer. |
Returns: true if successful. false if layerIndex is out of range or the layer cannot be deleted because it is the current layer.
Purges any unused layers.
Returns: The number of unused layers that were purged.
Selects layers in the Layer user interface.
Parameters:
| layerIndices (IEnumerable<int>) | The indices of layers to select. |
| bDeselect (bool) | If true, then any previously selected layers will be unselected. |
Returns: true if the layer user interface is visible, false otherwise.
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.
Parameters:
| layerIndex (int) | Value for new current layer. 0 <= layerIndex < LayerTable.Count. The layer's mode is automatically set to NormalMode. |
| quiet (bool) | if true, then no warning message box pops up if the current layer request can't be satisfied. |
Returns: true if current layer index successfully set.
Updates the layer sort order
Parameters:
| layerIndices (IEnumerable<int>) | The sort order. |
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.
Remarks: This function changes the value of Layer.SortIndex. It does not change the index order of layers in the layer table.
Parameters:
| bAscending (bool) | Sort in ascending (true) or descending (false) order. |
Parameters:
| item (Layer) |
Undeletes a layer that has been deleted by DeleteLayer().
Parameters:
| layerIndex (int) | zero based index of layer to undelete. This must be in the range 0 <= layerIndex < LayerTable.Count. |
Returns: true if successful.
Restores the layer to its previous state, if the layer has been modified and the modification can be undone.
Restores the layer to its previous state, if the layer has been modified and the modification can be undone.
Parameters:
| layerId (Guid) | The layer Id to be used. |
Returns: true if this layer had been modified and the modifications were undone.
Restores the layer to its previous state, if the layer has been modified and the modification can be undone.
Restores the layer to its previous state, if the layer has been modified and the modification can be undone.
Parameters:
| layerIndex (int) | The layer index to be used. |
Returns: true if this layer had been modified and the modifications were undone.