Struct ILLIXR::data_format::shapes::rect

ClassList > ILLIXR > data_format > shapes > rect

More...

• #include <shape.hpp>

Public Attributes

Type	Name
double	height height of the rectangle (parallel to y-axis when rotation angle is 0)
bool	normalized
double	rotation rotation angle of the rectangle in radians
bool	valid if the rectangle is valid
double	width width of the rectangle (parallel to x-axis when rotation angle is 0)
double	x_center x-coordinate of the rectangle's center
double	y_center y-coordinate of the rectangle's center

Public Functions

Type	Name
void	flip_y (const uint32_t im_height=0)
	rect ()
	rect (rect * other)
	rect (const double xc, const double yc, const double w, const double h, const double r, bool normal=false)
void	set (const double xc, const double yc, const double w, const double h, const double r, bool normal=false)

Detailed Description

Struct which defines a representation of a rectangle

Public Attributes Documentation

variable height

height of the rectangle (parallel to y-axis when rotation angle is 0)

double ILLIXR::data_format::shapes::rect::height;

---

variable normalized

bool ILLIXR::data_format::shapes::rect::normalized;

---

variable rotation

rotation angle of the rectangle in radians

double ILLIXR::data_format::shapes::rect::rotation;

---

variable valid

if the rectangle is valid

bool ILLIXR::data_format::shapes::rect::valid;

---

variable width

width of the rectangle (parallel to x-axis when rotation angle is 0)

double ILLIXR::data_format::shapes::rect::width;

---

variable x_center

x-coordinate of the rectangle's center

double ILLIXR::data_format::shapes::rect::x_center;

---

variable y_center

y-coordinate of the rectangle's center

double ILLIXR::data_format::shapes::rect::y_center;

---

Public Functions Documentation

function flip_y

inline void ILLIXR::data_format::shapes::rect::flip_y (
    const  uint32_t im_height=0
) 

Flip the y-coordinate about the center axis

Parameters:

• im_height

---

function rect [1/3]

inline ILLIXR::data_format::shapes::rect::rect () 

Generic constructor which sets all values to 0

---

function rect [2/3]

inline explicit ILLIXR::data_format::shapes::rect::rect (
    rect * other
) 

Copy constructor

Parameters:

• other The rect to copy

---

function rect [3/3]

inline ILLIXR::data_format::shapes::rect::rect (
    const  double xc,
    const  double yc,
    const  double w,
    const  double h,
    const  double r,
    bool normal=false
) 

General constructor

Parameters:

• xc the x-coordinate
• yc the y-coordinate
• w the width
• h the height
• r rotation angle

---

function set

inline void ILLIXR::data_format::shapes::rect::set (
    const  double xc,
    const  double yc,
    const  double w,
    const  double h,
    const  double r,
    bool normal=false
) 

Set the rect's values after construction

Parameters:

• xc the x-coordinate
• yc the y-coordinate
• w the width
• h the height
• r rotation angle

---

---

The documentation for this class was generated from the following file /home/friedel/devel/ILLIXR/illixr_release/ILLIXR/include/illixr/data_format/shape.hpp