Class AbstractLedGroup
Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
Inheritance
Implements
Inherited Members
Namespace: RGB.NET.Core
Assembly: RGB.NET.Core.dll
Syntax
public abstract class AbstractLedGroup : AbstractDecoratable<ILedGroupDecorator>, IBindable, ILedGroup, IDecoratable<ILedGroupDecorator>, IDecoratable, INotifyPropertyChanged, IEnumerable<Led>, IEnumerable
Constructors
| Edit this page View SourceAbstractLedGroup(RGBSurface?)
Initializes a new instance of the AbstractLedGroup class.
Declaration
protected AbstractLedGroup(RGBSurface? attachTo)
Parameters
Type | Name | Description |
---|---|---|
RGBSurface | attachTo |
Properties
| Edit this page View SourceBrush
Declaration
public IBrush? Brush { get; set; }
Property Value
Type | Description |
---|---|
IBrush |
Surface
Gets the surface this group is attached to or null
if it is not attached to any surface.
Declaration
public RGBSurface? Surface { get; }
Property Value
Type | Description |
---|---|
RGBSurface |
ZIndex
Gets or sets the z-index of this ILedGroup to allow ordering them before drawing. (lowest first) (default: 0)
Declaration
public int ZIndex { get; set; }
Property Value
Type | Description |
---|---|
int |
Methods
| Edit this page View SourceGetEnumerator()
Returns an enumerator that iterates through the collection.
Declaration
public IEnumerator<Led> GetEnumerator()
Returns
Type | Description |
---|---|
IEnumerator<Led> | An enumerator that can be used to iterate through the collection. |
GetLeds()
Gets a enumerable containing all leds in this group.
Declaration
protected abstract IEnumerable<Led> GetLeds()
Returns
Type | Description |
---|---|
IEnumerable<Led> | A enumerable containing all leds of this group. |
OnAttach()
Called when the ILedGroup is attached to the RGBSurface.
Declaration
public virtual void OnAttach()
OnDetach()
Called when the ILedGroup is detached from the RGBSurface.
Declaration
public virtual void OnDetach()
ToList()
Returns a list containing all Led in this group.
Declaration
public virtual IList<Led> ToList()
Returns
Type | Description |
---|---|
IList<Led> | A list containing all Led in this group. |
ToListUnsafe(out IList<Led>)
Declaration
protected virtual IDisposable? ToListUnsafe(out IList<Led> leds)
Parameters
Type | Name | Description |
---|---|---|
IList<Led> | leds |
Returns
Type | Description |
---|---|
IDisposable |