PlayerCc::Graphics2dProxy Class Reference

The Graphics2dProxy class is used to draw simple graphics into a rendering device provided by Player using the graphics2d interface. More...

#include <playerc++.h>

Inheritance diagram for PlayerCc::Graphics2dProxy:
Inheritance graph
Collaboration diagram for PlayerCc::Graphics2dProxy:
Collaboration graph

Detailed Description

The Graphics2dProxy class is used to draw simple graphics into a rendering device provided by Player using the graphics2d interface.

For example, the Stage plugin implements this interface so you can draw into the Stage window. This is very useful to visualize what's going on in your controller.

Public Member Functions

 Graphics2dProxy (PlayerClient *aPc, uint32_t aIndex=0)
 Constructor.
 
 ~Graphics2dProxy ()
 Destructor.
 
void Color (player_color_t col)
 Set the current pen color.
 
void Color (uint8_t red, uint8_t green, uint8_t blue, uint8_t alpha)
 Set the current pen color.
 
void Clear (void)
 Clear the drawing area.
 
void DrawPoints (player_point_2d_t pts[], int count)
 Draw a set of points.
 
void DrawPolygon (player_point_2d_t pts[], int count, bool filled, player_color_t fill_color)
 Draw a polygon defined by a set of points.
 
void DrawPolyline (player_point_2d_t pts[], int count)
 Draw a line connecting set of points.
 
void DrawMultiline (player_point_2d_t pts[], int count)
 Draw multiple lines. Lines ending points are at pts[2n] pts[2n+1] where 2n+1<count.
 
- Public Member Functions inherited from PlayerCc::ClientProxy
bool IsValid () const
 Proxy has any information. More...
 
bool IsFresh () const
 Check for fresh data. More...
 
void NotFresh ()
 Reset Fresh flag. More...
 
std::string GetDriverName () const
 Get the underlying driver's name. More...
 
double GetDataTime () const
 Returns the received timestamp of the last data sample [s].
 
double GetElapsedTime () const
 Returns the time between the current data time and the time of the last data sample [s].
 
PlayerClientGetPlayerClient () const
 Get a pointer to the Player Client. More...
 
uint32_t GetIndex () const
 Get device index. More...
 
uint32_t GetInterface () const
 Get Interface Code. More...
 
std::string GetInterfaceStr () const
 Get Interface Name. More...
 
void SetReplaceRule (bool aReplace, int aType=-1, int aSubtype=-1)
 Set a replace rule for this proxy on the server. More...
 
int HasCapability (uint32_t aType, uint32_t aSubtype)
 Request capabilities of device. More...
 
int GetBoolProp (char *aProperty, bool *aValue)
 Request a boolean property. More...
 
int SetBoolProp (char *aProperty, bool aValue)
 Set a boolean property. More...
 
int GetIntProp (char *aProperty, int32_t *aValue)
 Request an integer property. More...
 
int SetIntProp (char *aProperty, int32_t aValue)
 Set an integer property. More...
 
int GetDblProp (char *aProperty, double *aValue)
 Request a double property. More...
 
int SetDblProp (char *aProperty, double aValue)
 Set a double property. More...
 
int GetStrProp (char *aProperty, char **aValue)
 Request a string property. More...
 
int SetStrProp (char *aProperty, char *aValue)
 Set a string property. More...
 
template<typename T >
connection_t ConnectReadSignal (T aSubscriber)
 Connect a read signal to this proxy. More...
 
void DisconnectReadSignal (connection_t aSubscriber)
 Disconnect a signal from this proxy. More...
 

Private Member Functions

void Subscribe (uint32_t aIndex)
 
void Unsubscribe ()
 

Private Attributes

playerc_graphics2d_tmDevice
 

Additional Inherited Members

- Public Types inherited from PlayerCc::ClientProxy
typedef int connection_t
 
typedef boost::mutex::scoped_lock scoped_lock_t
 
typedef int read_signal_t
 
- Protected Member Functions inherited from PlayerCc::ClientProxy
 ClientProxy (PlayerClient *aPc, uint32_t aIndex)
 
template<typename T >
GetVar (const T &aV) const
 
template<typename T >
void GetVarByRef (const T aBegin, const T aEnd, T aDest) const
 
- Protected Attributes inherited from PlayerCc::ClientProxy
PlayerClientmPc
 
playerc_client_tmClient
 
playerc_device_tmInfo
 
bool mFresh
 

The documentation for this class was generated from the following file: