Class BaseLayerBrush

Namespace

Artemis.Core.LayerBrushes

Assembly

Artemis.Core.dll

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

public abstract class BaseLayerBrush : BreakableModel, IBreakableModel, IDisposable, IPluginFeatureDependent

Inheritance

object

CorePropertyChanged

BreakableModel

BaseLayerBrush

Implements

IBreakableModel

IDisposable

IPluginFeatureDependent

Derived

PropertiesLayerBrush<T>

Inherited Members

BreakableModel.OnBrokenStateChanged()

BreakableModel.BrokenState

BreakableModel.BrokenStateException

BreakableModel.TryOrBreak(Action, string)

BreakableModel.SetBrokenState(string, Exception)

BreakableModel.ClearBrokenState(string)

BreakableModel.GetBrokenHierarchy()

BreakableModel.BrokenStateChanged

Constructors

BaseLayerBrush()

Creates a new instance of the BaseLayerBrush class

protected BaseLayerBrush()

Properties

BaseProperties

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

public virtual LayerPropertyGroup? BaseProperties { get; }

Property Value

LayerPropertyGroup

BrokenDisplayName

Gets the display name of this breakable model

public override string BrokenDisplayName { get; }

Property Value

string

BrushType

Gets the type of layer brush

public LayerBrushType BrushType { get; }

Property Value

LayerBrushType

ConfigurationDialog

Gets or sets a configuration dialog complementing the regular properties

public ILayerBrushConfigurationDialog? ConfigurationDialog { get; protected set; }

Property Value

ILayerBrushConfigurationDialog

DefaultPreset

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

public virtual ILayerBrushPreset? DefaultPreset { get; }

Property Value

ILayerBrushPreset

Descriptor

Gets the descriptor of this brush

public LayerBrushDescriptor Descriptor { get; }

Property Value

LayerBrushDescriptor

Enabled

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

public bool Enabled { get; }

Property Value

bool

Layer

Gets the layer this brush is applied to

public Layer Layer { get; }

Property Value

Layer

LayerBrushEntity

Gets the brush entity this brush uses for persistent storage

public LayerBrushEntity LayerBrushEntity { get; }

Property Value

LayerBrushEntity

Presets

Gets a list of presets available to this layer brush

public virtual List<ILayerBrushPreset>? Presets { get; }

Property Value

List<ILayerBrushPreset>

ProviderId

Gets the ID of the LayerBrushProvider that provided this effect

public string? ProviderId { get; }

Property Value

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

public bool SupportsTransformation { get; protected set; }

Property Value

bool

Methods

DisableLayerBrush()

Called when the layer brush is deactivated

public abstract void DisableLayerBrush()

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Dispose(bool)

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

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

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

EnableLayerBrush()

Called when the layer brush is activated

public abstract void EnableLayerBrush()

GetFeatureDependencies()

Gets the plugin features this class depends on, may contain the same plugin feature twice if depending on it in multiple ways.

public IEnumerable<PluginFeature> GetFeatureDependencies()

Returns

IEnumerable<PluginFeature>

A List<T> of PluginFeature this class depends on.

Update(double)

Called before rendering every frame, write your update logic here

public abstract void Update(double deltaTime)

Parameters

deltaTime double

Seconds passed since last update