Class FlashDecorator

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
AbstractDecorator
AbstractUpdateAwareDecorator
FlashDecorator
Implements
Inherited Members
Namespace: RGB.NET.Presets.Decorators
Assembly: RGB.NET.Presets.dll
Syntax
public sealed class FlashDecorator : AbstractUpdateAwareDecorator, IBindable, INotifyPropertyChanged, IBrushDecorator, IDecorator

Constructors

| Edit this page View Source

FlashDecorator(RGBSurface, bool)

Creates a new FlashDecorator from the specified xml.

Declaration
public FlashDecorator(RGBSurface surface, bool updateIfDisabled = false)
Parameters
Type Name Description
RGBSurface surface

The surface this decorator belongs to.
bool updateIfDisabled

A value indicating if the decorator should be updated if it is disabled.

Properties

| Edit this page View Source

Attack

Gets or sets the attack-time (in seconds) of the decorator. (default: 0.2)
This is close to a synthesizer envelope. (See http://en.wikipedia.org/wiki/Synthesizer#ADSR_envelope as reference)

Declaration
public float Attack { get; set; }
Property Value
Type Description
float
| Edit this page View Source

AttackValue

Gets or sets the level to which the oppacity (percentage) should raise in the attack-cycle. (default: 1);

Declaration
public float AttackValue { get; set; }
Property Value
Type Description
float
| Edit this page View Source

Decay

Gets or sets the decay-time (in seconds) of the decorator. (default: 0)
This is close to a synthesizer envelope. (See http://en.wikipedia.org/wiki/Synthesizer#ADSR_envelope as reference)

Declaration
public float Decay { get; set; }
Property Value
Type Description
float
| Edit this page View Source

Interval

Gets or sets the interval (in seconds) in which the decorator should repeat (if repetition is enabled). (default: 1)

Declaration
public float Interval { get; set; }
Property Value
Type Description
float
| Edit this page View Source

PauseValue

Gets or sets the level at which the oppacity (percentage) should stay in the pause-cycle. (default: 0);

Declaration
public float PauseValue { get; set; }
Property Value
Type Description
float
| Edit this page View Source

Release

Gets or sets the release-time (in seconds) of the decorator. (default: 0.2)
This is close to a synthesizer envelope. (See http://en.wikipedia.org/wiki/Synthesizer#ADSR_envelope as reference)

Declaration
public float Release { get; set; }
Property Value
Type Description
float
| Edit this page View Source

Repetitions

Gets or sets the amount of repetitions the decorator should do until it's finished. Zero means infinite. (default: 0)

Declaration
public int Repetitions { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Sustain

Gets or sets the sustain-time (in seconds) of the decorator. (default: 0.3)
This is close to a synthesizer envelope. (See http://en.wikipedia.org/wiki/Synthesizer#ADSR_envelope as reference)
Note that this value for naming reasons represents the time NOT the level.

Declaration
public float Sustain { get; set; }
Property Value
Type Description
float
| Edit this page View Source

SustainValue

Gets or sets the level at which the oppacity (percentage) should stay in the sustain-cycle. (default: 1);

Declaration
public float SustainValue { get; set; }
Property Value
Type Description
float

Methods

| Edit this page View Source

ManipulateColor(in Rectangle, in RenderTarget, ref Color)

Decorator-Method called by the IBrush.

Declaration
public void ManipulateColor(in Rectangle rectangle, in RenderTarget renderTarget, ref Color color)
Parameters
Type Name Description
Rectangle rectangle

The rectangle in which the IBrush should be drawn.
RenderTarget renderTarget

The target (key/point) from which the Color should be taken.
Color color

The Color to be modified.
| Edit this page View Source

OnAttached(IDecoratable)

Attaches this IDecorator to the specified target.

Declaration
public override void OnAttached(IDecoratable decoratable)
Parameters
Type Name Description
IDecoratable decoratable

The object this IDecorator should be attached to.
Overrides
| Edit this page View Source

Update(double)

Updates this AbstractUpdateAwareDecorator.

Declaration
protected override void Update(double deltaTime)
Parameters
Type Name Description
double deltaTime

The elapsed time (in seconds) since the last update.
Overrides

Implements