Class LayerBrushProvider
Allows you to create one or more LayerBrush<T>s usable by profile layers.
Implements
Inherited Members
Namespace: Artemis.Core.LayerBrushes
Assembly: Artemis.Core.dll
Syntax
public abstract class LayerBrushProvider : PluginFeature, IDisposable
Constructors
LayerBrushProvider()
Allows you to register one or more LayerBrush<T>s usable by profile layers.
Declaration
protected LayerBrushProvider()
Properties
LayerBrushDescriptors
A read-only collection of all layer brushes added with RegisterLayerBrushDescriptor<T>(string, string, string)
Declaration
public ReadOnlyCollection<LayerBrushDescriptor> LayerBrushDescriptors { get; }
Property Value
Type | Description |
---|---|
ReadOnlyCollection<LayerBrushDescriptor> |
Methods
RegisterLayerBrushDescriptor<T>(string, string, string)
Registers a layer brush descriptor for a given layer brush, so that it appears in the UI.
Note: You do not need to manually remove these on disable
Declaration
protected void RegisterLayerBrushDescriptor<T>(string displayName, string description, string icon) where T : BaseLayerBrush
Parameters
Type | Name | Description |
---|---|---|
string | displayName | The name to display in the UI |
string | description | The description to display in the UI |
string | icon | The Material icon to display in the UI, a full reference can be found here |
Type Parameters
Name | Description |
---|---|
T | The type of the layer brush you wish to register |