Layer Class

Initializes a new instance of the Layer class

Gets or sets the display color for this layer.

Gets or sets the status of the layer.

Returns Layer.

Gets the name of a component that is deleted.

Indicates if this object has been disposed or the document it originally belonged to has been disposed.

Gets the full path to this layer. The full path includes nesting information.

Returns a value indicating whether the component has an ID.

Returns a value indicating whether the component has an Index.

Returns a value indicating whether the component has a Name.

Gets true if this class has any custom information attached to it through UserData.

Gets or sets the ID of this layer object. You typically do not need to assign a custom ID.

Returns a value indicating whether the component ID is already locked.

Gets or sets the IGES level for this layer.

Gets or sets the model component index attribute.

Returns a value indicating whether the component Index is already locked.

When a component is in a model as part of the information required for a linked instance definition, this value identifies the linked instance definition reference model.

The component status itself can be locked. This returns an indication.

Returns true if the layer is the current layer.

Gets a value indicating whether this layer has been deleted and is currently in the Undo buffer.

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.

Gets or sets a value indicating whether this layer is expanded in the Rhino Layer dialog.

Gets or sets a value indicating the locked state of this layer.

Gets a value indicting whether this layer is a referenced layer. Referenced layers are part of referenced documents.

Returns true if the layer is a parent layer of the layer tree from a linked instance definition or the layer tree from a worksession reference model.

True if this model component is a system constant.

An incomplete list of system constant model components is below:

• ON_ModelComponent::Unset

• ON_InstanceDefinition::Empty

• ON_Linetype::Unset
• ON_Linetype::Continuous
• ON_Linetype::ByLayer
• ON_Linetype::ByParent

• ON_Layer::Unset
• ON_Layer::Default

• ON_TextStyle::Unset
• ON_TextStyle::Default
• ON_TextStyle::ByLayer
• ON_TextStyle::ByParent

• ON_DimStyle::Unset
• ON_DimStyle::Default
• ON_DimStyle::DefaultInchDecimal
• ON_DimStyle::DefaultInchFractional
• ON_DimStyle::DefaultFootInchArchitecture
• ON_DimStyle::DefaultMillimeterSmall
• ON_DimStyle::DefaultMillimeterLarge
• ON_DimStyle::DefaultMillimeterArchitecture

Tests an object to see if it is valid.

Gets or sets the global visibility of this layer.

Return true if the layer is visible in user interfaces that display layers. Returns false if the layer not visible in user interfaces. This is a runtime property that does not persist in .3dm files. This property is also used by the Layers panel to filter layers.

Gets or sets the line-type index for this layer.

Gets or sets the model visiblity of this layer.

Gets or sets the model persistent visibility of this layer. The persistent viability setting is used for layers whose visibility 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.

A value identifying the model that manages this component.

Gets or sets the name of this layer.

Returns a value indicating whether the component Name is already locked.

Gets the ID of the parent layer. Layers can be organized in a hierarchical structure, in which case this returns the parent layer ID. If the layer has no parent, Guid.Empty will be returned.

Gets or sets the global persistent visibility setting for this layer.

Gets and sets the initial per viewport visibility of this layer in newly created detail views.

Gets or sets the plot color for this layer.

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.

When a component is in a model for reference, this value identifies the reference model.

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.

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.

Runtime index used to sort layers in layer dialog.

List of custom information that is attached to this class.

Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.

Gets the amount of user strings.

Resets the HasId property of the model component to false, if possible.

Resets the HasIndex property of the model component to false, if possible.

Resets the HasName property of the model component to false, if possible.

Copy typical attributes from another layer

Increments the Cyclic Redundancy Check value by this instance.

Sets layer to default settings.

Remove any model visibility setting so the layer's global setting will be used for all viewports.

Remove any per viewport layer color setting so the layer's overall setting will be used for all viewports.

Remove any per viewport layer plot color setting so the layer's overall setting will be used for all viewports.

Remove any per viewport layer plot weight setting so the layer's overall setting will be used for all viewports.

Deletes per viewport layer settings.

Remove any per viewport visibility setting so the layer's overall setting will be used for all viewports.

Actively reclaims unmanaged resources that this instance uses.

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.

Gets immediate children of this layer. Note that child layers may have their own children.

Gets the children of this layer.

Get an optional custom section style associated with these attributes.

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)

Get a layer name's "leaf" level name

Get a layer name's "leaf" level name

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

Get a layer's "parent" path name

Get a layer's "parent" path name

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.

The global persistent visibility setting is used for layers whose visibility 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.

Gets the Type of the current instance.

Gets user string from this geometry.

Gets a copy of all (user key string, user value string) pairs attached to this geometry.

Verifies that a layer has per viewport settings.

Returns true if the layer has one or more selected Rhino objects.

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.

Locks the component Id property.

Locks the component Index property.

Locks the component Name property.

Returns parent of a layer.

Gets the display color for this layer.

Gets the per viewport visibility of this layer.

Gets the per layer persistent visibility. The persistent viability setting is used for layers whose visibility 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.

Gets the plot color for this layer.

Gets the plot weight, in millimeters, for this layer.

Set the persistent locking setting for this layer

Set the global persistent visibility setting for this layer.

Sets the display color for this layer.

Sets the per layer persistent visibility. The persistent viability setting is used for layers whose visibility 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.

Sets the plot color for this layer.

Sets the plot weight, in millimeters, for this layer.

Controls layer visibility in specific viewports.

Attach a user string (key,value combination) to this geometry.

Create a JSON string representation of this object

Remove any model persistent visibility setting from this layer.

Remove any explicitly persistent locking settings from this layer

Remove any explicit persistent visibility setting from this layer

Remove any per viewport persistent visibility setting so the layer's overall setting will be used for all viewports.