Class RectangleLedGroup
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.Presets.Groups
Assembly: RGB.NET.Presets.dll
Syntax
public sealed class RectangleLedGroup : AbstractLedGroup, IBindable, ILedGroup, IDecoratable<ILedGroupDecorator>, IDecoratable, INotifyPropertyChanged, IEnumerable<Led>, IEnumerable
Constructors
| Edit this page View SourceRectangleLedGroup(RGBSurface?, Led, Led, double)
Initializes a new instance of the RGB.NET.Groups.RectangleLedGroup class.
Declaration
public RectangleLedGroup(RGBSurface? surface, Led fromLed, Led toLed, double minOverlayPercentage = 0.5)
Parameters
| Type | Name | Description |
|---|---|---|
| RGBSurface | surface | Specifies the surface to attach this group to or |
| Led | fromLed | They first Led to calculate the Rectangle of this RGB.NET.Groups.RectangleLedGroup from. |
| Led | toLed | They second Led to calculate the Rectangle of this RGB.NET.Groups.RectangleLedGroup from. |
| double | minOverlayPercentage | (optional) The minimal percentage overlay a Led must have with the RGB.NET.Groups.RectangleLedGroup.Rectangle to be taken into the RGB.NET.Groups.RectangleLedGroup. (default: 0.5) |
RectangleLedGroup(RGBSurface?, Point, Point, double)
Initializes a new instance of the RGB.NET.Groups.RectangleLedGroup class.
Declaration
public RectangleLedGroup(RGBSurface? surface, Point fromPoint, Point toPoint, double minOverlayPercentage = 0.5)
Parameters
| Type | Name | Description |
|---|---|---|
| RGBSurface | surface | Specifies the surface to attach this group to or |
| Point | fromPoint | They first point to calculate the Rectangle of this RGB.NET.Groups.RectangleLedGroup from. |
| Point | toPoint | They second point to calculate the Rectangle of this RGB.NET.Groups.RectangleLedGroup from. |
| double | minOverlayPercentage | (optional) The minimal percentage overlay a Led must have with the RGB.NET.Groups.RectangleLedGroup.Rectangle to be taken into the RGB.NET.Groups.RectangleLedGroup. (default: 0.5) |
RectangleLedGroup(RGBSurface?, Rectangle, double)
Initializes a new instance of the RGB.NET.Groups.RectangleLedGroup class.
Declaration
public RectangleLedGroup(RGBSurface? surface, Rectangle rectangle, double minOverlayPercentage = 0.5)
Parameters
| Type | Name | Description |
|---|---|---|
| RGBSurface | surface | Specifies the surface to attach this group to or |
| Rectangle | rectangle | The Rectangle of this RGB.NET.Groups.RectangleLedGroup. |
| double | minOverlayPercentage | (optional) The minimal percentage overlay a Led must have with the RGB.NET.Groups.RectangleLedGroup.Rectangle to be taken into the RGB.NET.Groups.RectangleLedGroup. (default: 0.5) |
Properties
| Edit this page View SourceMinOverlayPercentage
Gets or sets the minimal percentage overlay a Led must have with the Rectangle to be taken into the RectangleLedGroup.
Declaration
public double MinOverlayPercentage { get; set; }
Property Value
| Type | Description |
|---|---|
| double |
Rectangle
Declaration
public Rectangle Rectangle { get; set; }
Property Value
| Type | Description |
|---|---|
| Rectangle |
Methods
| Edit this page View SourceGetLeds()
Gets a enumerable containing all leds in this group.
Declaration
protected override IEnumerable<Led> GetLeds()
Returns
| Type | Description |
|---|---|
| IEnumerable<Led> | A enumerable containing all leds of this group. |
Overrides
| Edit this page View SourceOnAttach()
Called when the ILedGroup is attached to the RGBSurface.
Declaration
public override void OnAttach()
Overrides
| Edit this page View SourceOnDetach()
Called when the ILedGroup is detached from the RGBSurface.
Declaration
public override void OnDetach()
Overrides
| Edit this page View SourceToList()
Returns a list containing all Led in this group.
Declaration
public override IList<Led> ToList()
Returns
| Type | Description |
|---|---|
| IList<Led> | A list containing all Led in this group. |