Show / Hide Table of Contents

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
object
AbstractBindable
AbstractDecoratable<ILedGroupDecorator>
AbstractLedGroup
ListLedGroup
RectangleLedGroup
Implements
IBindable
ILedGroup
IDecoratable<ILedGroupDecorator>
IDecoratable
INotifyPropertyChanged
IEnumerable<Led>
IEnumerable
Inherited Members
AbstractDecoratable<ILedGroupDecorator>.Decorators
AbstractDecoratable<ILedGroupDecorator>.AddDecorator(ILedGroupDecorator)
AbstractDecoratable<ILedGroupDecorator>.RemoveDecorator(ILedGroupDecorator)
AbstractDecoratable<ILedGroupDecorator>.RemoveAllDecorators()
AbstractBindable.PropertyChanged
AbstractBindable.RequiresUpdate<T>(ref T, T)
AbstractBindable.SetProperty<T>(ref T, T, string)
AbstractBindable.OnPropertyChanged(string)
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
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 Source

AbstractLedGroup(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 Source

Brush

Gets or sets the IBrush which should be drawn over this ILedGroup.

Declaration
public IBrush? Brush { get; set; }
Property Value
Type Description
IBrush
| Edit this page View Source

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
| Edit this page View Source

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 Source

GetEnumerator()

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.

| Edit this page View Source

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.

| Edit this page View Source

OnAttach()

Called when the ILedGroup is attached to the RGBSurface.

Declaration
public virtual void OnAttach()
| Edit this page View Source

OnDetach()

Called when the ILedGroup is detached from the RGBSurface.

Declaration
public virtual void OnDetach()
| Edit this page View Source

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.

| Edit this page View Source

ToListUnsafe(out IList<Led>)

Declaration
protected virtual IDisposable? ToListUnsafe(out IList<Led> leds)
Parameters
Type Name Description
IList<Led> leds
Returns
Type Description
IDisposable

Implements

IBindable
ILedGroup
IDecoratable<T>
IDecoratable
INotifyPropertyChanged
IEnumerable<T>
IEnumerable

Extension Methods

LedGroupExtension.Attach(ILedGroup, RGBSurface)
LedGroupExtension.Detach(ILedGroup)
LedGroupExtension.Exclude(ILedGroup, params Led[])
LedGroupExtension.ToListLedGroup(ILedGroup)
  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX