ARGoS
3
A parallel, multi-engine simulator for swarm robotics
|
#include <ci_leds_actuator.h>
Public Types | |
typedef std::vector< CColor > | TSettings |
Public Member Functions | |
CCI_LEDsActuator () | |
virtual | ~CCI_LEDsActuator () |
size_t | GetNumLEDs () const |
Returns the number of LEDs. | |
virtual void | SetSingleColor (UInt32 un_led_number, const CColor &c_color) |
Sets the color of a single LED. | |
virtual void | SetAllColors (const CColor &c_color) |
Sets the color of the whole LED ring. | |
virtual void | SetAllColors (const TSettings &c_colors) |
Sets the color of the whole LED ring. | |
virtual void | SetSingleIntensity (UInt32 un_led_number, UInt8 un_intensity) |
Sets the intensity of a single LED in the ring. | |
virtual void | SetAllIntensities (UInt8 un_intensity) |
Sets the intensity of all the LEDs in the ring. | |
Protected Attributes | |
TSettings | m_tSettings |
Definition at line 19 of file ci_leds_actuator.h.
typedef std::vector<CColor> argos::CCI_LEDsActuator::TSettings |
Definition at line 23 of file ci_leds_actuator.h.
argos::CCI_LEDsActuator::CCI_LEDsActuator | ( | ) | [inline] |
Definition at line 27 of file ci_leds_actuator.h.
virtual argos::CCI_LEDsActuator::~CCI_LEDsActuator | ( | ) | [inline, virtual] |
Definition at line 29 of file ci_leds_actuator.h.
size_t argos::CCI_LEDsActuator::GetNumLEDs | ( | ) | const [inline] |
Returns the number of LEDs.
Definition at line 34 of file ci_leds_actuator.h.
void argos::CCI_LEDsActuator::SetAllColors | ( | const CColor & | c_color | ) | [virtual] |
Sets the color of the whole LED ring.
All the LEDs in the ring will be lit up in the same color. The method does not impact on the LED intensity: if the intensity was changed, the method updates the color but preserves the intensity previously set.
c_color | color to set |
Definition at line 109 of file ci_leds_actuator.cpp.
void argos::CCI_LEDsActuator::SetAllColors | ( | const TSettings & | c_colors | ) | [virtual] |
Sets the color of the whole LED ring.
All the LEDs in the ring will be lit up, it is possible to have a different color for each LED. Notice that the method also impacts on the intensity of the LED color: it is up to the user to modulate the alpha channel of the color if intensity reduction is needed.
c_colors | color to set for each LED. |
Definition at line 118 of file ci_leds_actuator.cpp.
void argos::CCI_LEDsActuator::SetAllIntensities | ( | UInt8 | un_intensity | ) | [virtual] |
Sets the intensity of all the LEDs in the ring.
Intensity is expressed in [0-255].
un_intensity | color to set for each LED. |
Definition at line 133 of file ci_leds_actuator.cpp.
void argos::CCI_LEDsActuator::SetSingleColor | ( | UInt32 | un_led_number, |
const CColor & | c_color | ||
) | [virtual] |
Sets the color of a single LED.
The method does not impact on the LED intensity: if the intensity was changed, the method updates the color but preserves the intensity previously set.
un_led_number | LED that must be set |
c_color | color to set |
Definition at line 101 of file ci_leds_actuator.cpp.
void argos::CCI_LEDsActuator::SetSingleIntensity | ( | UInt32 | un_led_number, |
UInt8 | un_intensity | ||
) | [virtual] |
Sets the intensity of a single LED in the ring.
Intensity is expressed in [0-255].
un_led_number | index of the LED whose intensity must be set. |
un_intensity | color to set for each LED. |
Definition at line 125 of file ci_leds_actuator.cpp.
TSettings argos::CCI_LEDsActuator::m_tSettings [protected] |
Definition at line 95 of file ci_leds_actuator.h.