Class Light

Lights are used with Vector's Cube.

Lights may either be "on" or "off", though in practice any colors may be assigned to either state (including no color/light).

Inheritance
Object
Light
Namespace: Anki.Vector.Types
Assembly: Anki.Vector.dll
Syntax
public class Light

Constructors

| Improve this Doc View Source

Light()

Initializes a new instance of the Light class.

public Light()
| Improve this Doc View Source

Light(Color)

Initializes a new instance of the Light class.

public Light(Color onColor)
Parameters
Type Name Description
Color onColor

Color shown when the light is on.
| Improve this Doc View Source

Light(Color, Color, UInt32, UInt32, UInt32, UInt32)

Initializes a new instance of the Light class.

public Light(Color onColor, Color offColor, uint onPeriodMs, uint offPeriodMs, uint transitionOnPeriodMs, uint transitionOffPeriodMs)
Parameters
Type Name Description
Color onColor

Color shown when the light is on.
Color offColor

Color shown when the light is off.
UInt32 onPeriodMs

The number of milliseconds the light should be "on" for for each cycle.
UInt32 offPeriodMs

The number of milliseconds the light should be "off" for for each cycle.
UInt32 transitionOnPeriodMs

The number of milliseconds to take to transition the light to the on color.
UInt32 transitionOffPeriodMs

The number of milliseconds to take to transition the light to the off color.

Properties

| Improve this Doc View Source

OffColor

Gets or sets the color shown when the light is off.

public Color OffColor { get; set; }
Property Type
Color
| Improve this Doc View Source

OffPeriodMs

Gets or sets the number of milliseconds the light should be "off" for for each cycle.

public uint OffPeriodMs { get; set; }
Property Type
UInt32
| Improve this Doc View Source

OnColor

Gets or sets the color shown when the light is on.

public Color OnColor { get; set; }
Property Type
Color
| Improve this Doc View Source

OnPeriodMs

Gets or sets the number of milliseconds the light should be "on" for for each cycle.

public uint OnPeriodMs { get; set; }
Property Type
UInt32
| Improve this Doc View Source

TransitionOffPeriodMs

Gets or sets the number of milliseconds to take to transition the light to the off color.

public uint TransitionOffPeriodMs { get; set; }
Property Type
UInt32
| Improve this Doc View Source

TransitionOnPeriodMs

Gets or sets the number of milliseconds to take to transition the light to the on color.

public uint TransitionOnPeriodMs { get; set; }
Property Type
UInt32