____                _       __
    / __ )____  _____   | |     / /___ ___________
   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  )
 /_____/\____/____/     |__/|__/\__,_/_/  /____/

       A futuristic real-time strategy game.
          This file is part of Bos Wars.
(C) Copyright 2001-2007 by the Bos Wars and Stratagus Project. Distributed under the "GNU General Public License"

gcn::ClipRectangle Class Reference

#include <cliprectangle.h>

Inheritance diagram for gcn::ClipRectangle:

gcn::Rectangle

List of all members.

Public Member Functions

 ClipRectangle ()
 ClipRectangle (int x, int y, int width, int height, int xOffset, int yOffset)
const ClipRectangleoperator= (const Rectangle &other)

Public Attributes

int xOffset
int yOffset


Detailed Description

A rectangle used when dealing with clipping. It is a regular Rectangle extended with variables for x offsets and y offsets.

Definition at line 67 of file cliprectangle.h.


Constructor & Destructor Documentation

gcn::ClipRectangle::ClipRectangle (  ) 

gcn::ClipRectangle::ClipRectangle ( int  x,
int  y,
int  width,
int  height,
int  xOffset,
int  yOffset 
)

Constructor.

Parameters:
x the rectangle x coordinate.
y the rectangle y coordinate.
width the rectangle width.
height the rectangle height.
xOffset origin of drawing (used by Graphics).
yOffset origin of drawing (used by Graphics) .

Definition at line 68 of file cliprectangle.cpp.


Member Function Documentation

const ClipRectangle & gcn::ClipRectangle::operator= ( const Rectangle other  ) 

Copies x, y, width and height field from a Rectangle.

Parameters:
other the Rectangle to copy from.
Returns:
a ClipRectangle.

Definition at line 78 of file cliprectangle.cpp.

References gcn::Rectangle::height, gcn::Rectangle::width, gcn::Rectangle::x, and gcn::Rectangle::y.


Member Data Documentation


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

Generated on Sat Feb 21 00:28:26 2009 for Bos Wars by  doxygen 1.5.6