Class RenderProfileElement

Represents an element of a Profile that has advanced rendering capabilities

Inheritance
System.Object
CorePropertyChanged
BreakableModel
ProfileElement
RenderProfileElement
Folder
Layer
Implements
System.IDisposable
Inherited Members
Namespace: Artemis.Core
Assembly: Artemis.Core.dll
Syntax
public abstract class RenderProfileElement : ProfileElement, INotifyPropertyChanged, IBreakableModel, IDisposable

Properties

| Improve this Doc View Source

Bounds

The bounds of this entity

Declaration
public SKRectI Bounds { get; }
Property Value
Type Description
SkiaSharp.SKRectI
| Improve this Doc View Source

DisplayCondition

Gets or sets the root display condition group

Declaration
public DataModelConditionGroup DisplayCondition { get; set; }
Property Value
Type Description
DataModelConditionGroup
| Improve this Doc View Source

DisplayConditionMet

Gets whether the display conditions applied to this layer where met or not during last update

Always true if the layer has no display conditions

Declaration
public bool DisplayConditionMet { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Enabled

Gets a boolean indicating whether this render element and its layers/brushes are enabled

Declaration
public bool Enabled { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

LayerEffects

Gets a read-only collection of the layer effects on this entity

Declaration
public ReadOnlyCollection<BaseLayerEffect> LayerEffects { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<BaseLayerEffect>
| Improve this Doc View Source

Parent

Gets the parent of this element

Declaration
public ProfileElement Parent { get; }
Property Value
Type Description
ProfileElement
| Improve this Doc View Source

Path

Gets the path containing all the LEDs this entity is applied to, any rendering outside the entity Path is clipped.

Declaration
public SKPath Path { get; protected set; }
Property Value
Type Description
SkiaSharp.SKPath
| Improve this Doc View Source

ShouldBeEnabled

Gets a boolean indicating whether this render element and its layers/brushes should be enabled

Declaration
public abstract bool ShouldBeEnabled { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Timeline

Gets the timeline associated with this render element

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

Methods

| Improve this Doc View Source

AddLayerEffect(LayerEffectDescriptor)

Adds a the layer effect described inthe provided descriptor

Declaration
public void AddLayerEffect(LayerEffectDescriptor descriptor)
Parameters
Type Name Description
LayerEffectDescriptor descriptor
| Improve this Doc View Source

Disable()

Enables the render element and its brushes and effects

Declaration
public abstract void Disable()
| Improve this Doc View Source

Dispose(Boolean)

Disposes the profile element

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
Overrides
| Improve this Doc View Source

Enable()

Disables the render element and its brushes and effects

Declaration
public abstract void Enable()
| Improve this Doc View Source

GetAllLayerProperties()

Creates a list of all layer properties present on this render element

Declaration
public abstract List<ILayerProperty> GetAllLayerProperties()
Returns
Type Description
System.Collections.Generic.List<ILayerProperty>

A list of all layer properties present on this render element
| Improve this Doc View Source

IsPropertyGroupExpanded(LayerPropertyGroup)

Determines whether the provided property group is expanded

Declaration
public bool IsPropertyGroupExpanded(LayerPropertyGroup layerPropertyGroup)
Parameters
Type Name Description
LayerPropertyGroup layerPropertyGroup

The property group to check
Returns
Type Description
System.Boolean

A boolean indicating whether the provided property group is expanded
| Improve this Doc View Source

RemoveLayerEffect(BaseLayerEffect)

Removes the provided layer

Declaration
public void RemoveLayerEffect(BaseLayerEffect effect)
Parameters
Type Name Description
BaseLayerEffect effect
| Improve this Doc View Source

SetPropertyGroupExpanded(LayerPropertyGroup, Boolean)

Expands or collapses the provided property group

Declaration
public void SetPropertyGroupExpanded(LayerPropertyGroup layerPropertyGroup, bool expanded)
Parameters
Type Name Description
LayerPropertyGroup layerPropertyGroup

The group to expand or collapse
System.Boolean expanded

Whether to expand or collapse the property group
| Improve this Doc View Source

UpdateDisplayCondition()

Evaluates the display conditions on this element and applies any required changes to the Timeline

Declaration
public void UpdateDisplayCondition()
| Improve this Doc View Source

UpdateTimeline(Double)

Updates the Timeline according to the provided deltaTime and current display condition status

Declaration
public void UpdateTimeline(double deltaTime)
Parameters
Type Name Description
System.Double deltaTime

Events

| Improve this Doc View Source

LayerEffectsUpdated

Occurs when a layer effect has been added or removed to this render element

Declaration
public event EventHandler LayerEffectsUpdated
Event Type
Type Description
System.EventHandler

Implements

System.IDisposable