Layer Class |
[Missing <summary> documentation for "T:Rhino.DocObjects.Layer"]

Namespace: Rhino.DocObjects
Assembly: RhinoCommon (in RhinoCommon.dll)

The Layer type exposes the following members.

Name | Description | |
---|---|---|
![]() | Layer | Initializes a new instance of the Layer class |
![]() | Layer(SerializationInfo, StreamingContext) | Initializes a new instance of the Layer class |

Name | Description | |
---|---|---|
![]() | Color |
Gets or sets the display color for this layer.
|
![]() | ComponentStatus |
Gets or sets the status of the layer.
(Overrides ModelComponentComponentStatus.) |
![]() | ComponentType |
Returns Layer.
(Overrides ModelComponentComponentType.) |
![]() | DeletedName |
Gets the name of a component that is deleted.
(Inherited from ModelComponent.) |
![]() | Disposed |
Indicates if this object has been disposed or the
document it originally belonged to has been disposed.
(Inherited from CommonObject.) |
![]() ![]() | FullPath |
Gets the full path to this layer. The full path includes nesting information.
|
![]() | HasId |
Returns a value indicating whether the component has an ID.
(Inherited from ModelComponent.) |
![]() | HasIndex |
Returns a value indicating whether the component has an Index.
(Inherited from ModelComponent.) |
![]() | HasName |
Returns a value indicating whether the component has a Name.
(Inherited from ModelComponent.) |
![]() | HasUserData |
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.) |
![]() | Id |
Gets or sets the ID of this layer object.
You typically do not need to assign a custom ID.
|
![]() | IdIsLocked |
Returns a value indicating whether the component ID is already locked.
(Inherited from ModelComponent.) |
![]() | IgesLevel |
Gets or sets the IGES level for this layer.
|
![]() | Index |
Gets or sets the model component index attribute.
(Inherited from ModelComponent.) |
![]() | IndexIsLocked |
Returns a value indicating whether the component Index is already locked.
(Inherited from ModelComponent.) |
![]() | IsComponentStatusLocked |
The component status itself can be locked. This returns an indication.
(Inherited from ModelComponent.) |
![]() | IsDeleted |
Gets a value indicating whether this layer has been deleted and is
currently in the Undo buffer.
|
![]() | IsDocumentControlled |
If true this object may not be modified. Any properties or functions that attempt
to modify this object when it is set to "IsReadOnly" will throw a NotSupportedException.
(Inherited from CommonObject.) |
![]() | IsExpanded |
Gets or sets a value indicating whether this layer is expanded in the Rhino Layer dialog.
|
![]() ![]() | IsLocked |
Gets or sets a value indicating the locked state of this layer.
|
![]() | IsReference |
Gets a value indicting whether this layer is a referenced layer.
Referenced layers are part of referenced documents.
|
![]() | IsSystemComponent |
True if this model component is a system constant.
(Inherited from ModelComponent.)An incomplete list of system constant model components is below:
|
![]() | IsValid | Tests an object to see if it is valid. (Inherited from CommonObject.) |
![]() | IsVisible |
Gets or sets the visibility of this layer.
|
![]() | LayerIndex |
Gets or sets the index of this layer.
|
![]() | LinetypeIndex |
Gets or sets the line-type index for this layer.
|
![]() ![]() | Name | Gets or sets the name of this layer. |
![]() | NameIsLocked |
Returns a value indicating whether the component Name is already locked.
(Inherited from ModelComponent.) |
![]() ![]() | ParentLayerId |
Gets the ID of the parent layer. Layers can be origanized in a hierarchical structure,
in which case this returns the parent layer ID. If the layer has no parent,
Guid.Empty will be returned.
|
![]() ![]() | PathSeparator |
The string "::" (colon,colon) is used to
separate parent and child layer names.
|
![]() | PlotColor |
Gets or sets the plot color for this layer.
|
![]() | PlotWeight |
Gets or sets the weight of the plotting pen in millimeters.
A weight of 0.0 indicates the "default" pen weight should be used.
A weight of -1.0 indicates the layer should not be printed.
|
![]() | RenderMaterial |
Gets or sets the RenderMaterial for objects on
this layer that have MaterialSource() == MaterialFromLayer.
A null result indicates that no RenderMaterial has
been assigned and the material created by the default Material
constructor or the RenderMaterialIndex should be used.
|
![]() | RenderMaterialIndex |
Gets or sets the index of render material for objects on this layer that have
MaterialSource() == MaterialFromLayer.
A material index of -1 indicates no material has been assigned
and the material created by the default Material constructor
should be used.
|
![]() | SortIndex |
Runtime index used to sort layers in layer dialog.
|
![]() | UserData |
List of custom information that is attached to this class.
(Inherited from CommonObject.) |
![]() | UserDictionary |
Dictionary of custom information attached to this class. The dictionary is actually user
data provided as an easy to use sharable set of information.
(Inherited from CommonObject.) |
![]() | UserStringCount |
Gets the amount of user strings.
|

