#include <interfaces/VisualDisplay2DInterface.h>
Inheritance diagram for fawkes::VisualDisplay2DInterface:
Public Types | |
LS_SOLID | |
Solid line. | |
LS_DASHED | |
Dashed line. | |
LS_DOTTED | |
Dotted line. | |
LS_DASH_DOTTED | |
Dashed and dotted line. | |
CENTERED | |
Vertically and horitontally centered. | |
NORTH | |
Top and horiz. | |
EAST | |
Right and vert. | |
SOUTH | |
Bottom and horiz. | |
WEST | |
Left Right . | |
NORTH_EAST | |
Top right. | |
SOUTH_EAST | |
Bottom right. | |
SOUTH_WEST | |
Bottom left. | |
NORTH_WEST | |
Top left. | |
enum | LineStyle { LS_SOLID, LS_DASHED, LS_DOTTED, LS_DASH_DOTTED } |
Enumeration defining the possible line styles. More... | |
enum | Anchor { CENTERED, NORTH, EAST, SOUTH, WEST, NORTH_EAST, SOUTH_EAST, SOUTH_WEST, NORTH_WEST } |
Enumeration defining the possible anchor points. More... | |
Public Member Functions | |
const char * | tostring_LineStyle (LineStyle value) const |
Convert LineStyle constant to string. | |
const char * | tostring_Anchor (Anchor value) const |
Convert Anchor constant to string. | |
virtual bool | message_valid (const Message *message) const |
Check if message is valid and can be enqueued. | |
uint32_t | counter () const |
Get counter value. | |
void | set_counter (const uint32_t new_counter) |
Set counter value. | |
size_t | maxlenof_counter () const |
Get maximum length of counter value. | |
virtual Message * | create_message (const char *type) const |
Create message based on type name. | |
virtual void | copy_values (const Interface *other) |
Copy values from other interface. | |
virtual const char * | enum_tostring (const char *enumtype, int val) const |
Convert arbitrary enum value to string. | |
Classes | |
class | AddCartCircleMessage |
AddCartCircleMessage Fawkes BlackBoard Interface Message. More... | |
class | AddCartLineMessage |
AddCartLineMessage Fawkes BlackBoard Interface Message. More... | |
class | AddCartRectMessage |
AddCartRectMessage Fawkes BlackBoard Interface Message. More... | |
class | AddCartTextMessage |
AddCartTextMessage Fawkes BlackBoard Interface Message. More... | |
class | DeleteAllMessage |
DeleteAllMessage Fawkes BlackBoard Interface Message. More... | |
class | DeleteObjectMessage |
DeleteObjectMessage Fawkes BlackBoard Interface Message. More... | |
struct | VisualDisplay2DInterface_data_t |
Internal data storage, do NOT modify! |
This interface provides can be used by graphing applications to provide a graphing service to other components. This is intended to be used for debugging purposes. Usage of the interface should be optional to turn it off during a competition.
Add* messages will add the given object permanently, so the graphical display can be considered as a scenegraph. The message ID is becomes the ID and can be used to delete the object using the DeleteObjectMessage. With the DeleteAll message all objects can be removed (shall only remove objects added by the same sender, thus data drawn by other senders is not touched).
The units shall be in meters and radians. Color is given as four byte RGBA value, one byte for each R, G, B and Alpha.
Definition at line 33 of file VisualDisplay2DInterface.h.
Enumeration defining the possible anchor points.
They are used for determining text alignment towards the reference point. The point is at the appropriate position of the bounding box of the text.
Definition at line 58 of file VisualDisplay2DInterface.h.
Enumeration defining the possible line styles.
LS_SOLID | Solid line. |
LS_DASHED | Dashed line. |
LS_DOTTED | Dotted line. |
LS_DASH_DOTTED | Dashed and dotted line. |
Definition at line 44 of file VisualDisplay2DInterface.h.
void fawkes::VisualDisplay2DInterface::copy_values | ( | const Interface * | other | ) | [virtual] |
Copy values from other interface.
other | other interface to copy values from |
Implements fawkes::Interface.
Definition at line 174 of file VisualDisplay2DInterface.cpp.
References data, and fawkes::Interface::type().
uint32_t fawkes::VisualDisplay2DInterface::counter | ( | ) | const |
Get counter value.
Field
Definition at line 121 of file VisualDisplay2DInterface.cpp.
Message * fawkes::VisualDisplay2DInterface::create_message | ( | const char * | type | ) | const [virtual] |
Create message based on type name.
This will create a new message of the given type. The type must be given without the InterfaceName:: prefix but just the plain class name of the message.
type | message type |
UnknownTypeException | thrown if this interface cannot create a message of the given type. |
Implements fawkes::Interface.
Definition at line 149 of file VisualDisplay2DInterface.cpp.
const char * fawkes::VisualDisplay2DInterface::enum_tostring | ( | const char * | enumtype, | |
int | val | |||
) | const [virtual] |
Convert arbitrary enum value to string.
Given the string representation of the enum type and the value this method returns the string representation of the specific value, or the string UNKNOWN if the value is not defined. An exception is thrown if the enum type is invalid.
enumtype | enum type as string | |
val | value to convert |
UnknownTypeException | thrown if enumtype is not specified for interface. |
Implements fawkes::Interface.
Definition at line 185 of file VisualDisplay2DInterface.cpp.
References tostring_Anchor(), and tostring_LineStyle().
size_t fawkes::VisualDisplay2DInterface::maxlenof_counter | ( | ) | const |
Get maximum length of counter value.
Definition at line 131 of file VisualDisplay2DInterface.cpp.
bool fawkes::VisualDisplay2DInterface::message_valid | ( | const Message * | message | ) | const [virtual] |
Check if message is valid and can be enqueued.
message | Message to check |
Implements fawkes::Interface.
Definition at line 1452 of file VisualDisplay2DInterface.cpp.
void fawkes::VisualDisplay2DInterface::set_counter | ( | const uint32_t | new_counter | ) |
Set counter value.
Field
new_counter | new counter value |
Definition at line 141 of file VisualDisplay2DInterface.cpp.
References fawkes::Interface::data_changed.
const char * fawkes::VisualDisplay2DInterface::tostring_Anchor | ( | Anchor | value | ) | const |
Convert Anchor constant to string.
value | value to convert to string |
Definition at line 100 of file VisualDisplay2DInterface.cpp.
References CENTERED, EAST, NORTH, NORTH_EAST, NORTH_WEST, SOUTH, SOUTH_EAST, SOUTH_WEST, and WEST.
Referenced by enum_tostring().
const char * fawkes::VisualDisplay2DInterface::tostring_LineStyle | ( | LineStyle | value | ) | const |
Convert LineStyle constant to string.
value | value to convert to string |
Definition at line 85 of file VisualDisplay2DInterface.cpp.
References LS_DASH_DOTTED, LS_DASHED, LS_DOTTED, and LS_SOLID.
Referenced by enum_tostring().