RhinoCommon API

Layer Properties

The Layer type exposes the following members.

Properties

	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. (Overrides ModelComponentId.)
	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.)
	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. (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. 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 (Inherited from ModelComponent.)
	IsValid	Tests an object to see if it is valid. (Inherited from CommonObject.)
	IsVisible	Gets or sets the visibility of this layer.
	LayerIndex	Obsolete. Gets or sets the index of this layer.
	LinetypeIndex	Gets or sets the line-type index for this layer.
	ModelSerialNumber	A value identifying the model that manages this component. (Inherited from ModelComponent.)
	Name	Gets or sets the name of this layer. (Overrides ModelComponentName.)
	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 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.
	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. (Inherited from ModelComponent.)
	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.

Top

Reference

Layer Class

Rhino.DocObjects Namespace

Report wishes and bugs at discourse.mcneel.com