Class LayerPropertyGroup

Represents a property group on a layer

Note: You cannot initialize property groups yourself. If properly placed and annotated, the Artemis core will initialize these for you.

Inheritance
object
LayerPropertyGroup
LayerEffectPropertyGroup
LayerGeneralProperties
LayerTransformProperties
Implements
Namespace: Artemis.Core
Assembly: Artemis.Core.dll
Syntax
public abstract class LayerPropertyGroup : IDisposable

Constructors

LayerPropertyGroup()

A base constructor for a LayerPropertyGroup

Declaration
protected LayerPropertyGroup()

Properties

GroupDescription

Gets the description of this group

Declaration
public PropertyGroupDescriptionAttribute GroupDescription { get; }
Property Value
Type Description
PropertyGroupDescriptionAttribute

IsHidden

Gets or sets whether the property is hidden in the UI

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

LayerProperties

A list of all layer properties in this group

Declaration
public ReadOnlyCollection<ILayerProperty> LayerProperties { get; }
Property Value
Type Description
ReadOnlyCollection<ILayerProperty>

LayerPropertyGroups

A list of al child groups in this group

Declaration
public ReadOnlyCollection<LayerPropertyGroup> LayerPropertyGroups { get; }
Property Value
Type Description
ReadOnlyCollection<LayerPropertyGroup>

Parent

The parent group of this group

Declaration
[LayerPropertyIgnore]
public LayerPropertyGroup? Parent { get; }
Property Value
Type Description
LayerPropertyGroup

Path

Gets the unique path of the property on the render element

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

ProfileElement

Gets the profile element (such as layer or folder) this group is associated with

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

PropertiesInitialized

Gets whether this property groups properties are all initialized

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

PropertyGroupEntity

Gets the entity this property group uses for persistent storage

Declaration
public PropertyGroupEntity? PropertyGroupEntity { get; }
Property Value
Type Description
PropertyGroupEntity

Methods

DisableProperties()

Called when the property group is deactivated (either the profile unloaded or the related brush/effect was removed)

Declaration
protected abstract void DisableProperties()

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.

EnableProperties()

Called when the property group is activated

Declaration
protected abstract void EnableProperties()

GetAllLayerProperties()

Recursively gets all layer properties on this group and any subgroups

Declaration
public IReadOnlyCollection<ILayerProperty> GetAllLayerProperties()
Returns
Type Description
IReadOnlyCollection<ILayerProperty>

OnPropertyGroupInitialized()

Called when the property group and all its layer properties have been initialized

Declaration
protected virtual void OnPropertyGroupInitialized()

PopulateDefaults()

Called before property group is activated to allow you to populate DefaultValue on the properties you want

Declaration
protected abstract void PopulateDefaults()

ResetAllLayerProperties()

Applies the default value to all layer properties

Declaration
public void ResetAllLayerProperties()

Events

LayerPropertyOnCurrentValueSet

Occurs when one of the current value of one of the layer properties in this group changes by some form of input

Note: Will not trigger on properties in child groups

Declaration
public event EventHandler<LayerPropertyEventArgs>? LayerPropertyOnCurrentValueSet
Event Type
Type Description
EventHandler<LayerPropertyEventArgs>

PropertyGroupInitialized

Occurs when the property group has initialized all its children

Declaration
public event EventHandler? PropertyGroupInitialized
Event Type
Type Description
EventHandler

VisibilityChanged

Occurs when the IsHidden value of the layer property was updated

Declaration
public event EventHandler? VisibilityChanged
Event Type
Type Description
EventHandler

Implements

IDisposable