Class LayerBrushDescriptor

Namespace

Artemis.Core.LayerBrushes

Assembly

Artemis.Core.dll

A class that describes a layer brush

public class LayerBrushDescriptor

Inheritance

object

LayerBrushDescriptor

Properties

Description

The description that is displayed in the UI

public string Description { get; }

Property Value

string

DisplayName

The name that is displayed in the UI

public string DisplayName { get; }

Property Value

string

Icon

The Material icon to display in the UI, a full reference can be found here

public string Icon { get; }

Property Value

string

LayerBrushType

The type of the layer brush

public Type LayerBrushType { get; }

Property Value

Type

Provider

The plugin that provided this LayerBrushDescriptor

public LayerBrushProvider Provider { get; }

Property Value

LayerBrushProvider

Methods

CreateInstance(Layer, LayerBrushEntity?)

Creates an instance of the described brush and applies it to the layer

public BaseLayerBrush CreateInstance(Layer layer, LayerBrushEntity? entity)

Parameters

layer Layer

entity LayerBrushEntity

Returns

BaseLayerBrush

MatchesLayerBrushReference(LayerBrushReference?)

Determines whether the provided reference references to a brush provided by this descriptor

public bool MatchesLayerBrushReference(LayerBrushReference? reference)

Parameters

reference LayerBrushReference

Returns

bool