Layer

Layer class

Inheritence: Rhino.Runtime.CommonObjectRhino.DocObjects.ModelComponentLayer
Derived Classes:

Namespace: Rhino.DocObjects
Layer: references

Constructors (3)

CommonObject()

Allows construction from inheriting classes.

CommonObject(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

Layer()

Properties (56)

Color

Gets or sets the display color for this layer.

ComponentStatus

Gets or sets the status of the layer.

ComponentStatus

Gets or sets the component status of the model component.

ComponentType

Returns ModelComponentType.Layer .

ComponentType

Gets the ModelComponentType for this object. Useful in switch statements.

DeletedName

Gets the name of a component that is deleted.

Disposed

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

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.

HasIndex

Returns a value indicating whether the component has an Index.

HasName

Returns a value indicating whether the component has a Name.

HasUserData

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.

Gets or sets the ID of the current instance.

IdIsLocked

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

IgesLevel

Gets or sets the IGES level for this layer.

Index

Gets or sets the model component index attribute.

IndexIsLocked

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

InstanceDefinitionModelSerialNumber

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.

IsComponentStatusLocked

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

IsCurrent

Returns True if the layer is the current layer.

IsDeleted

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

IsDeleted

True if the component is deleted. Deleted components are kept by the document for undo purposes.

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.

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.

IsReference

Gets a value indicting whether this component is a referenced component. Referenced components are part of referenced documents.

IsReferenceParentLayer

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.

IsSystemComponent

True if this model component is a system constant.
An incomplete list of system constant model components is below:
<ul><li>ON_ModelComponent::Unset</li><li>ON_InstanceDefinition::Empty</li><li>ON_Linetype::Unset</li><li>ON_Linetype::Continuous</li><li>ON_Linetype::ByLayer</li><li>ON_Linetype::ByParent</li><li>ON_Layer::Unset</li><li>ON_Layer::Default</li><li>ON_TextStyle::Unset</li><li>ON_TextStyle::Default</li><li>ON_TextStyle::ByLayer</li><li>ON_TextStyle::ByParent</li><li>ON_DimStyle::Unset</li><li>ON_DimStyle::Default</li><li>ON_DimStyle::DefaultInchDecimal</li><li>ON_DimStyle::DefaultInchFractional</li><li>ON_DimStyle::DefaultFootInchArchitecture</li><li>ON_DimStyle::DefaultMillimeterSmall</li><li>ON_DimStyle::DefaultMillimeterLarge</li><li>ON_DimStyle::DefaultMillimeterArchitecture</li></ul>

IsValid

Tests an object to see if it is valid.

IsVisible

Gets or sets the global visibility of this layer.

IsVisibleInUserInterface

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.

LayerIndex

Gets or sets the index of this layer.

LinetypeIndex

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

ModelIsVisible

Gets or sets the model visiblity of this layer.

ModelPersistentVisibility

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.

ModelSerialNumber

A value identifying the model that manages this component.

Name

Gets or sets the name of this layer.

Name

Gets or sets the name

NameIsLocked

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

NamePathSeparator

Returns the string "::". This is the string Rhino uses in layer full path names to separate the names of individual layers.

ParentLayerId

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.

PathSeparator

The string "::" (colon,colon) is used to separate parent and child layer names.

PerformCorruptionTesting

Used to test ON_Object* pointers to see if they are a brep or mesh that is corrupt enough to crash Rhino.

PersistentVisibility

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

PerViewportIsVisibleInNewDetails

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

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.

ReferenceModelSerialNumber

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

RenderMaterial

Gets or sets the Render.RenderMaterial for objects on this layer that have MaterialSource() == MaterialFromLayer. A None result indicates that no Render.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.

UserDictionary

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

UserStringCount

Gets the amount of user strings.

Methods (80)

ClearId()

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

ClearIndex()

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

ClearName()

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

CommitChanges()

ConstructConstObject(object parentObject, int subobjectIndex)

Assigns a parent object and a sub-object index to this.

CopyAttributesFrom(Layer otherLayer)

Copy typical attributes from another layer

DataCRC(uint currentRemainder)

Increments the Cyclic Redundancy Check value by this instance.

Default()

Sets layer to default settings.

DeleteAllUserStrings()

DeleteModelVisible()

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

DeletePerViewportColor(Guid viewportId)

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

DeletePerViewportPlotColor(Guid viewportId)

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

DeletePerViewportPlotWeight(Guid viewportId)

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

DeletePerViewportSettings(Guid viewportId)

Deletes per viewport layer settings.

DeletePerViewportVisible(Guid viewportId)

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

DeleteUserString(string key)

Dispose()

Actively reclaims unmanaged resources that this instance uses.

Dispose(bool disposing)

For derived class implementers.
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.

Equals(Layer other)

Equals(object obj)

FromBase64String(int archive3dm, int opennurbs, string base64Data)

Create a CommonObject instance from a Base64 encoded string. This is typically the values used when passing common objects around as JSON data

FromJSON(Dictionary<string, string> jsonDictionary)

Create a CommonObject instance from a JSON dictionary

FromJSON(string json)

Create a CommonObject instance from a JSON string

GetChildren()

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

GetChildren(bool allChildren)

Gets the children of this layer.

GetCustomSectionStyle()

Get an optional custom section style associated with these attributes.

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()

GetLeafName(Layer layer)

Get a layer name's "leaf" level name

GetLeafName(string fullPath)

Get a layer name's "leaf" level name

GetObjectData(SerializationInfo info,StreamingContext context)

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

GetParentName(Layer layer)

Get a layer's "parent" path name

GetParentName(string fullPath)

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 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.

GetUserString(string key)

Gets user string from this geometry.

GetUserStrings()

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

HasPerViewportSettings(Guid viewportId)

Verifies that a layer has per viewport settings.

HasSelectedObjects(bool checkSubObjects)

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

IsChildOf(int layerIndex)

IsChildOf(Layer otherLayer)

IsChildOf(Guid otherlayerId)

IsParentOf(int layerIndex)

IsParentOf(Layer otherLayer)

IsParentOf(Guid otherLayer)

IsValidComponentName(string name)

Tests for a valid model component name.

IsValidName(string name)

Determines if a given string is valid for a layer name.

IsValidWithLog(out string log)

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

LockId()

Locks the component Id property.

LockIndex()

Locks the component Index property.

LockName()

Locks the component Name property.

ModelComponentTypeIgnoresCase(ModelComponentType type)

Informs the developer if a particular model component type will require case-ignoring searching within a document. This is currently True with groups; False otherwise.

ModelComponentTypeIncludesParent(ModelComponentType type)

Informs the developer if a particular model component type will include the hash of the parent.

ModelComponentTypeRequiresUniqueName(ModelComponentType type)

Informs the developer if a particular model component type will require uniqueness within a document. This is currently True with render materials and model geometry; False otherwise.

NonConstOperation()

For derived classes implementers.
Defines the necessary implementation to free the instance from being constant.

OnSwitchToNonConst()

Is called when a non-constant operation first occurs.

ParentLayer(bool rootLevelParent)

Returns parent of a layer.

PerViewportColor(Guid viewportId)

Gets the display color for this layer.

PerViewportIsVisible(Guid viewportId)

Gets the per viewport visibility of this layer.

PerViewportPersistentVisibility(Guid viewportId)

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.

PerViewportPlotColor(Guid viewportId)

Gets the plot color for this layer.

PerViewportPlotWeight(Guid viewportId)

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

RemoveCustomSectionStyle()

SetCustomSectionStyle(SectionStyle sectionStyle)

SetPersistentLocking(bool persistentLocking)

Set the persistent locking setting for this layer

SetPersistentVisibility(bool persistentVisibility)

Set the global persistent visibility setting for this layer.

SetPerViewportColor(Guid viewportId,Color color)

Sets the display color for this layer.

SetPerViewportPersistentVisibility(Guid viewportId, bool persistentVisibility)

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.

SetPerViewportPlotColor(Guid viewportId,Color color)

Sets the plot color for this layer.

SetPerViewportPlotWeight(Guid viewportId, double plotWeight)

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

SetPerViewportVisible(Guid viewportId, bool visible)

Controls layer visibility in specific viewports.

SetUserString(string key, string value)

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

ToJSON(SerializationOptions options)

Create a JSON string representation of this object

ToString()

Returns the name of the model component type, and then its name and index.

UnsetModelPersistentVisibility()

Remove any model persistent visibility setting from this layer.

UnsetPersistentLocking()

Remove any explicitly persistent locking settings from this layer

UnsetPersistentVisibility()

Remove any explicit persistent visibility setting from this layer

UnsetPerViewportPersistentVisibility(Guid viewportId)

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

Operators (2)

Nothing found