Class BaseLayerBrush

For internal use only, please use LayerBrush<T> or PerLedLayerBrush<T> or instead

Inheritance
object
CorePropertyChanged
BreakableModel
BaseLayerBrush
PropertiesLayerBrush<T>
Implements
Inherited Members
Namespace: Artemis.Core.LayerBrushes
Assembly: Artemis.Core.dll
Syntax
public abstract class BaseLayerBrush : BreakableModel, IBreakableModel, IDisposable

Constructors

BaseLayerBrush()

Creates a new instance of the BaseLayerBrush class

Declaration
protected BaseLayerBrush()

Properties

BaseProperties

Gets a reference to the layer property group without knowing it's type

Declaration
public virtual LayerPropertyGroup? BaseProperties { get; }
Property Value
Type Description
LayerPropertyGroup

BrokenDisplayName

Gets the display name of this breakable model

Declaration
public override string BrokenDisplayName { get; }
Property Value
Type Description
string
Overrides
BreakableModel.BrokenDisplayName

BrushType

Gets the type of layer brush

Declaration
public LayerBrushType BrushType { get; }
Property Value
Type Description
LayerBrushType

ConfigurationDialog

Gets or sets a configuration dialog complementing the regular properties

Declaration
public ILayerBrushConfigurationDialog? ConfigurationDialog { get; protected set; }
Property Value
Type Description
ILayerBrushConfigurationDialog

DefaultPreset

Gets the default preset used for new instances of this layer brush

Declaration
public virtual ILayerBrushPreset? DefaultPreset { get; }
Property Value
Type Description
ILayerBrushPreset

Descriptor

Gets the descriptor of this brush

Declaration
public LayerBrushDescriptor Descriptor { get; }
Property Value
Type Description
LayerBrushDescriptor

Enabled

Gets a boolean indicating whether the layer brush is enabled or not

Declaration
public bool Enabled { get; }
Property Value
Type Description
bool

Layer

Gets the layer this brush is applied to

Declaration
public Layer Layer { get; }
Property Value
Type Description
Layer

LayerBrushEntity

Gets the brush entity this brush uses for persistent storage

Declaration
public LayerBrushEntity LayerBrushEntity { get; }
Property Value
Type Description
LayerBrushEntity

Presets

Gets a list of presets available to this layer brush

Declaration
public virtual List<ILayerBrushPreset>? Presets { get; }
Property Value
Type Description
List<ILayerBrushPreset>

ProviderId

Gets the ID of the LayerBrushProvider that provided this effect

Declaration
public string? ProviderId { get; }
Property Value
Type Description
string

SupportsTransformation

Gets or sets whether the brush supports transformations

Note: RGB.NET brushes can never be transformed and setting this to true will throw an exception

Declaration
public bool SupportsTransformation { get; protected set; }
Property Value
Type Description
bool

Methods

DisableLayerBrush()

Called when the layer brush is deactivated

Declaration
public abstract void DisableLayerBrush()

Dispose()

Declaration
public void Dispose()

Dispose(bool)

Releases the unmanaged resources used by the object and optionally releases the managed resources.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.

EnableLayerBrush()

Called when the layer brush is activated

Declaration
public abstract void EnableLayerBrush()

Update(double)

Called before rendering every frame, write your update logic here

Declaration
public abstract void Update(double deltaTime)
Parameters
Type Name Description
double deltaTime

Seconds passed since last update

Implements

IBreakableModel
IDisposable