Show / Hide Table of Contents

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
object
AbstractBindable
AbstractDecoratable<ILedGroupDecorator>
AbstractLedGroup
RectangleLedGroup
Implements
IBindable
ILedGroup
IDecoratable<ILedGroupDecorator>
IDecoratable
INotifyPropertyChanged
IEnumerable<Led>
IEnumerable
Inherited Members
AbstractLedGroup.Surface
AbstractLedGroup.Brush
AbstractLedGroup.ZIndex
AbstractLedGroup.GetEnumerator()
AbstractDecoratable<ILedGroupDecorator>.Decorators
AbstractDecoratable<ILedGroupDecorator>.AddDecorator(ILedGroupDecorator)
AbstractDecoratable<ILedGroupDecorator>.RemoveDecorator(ILedGroupDecorator)
AbstractDecoratable<ILedGroupDecorator>.RemoveAllDecorators()
AbstractBindable.PropertyChanged
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.ReferenceEquals(object, object)
object.ToString()
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 Source

RectangleLedGroup(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 null if the group should not be attached on creation.

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)

| Edit this page View Source

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 null if the group should not be attached on creation.

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)

| Edit this page View Source

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 null if the group should not be attached on creation.

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 Source

MinOverlayPercentage

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

Rectangle

Gets or sets the Rectangle the Led should be taken from.

Declaration
public Rectangle Rectangle { get; set; }
Property Value
Type Description
Rectangle

Methods

| Edit this page View Source

GetLeds()

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
AbstractLedGroup.GetLeds()
| Edit this page View Source

OnAttach()

Called when the ILedGroup is attached to the RGBSurface.

Declaration
public override void OnAttach()
Overrides
AbstractLedGroup.OnAttach()
| Edit this page View Source

OnDetach()

Called when the ILedGroup is detached from the RGBSurface.

Declaration
public override void OnDetach()
Overrides
AbstractLedGroup.OnDetach()
| Edit this page View Source

ToList()

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.

Overrides
AbstractLedGroup.ToList()

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