Class ArtemisLayout
Represents a device layout decorated with extra Artemis-specific data
Namespace: Artemis.Core
Assembly: Artemis.Core.dll
Syntax
public class ArtemisLayoutConstructors
ArtemisLayout(string, LayoutSource)
Creates a new instance of the ArtemisLayout class
Declaration
public ArtemisLayout(string filePath, LayoutSource source)Parameters
| Type | Name | Description |
|---|---|---|
| string | filePath | The path of the layout XML file |
| LayoutSource | source | The source from where this layout is being loaded |
Properties
Device
Gets the device this layout is applied to
Declaration
public ArtemisDevice? Device { get; }Property Value
| Type | Description |
|---|---|
| ArtemisDevice |
FilePath
Gets the file path the layout was (attempted to be) loaded from
Declaration
public string FilePath { get; }Property Value
| Type | Description |
|---|---|
| string |
Image
Gets the image of the device
Declaration
public Uri? Image { get; }Property Value
| Type | Description |
|---|---|
| Uri |
IsValid
Gets a boolean indicating whether a valid layout was loaded
Declaration
public bool IsValid { get; }Property Value
| Type | Description |
|---|---|
| bool |
LayoutCustomDeviceData
Gets the custom layout data embedded in the RGB.NET layout
Declaration
public LayoutCustomDeviceData LayoutCustomDeviceData { get; }Property Value
| Type | Description |
|---|---|
| LayoutCustomDeviceData |
Leds
Gets a list of LEDs this layout contains
Declaration
public List<ArtemisLedLayout> Leds { get; }Property Value
| Type | Description |
|---|---|
| List<ArtemisLedLayout> |
RgbLayout
Gets the RGB.NET device layout
Declaration
public DeviceLayout RgbLayout { get; }Property Value
| Type | Description |
|---|---|
| DeviceLayout |
Source
Gets the source from where this layout was loaded
Declaration
public LayoutSource Source { get; }Property Value
| Type | Description |
|---|---|
| LayoutSource |
Methods
ApplyTo(IRGBDevice, bool, bool)
Applies the layout to the provided device
Declaration
public void ApplyTo(IRGBDevice device, bool createMissingLeds = false, bool removeExcessiveLeds = false)Parameters
| Type | Name | Description |
|---|---|---|
| IRGBDevice | device | |
| bool | createMissingLeds | |
| bool | removeExcessiveLeds |