Name | Description | |
---|---|---|
![]() | ClearId |
Resets the HasId property of the model component to false, if possible.
(Inherited from ModelComponent.) |
![]() | ClearIndex |
Resets the HasIndex property of the model component to false, if possible.
(Inherited from ModelComponent.) |
![]() | ClearName |
Resets the HasName property of the model component to false, if possible.
(Inherited from ModelComponent.) |
![]() ![]() | CommitChanges | |
![]() | ConstructConstObject |
Assigns a parent object and a subobject index to this.
(Inherited from CommonObject.) |
![]() | CopyAttributesFrom |
Copy typical attributes from another layer
|
![]() | DataCRC |
Increments the Cyclic Redundancy Check value by this instance.
(Inherited from ModelComponent.) |
![]() | Default |
Sets layer to default settings.
|
![]() | DeletePerViewportColor |
Remove any per viewport layer color setting so the layer's overall setting will be used for all viewports.
|
![]() | DeletePerViewportPlotColor |
Remove any per viewport layer plot color setting so the layer's overall setting will be used for all viewports.
|
![]() | DeletePerViewportPlotWeight |
Remove any per viewport layer plot weight setting so the layer's overall setting will be used for all viewports.
|
![]() | DeletePerViewportSettings |
Deletes per viewport layer settings.
|
![]() | DeletePerViewportVisible |
Remove any per viewport visibility setting so the layer's overall setting will be used for all viewports.
|
![]() | Dispose |
Actively reclaims unmanaged resources that this instance uses.
(Inherited from CommonObject.) |
![]() | Dispose(Boolean) |
For derived class implementers.
(Inherited from CommonObject.)This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method. You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true. Also, you must call the base virtual method within your overriding method. |
![]() | EnsurePrivateCopy |
If you want to keep a copy of this class around by holding onto it in a variable after a command
completes, call EnsurePrivateCopy to make sure that this class is not tied to the document. You can
call this function as many times as you want.
(Inherited from CommonObject.) |
![]() | Equals(Object) | (Inherited from Object.) |
![]() | Equals(Object) | (Overrides ObjectEquals(Object).) |
![]() | Equals(Layer) | |
![]() | Finalize |
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Inherited from CommonObject.) |
![]() | GetChildren |
Gets immediate children of this layer. Note that child layers may have their own children.
|
![]() ![]() | GetDefaultLayerProperties |
Constructs a layer with the current default properties.
The default layer properties are:
color = Rhino.ApplicationSettings.AppearanceSettings.DefaultLayerColor line style = Rhino.ApplicationSettings.AppearanceSettings.DefaultLayerLineStyle material index = -1 iges level = -1 mode = NormalLayer name = empty layer index = 0 (ignored by AddLayer) |
![]() | GetHashCode | (Inherited from Object.) |
![]() | GetHashCode | (Overrides ObjectGetHashCode.) |
![]() ![]() | GetLeafName(String) |
Get a layer name's "leaf" level name
|
![]() ![]() | GetLeafName(Layer) |
Get a layer name's "leaf" level name
|
![]() | GetObjectData |
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.) |
![]() ![]() | GetParentName(String) |
Get a layer's "parent" path name
|
![]() ![]() | GetParentName(Layer) |
Get a layer's "parent" path name
|
![]() | GetPersistentLocking |
The persistent locking setting is used for layers that can be locked by
a "parent" object. A common case is when a layer is a child layer
(Layer.ParentI is not nil). In this case, when a parent layer is locked,
then child layers are also locked. The persistent locking setting
determines what happens when the parent is unlocked again.
|
![]() | GetPersistentVisibility |
The persistent visbility setting is used for layers whose visibilty can
be changed by a "parent" object. A common case is when a layer is a
child layer (ParentId is not nil). In this case, when a parent layer is
turned off, then child layers are also turned off. The persistent
visibility setting determines what happens when the parent is turned on
again.
|
![]() | GetType | (Inherited from Object.) |
![]() | GetUserString |
Gets user string from this geometry.
|
![]() | GetUserStrings |
Gets a copy of all (user key string, user value string) pairs attached to this geometry.
|
![]() | HasPerViewportSettings |
Verifies that a layer has per viewport settings.
|
![]() | IsChildOf(Int32) | |
![]() | IsChildOf(Guid) | |
![]() | IsChildOf(Layer) | |
![]() | IsParentOf(Int32) | |
![]() | IsParentOf(Guid) | |
![]() | IsParentOf(Layer) | |
![]() ![]() ![]() | IsValidName |
Determines if a given string is valid for a layer name.
|
![]() | IsValidWithLog |
Determines if an object is valid. Also provides a report on errors if this
object happens not to be valid.
(Inherited from CommonObject.) |
![]() | LockId |
Locks the component Id property.
(Inherited from ModelComponent.) |
![]() | LockIndex |
Locks the component Index property.
(Inherited from ModelComponent.) |
![]() | LockName |
Locks the component Name property.
(Inherited from ModelComponent.) |
![]() | MemberwiseClone | (Inherited from Object.) |
![]() | NonConstOperation |
For derived classes implementers.
(Inherited from CommonObject.)Defines the necessary implementation to free the instance from being const. |
![]() | OnSwitchToNonConst |
Is called when a non-const operation first occurs.
(Inherited from CommonObject.) |
![]() | PerViewportColor |
Gets the display color for this layer.
|
![]() | PerViewportIsVisible |
Gets the per viewport visibility of this layer.
|
![]() | PerViewportPersistentVisibility |
Gets the per layer persistent visibility. The persistent visbility setting is used for layers whose visibilty can be changed by a parent layer.
In this case, when a parent layer is turned off, then child layers are also turned off.
The persistent visibility setting determines what happens when the parent is turned on again.
|
![]() | PerViewportPlotColor |
Gets the plot color for this layer.
|
![]() | PerViewportPlotWeight |
Gets the plot weight, in millimeters, for this layer.
|
![]() | SetPersistentLocking |
Set the persistent locking setting for this layer
|
![]() | SetPersistentVisibility |
Set the persistent visibility setting for this layer
|
![]() | SetPerViewportColor |
Sets the display color for this layer.
|
![]() | SetPerViewportPersistentVisibility |
Sets the per layer persistent visibility. The persistent visbility setting is used for layers whose visibilty can be changed by a parent layer.
In this case, when a parent layer is turned off, then child layers are also turned off.
The persistent visibility setting determines what happens when the parent is turned on again.
|
![]() | SetPerViewportPlotColor |
Sets the plot color for this layer.
|
![]() | SetPerViewportPlotWeight |
Sets the plot weight, in millimeters, for this layer.
|
![]() | SetPerViewportVisible |
Controls layer visibility in specific viewports.
|
![]() | SetUserString |
Attach a user string (key,value combination) to this geometry.
|
![]() | ToString | (Overrides ObjectToString.) |
![]() | UnsetPersistentLocking |
Remove any explicity persistent locking settings from this layer
|
![]() | UnsetPersistentVisibility |
Remove any explicit persistent visibility setting from this layer
|
![]() | UnsetPerViewportPersistentVisibility |
Remove any per viewport persistent visibility setting so the layer's overall setting will be used for all viewports.
|

Name | Description | |
---|---|---|
![]() ![]() | Equality | |
![]() ![]() | Inequality |

Rhino for Mac
Supported in: 5.4Rhino for Windows
Supported in: 6.8