PGFRect man page

PGFRect — Rectangle.

Synopsis

#include <PGFtypes.h>

Public Member Functions

PGFRect ()
Standard constructor.
PGFRect (UINT32 x, UINT32 y, UINT32 width, UINT32 height)

UINT32 Width () const

UINT32 Height () const

bool IsInside (UINT32 x, UINT32 y) const

Public Attributes

UINT32 left

UINT32 top

UINT32 right

UINT32 bottom

Detailed Description

Rectangle.

Rectangle

Author:

C. Stamm

Definition at line 194 of file PGFtypes.h.

Constructor & Destructor Documentation

PGFRect::PGFRect () [inline]

Standard constructor.

Definition at line 196 of file PGFtypes.h.

196 : left(0), top(0), right(0), bottom(0) {}

PGFRect::PGFRect (UINT32 x, UINT32 y, UINT32 width, UINT32 height) [inline]

Constructor

Parameters:

x Left offset
y Top offset
width Rectangle width
height Rectangle height

Definition at line 202 of file PGFtypes.h.

202 : left(x), top(y), right(x + width), bottom(y + height) {}

Member Function Documentation

UINT32 PGFRect::Height () const [inline]

Returns:

Rectangle height

Definition at line 207 of file PGFtypes.h.

207 { return bottom - top; }

bool PGFRect::IsInside (UINT32 x, UINT32 y) const [inline]

Test if point (x,y) is inside this rectangle

Parameters:

x Point coordinate x
y Point coordinate y

Returns:

True if point (x,y) is inside this rectangle

Definition at line 213 of file PGFtypes.h.

213 { return (x >= left && x < right && y >= top && y < bottom); }

UINT32 PGFRect::Width () const [inline]

Returns:

Rectangle width

Definition at line 205 of file PGFtypes.h.

205 { return right - left; }

Member Data Documentation

UINT32 PGFRect::bottom

Definition at line 215 of file PGFtypes.h.

UINT32 PGFRect::left

Definition at line 215 of file PGFtypes.h.

UINT32 PGFRect::right

Definition at line 215 of file PGFtypes.h.

UINT32 PGFRect::top

Definition at line 215 of file PGFtypes.h.

Author

Generated automatically by Doxygen for libpgf from the source code.

Info

Thu Feb 4 2016 Version 6.14.12 libpgf