libpgf  7.15.32
PGF - Progressive Graphics File
PGFRect Struct Reference

Rectangle. More...

#include <PGFtypes.h>

Public Member Functions

 PGFRect ()
 Standard constructor. More...
 
 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 222 of file PGFtypes.h.

Constructor & Destructor Documentation

◆ PGFRect() [1/2]

PGFRect::PGFRect ( )
inline

Standard constructor.

Definition at line 224 of file PGFtypes.h.

224 : left(0), top(0), right(0), bottom(0) {}
UINT32 right
Definition: PGFtypes.h:258
UINT32 top
Definition: PGFtypes.h:258
UINT32 left
Definition: PGFtypes.h:258
UINT32 bottom
Definition: PGFtypes.h:258

◆ PGFRect() [2/2]

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

Constructor

Parameters
xLeft offset
yTop offset
widthRectangle width
heightRectangle height

Definition at line 230 of file PGFtypes.h.

230 : left(x), top(y), right(x + width), bottom(y + height) {}
UINT32 right
Definition: PGFtypes.h:258
UINT32 top
Definition: PGFtypes.h:258
UINT32 left
Definition: PGFtypes.h:258
UINT32 bottom
Definition: PGFtypes.h:258

Member Function Documentation

◆ Height()

UINT32 PGFRect::Height ( ) const
inline
Returns
Rectangle height

Definition at line 250 of file PGFtypes.h.

250 { return bottom - top; }
UINT32 top
Definition: PGFtypes.h:258
UINT32 bottom
Definition: PGFtypes.h:258

◆ IsInside()

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

Test if point (x,y) is inside this rectangle (inclusive top-left edges, exclusive bottom-right edges)

Parameters
xPoint coordinate x
yPoint coordinate y
Returns
True if point (x,y) is inside this rectangle (inclusive top-left edges, exclusive bottom-right edges)

Definition at line 256 of file PGFtypes.h.

256 { return (x >= left && x < right && y >= top && y < bottom); }
UINT32 top
Definition: PGFtypes.h:258
UINT32 left
Definition: PGFtypes.h:258
UINT32 bottom
Definition: PGFtypes.h:258

◆ Width()

UINT32 PGFRect::Width ( ) const
inline
Returns
Rectangle width

Definition at line 248 of file PGFtypes.h.

248 { return right - left; }
UINT32 right
Definition: PGFtypes.h:258
UINT32 left
Definition: PGFtypes.h:258

Member Data Documentation

◆ bottom

UINT32 PGFRect::bottom

Definition at line 258 of file PGFtypes.h.

◆ left

UINT32 PGFRect::left

Definition at line 258 of file PGFtypes.h.

◆ right

UINT32 PGFRect::right

Definition at line 258 of file PGFtypes.h.

◆ top

UINT32 PGFRect::top

Definition at line 258 of file PGFtypes.h.


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