Class BaseLayerEffect

For internal use only, please use LayerEffect<T> instead

Inheritance
object
CorePropertyChanged
BreakableModel
BaseLayerEffect
LayerEffect<T>
Implements
Inherited Members
Namespace: Artemis.Core.LayerEffects
Assembly: Artemis.Core.dll
Syntax
public abstract class BaseLayerEffect : BreakableModel, IBreakableModel, IDisposable, IStorageModel

Constructors

BaseLayerEffect()

Declaration
protected BaseLayerEffect()

Properties

BaseProperties

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

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

BrokenDisplayName

Gets the display name of this breakable model

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

ConfigurationDialog

Gets or sets a configuration dialog complementing the regular properties

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

Descriptor

Gets the LayerEffectDescriptor that registered this effect

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

Enabled

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

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

HasBeenRenamed

Gets or sets whether the effect has been renamed by the user, if true consider refraining from changing the name programatically

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

LayerEffectEntity

Gets the

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

Name

The name which appears in the editor

Declaration
public string Name { get; set; }
Property Value
Type Description
string

Order

Gets the order in which this effect appears in the update loop and editor

Declaration
public int Order { get; set; }
Property Value
Type Description
int

ProfileElement

Gets the profile element (such as layer or folder) this effect is applied to

Declaration
public RenderProfileElement ProfileElement { get; }
Property Value
Type Description
RenderProfileElement

ProviderId

Gets the ID of the LayerEffectProvider that provided this effect

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

Suspended

Gets a boolean indicating whether the layer effect is suspended or not

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

Methods

DisableLayerEffect()

Called when the layer effect is deactivated

Declaration
public abstract void DisableLayerEffect()

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.

EnableLayerEffect()

Called when the layer effect is activated

Declaration
public abstract void EnableLayerEffect()

Load()

Loads the model from its associated entity

Declaration
public void Load()

PostProcess(SKCanvas, SKRect, SKPaint)

Called after the layer of folder has been rendered

Declaration
public abstract void PostProcess(SKCanvas canvas, SKRect renderBounds, SKPaint paint)
Parameters
Type Name Description
SKCanvas canvas

The canvas used to render the frame
SKRect renderBounds

The bounds this layer/folder rendered in
SKPaint paint

The paint this layer/folder used to render

PreProcess(SKCanvas, SKRect, SKPaint)

Called before the layer or folder will be rendered

Declaration
public abstract void PreProcess(SKCanvas canvas, SKRect renderBounds, SKPaint paint)
Parameters
Type Name Description
SKCanvas canvas

The canvas used to render the frame
SKRect renderBounds

The bounds this layer/folder will render in
SKPaint paint

The paint this layer/folder will use to render

Save()

Saves the model to its associated entity

Declaration
public void Save()

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

Implements

IBreakableModel
IDisposable
IStorageModel