Fawkes API  Fawkes Development Version
VisualDisplay2D::Rectangle Class Reference

Class representing a rectangle. More...

#include "visdisplay.h"

Inheritance diagram for VisualDisplay2D::Rectangle:

Public Member Functions

 Rectangle (float x, float y, float width, float height, unsigned int id, unsigned int owner, fawkes::VisualDisplay2DInterface::LineStyle line_style=fawkes::VisualDisplay2DInterface::LS_SOLID, unsigned char r=0, unsigned char g=0, unsigned char b=0, unsigned char a=0)
 Constructor. More...
 
void draw (Cairo::RefPtr< Cairo::Context > &cr)
 Draw shape to Cairo context. More...
 
- Public Member Functions inherited from VisualDisplay2D::Shape
 Shape (unsigned int id, unsigned int owner, fawkes::VisualDisplay2DInterface::LineStyle line_style=fawkes::VisualDisplay2DInterface::LS_SOLID, unsigned char r=0, unsigned char g=0, unsigned char b=0, unsigned char a=0)
 Constructor. More...
 
virtual ~Shape ()
 Virtual empty destructor. More...
 
void apply_style (Cairo::RefPtr< Cairo::Context > &cr)
 Set style on context. More...
 
unsigned int id ()
 Get shape ID. More...
 
unsigned int owner ()
 Get owner ID. More...
 
void color (float &r, float &g, float &b, float &a)
 Get shape color. More...
 

Additional Inherited Members

- Protected Attributes inherited from VisualDisplay2D::Shape
fawkes::VisualDisplay2DInterface::LineStyle _line_style
 Line style. More...
 
float _color_r
 red part of RGBA object color More...
 
float _color_g
 green part of RGBA object color More...
 
float _color_b
 blue part of RGBA object color More...
 
float _color_a
 alpha part of RGBA object color More...
 
unsigned int _id
 Object ID. More...
 
unsigned int _owner
 Owner ID. More...
 

Detailed Description

Class representing a rectangle.

Rectangle represented the cartesian coordinates of the lower right corner and its width and height.

Author
Tim Niemueller

Definition at line 85 of file visdisplay.h.

Constructor & Destructor Documentation

◆ Rectangle()

VisualDisplay2D::Rectangle::Rectangle ( float  x,
float  y,
float  width,
float  height,
unsigned int  id,
unsigned int  owner,
fawkes::VisualDisplay2DInterface::LineStyle  line_style = fawkes::VisualDisplay2DInterface::LS_SOLID,
unsigned char  r = 0,
unsigned char  g = 0,
unsigned char  b = 0,
unsigned char  a = 0 
)

Constructor.

Parameters
xX coordinate of lower right point
yY coordinate of lower right point
widthwidth of rectangle
heightheight of rectangle
idobject ID
ownerID of the owner of the object
line_styledrawing style of lines of shapes
rred part of RGBA color
ggreen part of RGBA color
bblue part of RGBA color
aalpha part of RGBA color

Definition at line 263 of file visdisplay.cpp.

Member Function Documentation

◆ draw()

void VisualDisplay2D::Rectangle::draw ( Cairo::RefPtr< Cairo::Context > &  cr)
virtual

Draw shape to Cairo context.

This method shall be implemented by a shape to draw itself using the provided Cairo context.

Parameters
crreference to Cairo context. Note that this is a reference bypassing the reference pointer. This is done for efficiency and with the assumption that this method is only called by VisualDisplay2D::draw() which itself has proper refptr handling.

Implements VisualDisplay2D::Shape.

Definition at line 278 of file visdisplay.cpp.


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