Class Profile

Represents a profile containing folders and layers

Inheritance
object
CorePropertyChanged
BreakableModel
ProfileElement
Profile
Implements
Inherited Members
Namespace: Artemis.Core
Assembly: Artemis.Core.dll
Syntax
public sealed class Profile : ProfileElement, IBreakableModel, IDisposable

Properties

Configuration

Gets the profile configuration of this profile

Declaration
public ProfileConfiguration Configuration { get; }
Property Value
Type Description
ProfileConfiguration

IsFreshImport

Gets or sets a boolean indicating whether this profile is freshly imported i.e. no changes have been made to it since import

Note: As long as this is true, profile adaption will be performed on load and any surface changes

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

ProfileEntity

Gets the profile entity this profile uses for persistent storage

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

ScriptConfigurations

Gets a collection of all script configurations assigned to this profile

Declaration
public ReadOnlyObservableCollection<ScriptConfiguration> ScriptConfigurations { get; }
Property Value
Type Description
ReadOnlyObservableCollection<ScriptConfiguration>

Scripts

Gets a collection of all active scripts assigned to this profile

Declaration
public ReadOnlyObservableCollection<ProfileScript> Scripts { get; }
Property Value
Type Description
ReadOnlyObservableCollection<ProfileScript>

Methods

Dispose(bool)

Disposes the profile element

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing
Overrides
ProfileElement.Dispose(bool)

GetBrokenHierarchy()

Returns a list containing all broken models, including self and any children

Declaration
public override IEnumerable<IBreakableModel> GetBrokenHierarchy()
Returns
Type Description
IEnumerable<IBreakableModel>
Overrides
BreakableModel.GetBrokenHierarchy()

GetRootFolder()

Retrieves the root folder of this profile

Declaration
public Folder GetRootFolder()
Returns
Type Description
Folder

The root folder of the profile
Exceptions
Type Condition
ObjectDisposedException

PopulateLeds(IEnumerable<ArtemisDevice>)

Populates all the LEDs on the elements in this profile

Declaration
public void PopulateLeds(IEnumerable<ArtemisDevice> devices)
Parameters
Type Name Description
IEnumerable<ArtemisDevice> devices

The devices to use while populating LEDs

Render(SKCanvas, SKPointI, ProfileElement?)

Renders the element

Declaration
public override void Render(SKCanvas canvas, SKPointI basePosition, ProfileElement? editorFocus)
Parameters
Type Name Description
SKCanvas canvas

The canvas to render upon.
SKPointI basePosition

The base position to use to translate relative positions to absolute positions.
ProfileElement editorFocus

An optional element to focus on while rendering (other elements will not render).
Overrides
ProfileElement.Render(SKCanvas, SKPointI, ProfileElement?)

Reset()

Resets the internal state of the element

Declaration
public override void Reset()
Overrides
ProfileElement.Reset()

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
ProfileElement.ToString()

Update(double)

Updates the element

Declaration
public override void Update(double deltaTime)
Parameters
Type Name Description
double deltaTime
Overrides
ProfileElement.Update(double)

Implements

IBreakableModel
IDisposable