Constructors
public Layer()
Properties
Gets or sets the status of the layer.
Overrides: ModelComponent.ComponentStatus
Returns ModelComponentType.Layer.
Overrides: ModelComponent.ComponentType
Gets and sets a short description of the layer.
Disposed
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.
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.
Overrides: ModelComponent.Id
IdIsLocked
Returns a value indicating whether the component ID is already locked.
Exceptions:
| InvalidOperationException | When setting the Index failed. This usually happens because the instance Index is already locked. |
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.
Remarks: Reference components are not saved in .3dm archives. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.
IsComponentStatusLocked
The component status itself can be locked. This returns an indication.
Gets a value indicating whether this layer has been deleted and is currently in the Undo buffer.
Overrides: ModelComponent.IsDeleted
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.
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.
Overrides: ModelComponent.IsReference
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:
- 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
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.
obsoleteUse the Index property.
Gets or sets the index of this layer.
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.
ModelSerialNumber
A value identifying the model that manages this component.
Remarks: If the component is being managed by a model, this value identifies the model. In Rhino, this value is the document runtime serial number. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.
Gets or sets the name of this layer.
Overrides: ModelComponent.Name
NameIsLocked
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.
obsoleteUse ModelComponent.NamePathSeparator
The string "::" (colon,colon) is used to separate parent and child layer names.
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 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.
Remarks: Reference components are not saved in .3dm archives. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.
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.
Gets or sets the section style index for this layer.
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.
Methods
ClearId
public void ClearId()
Resets the HasId property of the model component to false, if possible.
Exceptions:
| InvalidOperationException | If the ID is locked. |
ClearIndex
public void ClearIndex()
Resets the HasIndex property of the model component to false, if possible.
Exceptions:
| InvalidOperationException | If the index is locked. |
ClearName
public void ClearName()
Resets the HasName property of the model component to false, if possible.
Exceptions:
| InvalidOperationException | If the name is locked. |
obsoleteNo longer needed. Layer changes in the document are now immediate
ConstructConstObject
Assigns a parent object and a sub-object index to this.
Copy typical attributes from another layer
Parameters:
| otherLayer (Layer) |
DataCRC
Increments the Cyclic Redundancy Check value by this instance.
Parameters:
| currentRemainder (uint) | The current remainder value. |
Returns: The updated remainder value.
public void DeleteAllUserStrings()
public void DeleteModelVisible()
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.
Parameters:
| viewportId (Guid) | If not Guid.Empty, then the setting for this viewport will be deleted. If Guid.Empty, the all per viewport layer color settings will be removed. |
Remove any per viewport layer plot color setting so the layer's overall setting will be used for all viewports.
Parameters:
| viewportId (Guid) | If not Guid.Empty, then the setting for this viewport will be deleted. If Guid.Empty, the all per viewport layer color settings will be removed. |
Remove any per viewport layer plot weight setting so the layer's overall setting will be used for all viewports.
Parameters:
| viewportId (Guid) | If not Guid.Empty, then the setting for this viewport will be deleted. If Guid.Empty, the all per viewport layer color settings will be removed. |
Deletes per viewport layer settings.
Parameters:
| viewportId (Guid) | If not Guid.Empty, then the settings for that viewport are deleted. If Guid.Empty, then all per viewport settings are deleted. |
Remove any per viewport visibility setting so the layer's overall setting will be used for all viewports.
Parameters:
| viewportId (Guid) | If not Guid.Empty, then the setting for this viewport will be deleted. If Guid.Empty, the all per viewport visibility settings will be removed. |
public void DeletePlotColor()
Removes the plot color for layer. The layer's color will be used for the plot color.
Dispose
public void Dispose()
Actively reclaims unmanaged resources that this instance uses.
Dispose
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.
Parameters:
| disposing (bool) | true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer. |
EnsurePrivateCopy
public void 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.
Gets immediate children of this layer. Note that child layers may have their own children.
Returns: Array of child layers, sorted by layer index, or null if this layer does not have any children.
Gets the children of this layer.
Parameters:
| allChildren (bool) | If false, the immediate children are returned. If true, immediate children, their children, and so on, are returned. |
Returns: Array of child layers, sorted by layer index, or null if this layer does not have any children.
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)
Returns: A new layer instance.
Get a layer name's "leaf" level name
Parameters:
| layer (Layer) |
Returns: leaf name or String.Empty if fullPath does not contain a leaf
Get a layer name's "leaf" level name
Parameters:
| fullPath (string) |
Returns: leaf name or String.Empty if fullPath does not contain a leaf
GetObjectData
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)]
public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
Parameters:
| info (SerializationInfo) | The System.Runtime.Serialization.SerializationInfo to populate with data. |
| context (StreamingContext) | The destination (see System.Runtime.Serialization.StreamingContext) for this serialization. |
Get a layer's "parent" path name
Parameters:
| layer (Layer) |
Returns: parent name or String.Empty
Get a layer's "parent" path name
Parameters:
| fullPath (string) |
Returns: parent name or String.Empty
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.
Remarks: Returns true if this layer's visibility is controlled by a parent object and the parent is turned on (after being off), then this layer will also be turned on. Returns false if this layer's visibility is controlled by a parent object and the parent layer is turned on (after being off), then this layer will continue to be off. When the persistent viability is not explicitly set, this property returns the current value of IsVisible
Gets user string from this geometry.
Parameters:
| key (string) | id used to retrieve the string. |
Returns: string associated with the key if successful. null if no key was found.
Gets a copy of all (user key string, user value string) pairs attached to this geometry.
Returns: A new collection.
Verifies that a layer has per viewport settings.
Parameters:
| viewportId (Guid) | If not Guid.Empty, then checks for settings for that specific viewport. If Guid.Empty, then checks for any viewport settings. |
Returns: True if the layer has per viewport settings, false otherwise.
Returns true if the layer has one or more selected Rhino objects.
Parameters:
| checkSubObjects (bool) | If true, the search will include objects that have some subset of the object selected, like some edges of a Brep. If false, objects where the entire object is not selected are ignored. |
Returns: true if the layer has selected Rhino objects, false otherwise.
obsoleteUse ModelComponent.IsValidComponentName
Determines if a given string is valid for a layer name.
Parameters:
| name (string) | A name to be validated. |
Returns: true if the name is valid for a layer name; otherwise, false.
IsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
Parameters:
| log (out string) | A textual log. This out parameter is assigned during this call. |
Returns: true if this object is valid; false otherwise.
LockId
public void LockId()
Locks the component Id property.
LockIndex
public void LockIndex()
Locks the component Index property.
LockName
public void LockName()
Locks the component Name property.
NonConstOperation
protected virtual void NonConstOperation()
For derived classes implementers.
Defines the necessary implementation to free the instance from being constant.
OnSwitchToNonConst
protected virtual void OnSwitchToNonConst()
Is called when a non-constant operation first occurs.
Returns parent of a layer.
Parameters:
| rootLevelParent (bool) | If true, the root level parent is returned. The root level parent never has a parent. If false, the immediate parent is returned. The immediate parent may have a parent. |
Returns: The parent layer, or null if the layer does not have a parent.
Gets the display color for this layer.
Parameters:
| viewportId (Guid) | If not Guid.Empty, then the setting applies only to the viewport with the specified id. |
Returns: The display color.
Gets the per viewport visibility of this layer.
Parameters:
| viewportId (Guid) | If not Guid.Empty, then the visibility setting for that viewport is returned. If Guid.Empty, the IsVisible property is returned. |
Returns: Returns true if objects on layer are visible.
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.
Parameters:
| viewportId (Guid) |
Returns: Return true if this layer's visibility in the specified viewport is controlled by a parent object and the parent is turned on (after being off), then this layer will also be turned on in the specified viewport. Returns false if this layer's visibility in the specified viewport is controlled by a parent object and the parent layer is turned on(after being off), then this layer will continue to be off in the specified viewport.
Gets the plot color for this layer.
Parameters:
| viewportId (Guid) | If not Guid.Empty, then the setting applies only to the viewport with the specified id. |
Returns: The plot color.
Gets the plot weight, in millimeters, for this layer.
Parameters:
| viewportId (Guid) | If not Guid.Empty, then the setting applies only to the viewport with the specified id. |
Returns: The plot color.
public void RemoveCustomSectionStyle()
Parameters:
| sectionStyle (SectionStyle) |
Set the persistent locking setting for this layer
Parameters:
| persistentLocking (bool) |
Set the global persistent visibility setting for this layer.
Parameters:
| persistentVisibility (bool) |
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.
Parameters:
| viewportId (Guid) | If not Guid.Empty, then the setting applies only to the viewport with the specified id. If Guid.Empty, then the setting applies to all viewports with per viewport layer settings. |
| persistentVisibility (bool) | If true, this layer's visibility in the specified viewport is controlled by a parent object and the parent is turned on (after being off), then this layer will also be turned on in the specified viewport. If false, this layer's visibility in the specified viewport is controlled by a parent object and the parent layer is turned on (after being off), then this layer will continue to be off in the specified viewport. |
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.
ToJSON
Create a JSON string representation of this object
Parameters:
| options (SerializationOptions) |
public void UnsetModelPersistentVisibility()
Remove any model persistent visibility setting from this layer.
public void UnsetPersistentLocking()
Remove any explicitly persistent locking settings from this layer
public void UnsetPersistentVisibility()
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.
Parameters:
| viewportId (Guid) | If not Guid.Empty, then the setting for this viewport will be deleted. If Guid.Empty, the all per viewport visibility settings will be removed. |