gcn::Graphics Class Reference

#include <graphics.hpp>

Inheritance diagram for gcn::Graphics:

gcn::AllegroGraphics gcn::OpenGLGraphics gcn::SDLGraphics gcn::XGraphics List of all members.

Detailed Description

Used for drawing graphics.

It contains all vital functions for drawing. We include implemented Graphics classes for some common platforms like the Allegro library, the OpenGL library and the SDL library. To make Guichan usable under another platform, a Graphics class must be implemented.

In Graphics you can set clip areas to limit drawing to certain areas of the screen. Clip areas are put on a stack, which means that you can push smaller and smaller clip areas onto the stack. All coordinates will be relative to the topmost clip area. In most cases you won't have to worry about the clip areas, unless you want to implement some really complex widget. Pushing and poping of clip areas are handled automatically by container widgets when their child widgets are drawn.

IMPORTANT: Remember to pop each clip area that you pushed on the stack after you are done with it.

If you feel that Graphics is to restrictive for your needs, there is no one stopping you from using your own code for drawing in Widgets. You could for instance use pure SDL in the drawing of Widgets bypassing Graphics. This might however hurt portability of your application.

If you implement a Graphics class not present in Guichan we would be very happy to add it to Guichan.

See also:
AllegroGraphics, OpenGLGraphics, SDLGraphics, Image

Definition at line 100 of file graphics.hpp.

Public Types

 LEFT = 0
 CENTER
 RIGHT
enum  { LEFT = 0, CENTER, RIGHT }
 Alignments for text drawing.

Public Member Functions

 Graphics ()
virtual ~Graphics ()
virtual void _beginDraw ()
 Initializes drawing.
virtual void _endDraw ()
 Deinitializes drawing.
virtual bool pushClipArea (Rectangle area)
 Pushes a clip area onto the stack.
virtual void popClipArea ()
 Removes the topmost clip area from the stack.
virtual const ClipRectanglegetCurrentClipArea ()
 Gets the current clip area.
virtual void drawImage (const Image *image, int srcX, int srcY, int dstX, int dstY, int width, int height)=0
 Draws a part of an Image.
virtual void drawImage (const Image *image, int dstX, int dstY)
 Draws an image.
virtual void drawPoint (int x, int y)=0
 Draws a single point/pixel.
virtual void drawLine (int x1, int y1, int x2, int y2)=0
 Ddraws a line.
virtual void drawRectangle (const Rectangle &rectangle)=0
 Draws a simple, non-filled, Rectangle with one pixel width.
virtual void fillRectangle (const Rectangle &rectangle)=0
 Draws a filled Rectangle.
virtual void setColor (const Color &color)=0
 Sets the Color to use when drawing.
virtual const ColorgetColor ()=0
 Gets the Color to use when drawing.
virtual void setFont (Font *font)
 Sets the font to use when drawing text.
virtual void drawText (const std::string &text, int x, int y, unsigned int alignment=LEFT)
 Draws text.

Protected Attributes

std::stack< ClipRectanglemClipStack
FontmFont


Member Function Documentation

virtual void gcn::Graphics::_beginDraw (  )  [inline, virtual]

Initializes drawing.

Called by the Gui when Gui::draw() is called. It is needed by some implementations of Graphics to perform preparations before drawing. An example of such an implementation would be OpenGLGraphics.

NOTE: You will never need to call this function yourself. Gui will do it for you.

See also:
_endDraw, Gui::draw

Reimplemented in gcn::AllegroGraphics, gcn::OpenGLGraphics, and gcn::SDLGraphics.

Definition at line 118 of file graphics.hpp.

Referenced by gcn::Gui::draw().

virtual void gcn::Graphics::_endDraw (  )  [inline, virtual]

Deinitializes drawing.

Called by the Gui when a Gui::draw() is done. done. It should reset any state changes made by _beginDraw().

NOTE: You will never need to call this function yourself. Gui will do it for you.

See also:
_beginDraw, Gui::draw

Reimplemented in gcn::AllegroGraphics, gcn::OpenGLGraphics, and gcn::SDLGraphics.

Definition at line 129 of file graphics.hpp.

Referenced by gcn::Gui::draw().

void gcn::Graphics::drawImage ( const Image image,
int  dstX,
int  dstY 
) [virtual]

Draws an image.

A simplified version of the other drawImage. It will draw a whole image at the coordinate you specify. It is equivalent to calling:

 drawImage(myImage, 0, 0, dstX, dstY, image->getWidth(), \
         image->getHeight()); 

Definition at line 124 of file graphics.cpp.

References drawImage(), gcn::Image::getHeight(), and gcn::Image::getWidth().

virtual void gcn::Graphics::drawImage ( const Image image,
int  srcX,
int  srcY,
int  dstX,
int  dstY,
int  width,
int  height 
) [pure virtual]

Draws a part of an Image.

NOTE: Width and height arguments will not scale the Image but specifies the size of the part to be drawn. If you want to draw the whole Image there is a simplified version of this function.

EXAMPLE:

 drawImage(myImage, 10, 10, 20, 20, 40, 40); 
Will draw a rectangular piece of myImage starting at coordinate (10, 10) in myImage, with width and height 40. The piece will be drawn with it's top left corner at coordinate (20, 20).

Parameters:
image the Image to draw.
srcX source Image x coordinate.
srcY source Image y coordinate.
dstX destination x coordinate.
dstY destination y coordinate.
width the width of the piece.
height the height of the piece.

Implemented in gcn::AllegroGraphics, gcn::OpenGLGraphics, and gcn::SDLGraphics.

Referenced by gcn::Icon::draw(), gcn::ImageFont::drawGlyph(), and drawImage().

virtual void gcn::Graphics::drawLine ( int  x1,
int  y1,
int  x2,
int  y2 
) [pure virtual]

Ddraws a line.

Parameters:
x1 the first x coordinate.
y1 the first y coordinate.
x2 the second x coordinate.
y2 the second y coordinate.

Implemented in gcn::AllegroGraphics, gcn::OpenGLGraphics, and gcn::SDLGraphics.

Referenced by gcn::Window::draw(), gcn::Button::draw(), gcn::Window::drawBorder(), gcn::TextField::drawBorder(), gcn::TextBox::drawBorder(), gcn::Slider::drawBorder(), gcn::ScrollArea::drawBorder(), gcn::RadioButton::drawBorder(), gcn::ListBox::drawBorder(), gcn::Label::drawBorder(), gcn::Icon::drawBorder(), gcn::DropDown::drawBorder(), gcn::Container::drawBorder(), gcn::CheckBox::drawBorder(), gcn::Button::drawBorder(), gcn::RadioButton::drawBox(), gcn::CheckBox::drawBox(), gcn::DropDown::drawButton(), gcn::TextField::drawCaret(), gcn::TextBox::drawCaret(), gcn::ScrollArea::drawDownButton(), gcn::ScrollArea::drawHBar(), gcn::ScrollArea::drawHMarker(), gcn::ScrollArea::drawLeftButton(), gcn::Slider::drawMarker(), gcn::ScrollArea::drawRightButton(), gcn::ScrollArea::drawUpButton(), gcn::ScrollArea::drawVBar(), and gcn::ScrollArea::drawVMarker().

virtual void gcn::Graphics::drawPoint ( int  x,
int  y 
) [pure virtual]

Draws a single point/pixel.

Parameters:
x the x coordinate.
y the y coordinate.

Implemented in gcn::AllegroGraphics, gcn::OpenGLGraphics, and gcn::SDLGraphics.

virtual void gcn::Graphics::drawRectangle ( const Rectangle rectangle  )  [pure virtual]

Draws a simple, non-filled, Rectangle with one pixel width.

Parameters:
rectangle the Rectangle to draw.

Implemented in gcn::AllegroGraphics, gcn::OpenGLGraphics, and gcn::SDLGraphics.

Referenced by gcn::RadioButton::draw(), gcn::ListBox::draw(), gcn::DropDown::draw(), gcn::CheckBox::draw(), gcn::Button::draw(), gcn::ImageFont::drawGlyph(), gcn::DefaultFont::drawGlyph(), and gcn::Slider::drawMarker().

void gcn::Graphics::drawText ( const std::string &  text,
int  x,
int  y,
unsigned int  alignment = LEFT 
) [virtual]

Draws text.

Parameters:
text the text to draw.
x the x coordinate where to draw the text.
y the y coordinate where to draw the text.
alignment Graphics::LEFT, Graphics::CENTER or Graphics::RIGHT.
Exceptions:
Exception when no Font is set.

Definition at line 134 of file graphics.cpp.

References gcn::Font::drawString(), gcn::Font::getWidth(), and mFont.

Referenced by gcn::Window::draw(), gcn::TextField::draw(), gcn::TextBox::draw(), gcn::RadioButton::draw(), gcn::ListBox::draw(), gcn::Label::draw(), gcn::DropDown::draw(), gcn::CheckBox::draw(), and gcn::Button::draw().

virtual void gcn::Graphics::fillRectangle ( const Rectangle rectangle  )  [pure virtual]

Draws a filled Rectangle.

Parameters:
rectangle the filled Rectangle to draw.

Implemented in gcn::AllegroGraphics, gcn::OpenGLGraphics, and gcn::SDLGraphics.

Referenced by gcn::Window::draw(), gcn::TextField::draw(), gcn::TextBox::draw(), gcn::Slider::draw(), gcn::ScrollArea::draw(), gcn::ListBox::draw(), gcn::DropDown::draw(), gcn::Container::draw(), gcn::Button::draw(), gcn::ScrollArea::drawBackground(), gcn::CheckBox::drawBox(), gcn::DropDown::drawButton(), gcn::ScrollArea::drawDownButton(), gcn::ScrollArea::drawHBar(), gcn::ScrollArea::drawHMarker(), gcn::ScrollArea::drawLeftButton(), gcn::Slider::drawMarker(), gcn::ScrollArea::drawRightButton(), gcn::ScrollArea::drawUpButton(), gcn::ScrollArea::drawVBar(), and gcn::ScrollArea::drawVMarker().

virtual const Color& gcn::Graphics::getColor (  )  [pure virtual]

Gets the Color to use when drawing.

Returns:
the Color used when drawing.

Implemented in gcn::AllegroGraphics, gcn::OpenGLGraphics, and gcn::SDLGraphics.

const ClipRectangle & gcn::Graphics::getCurrentClipArea (  )  [virtual]

Gets the current clip area.

Usefull if you want to do drawing bypassing Graphics.

Returns:
the current clip area.

Definition at line 114 of file graphics.cpp.

References mClipStack.

void gcn::Graphics::popClipArea (  )  [virtual]

Removes the topmost clip area from the stack.

Exceptions:
Exception if the stack is empty.

Reimplemented in gcn::AllegroGraphics, gcn::OpenGLGraphics, and gcn::SDLGraphics.

Definition at line 103 of file graphics.cpp.

References mClipStack.

Referenced by gcn::Gui::draw(), gcn::BasicContainer::drawChildren(), gcn::ScrollArea::drawDownButton(), gcn::ScrollArea::drawHBar(), gcn::ScrollArea::drawHMarker(), gcn::ScrollArea::drawLeftButton(), gcn::ScrollArea::drawRightButton(), gcn::ScrollArea::drawUpButton(), gcn::ScrollArea::drawVBar(), gcn::ScrollArea::drawVMarker(), gcn::SDLGraphics::popClipArea(), gcn::OpenGLGraphics::popClipArea(), and gcn::AllegroGraphics::popClipArea().

bool gcn::Graphics::pushClipArea ( Rectangle  area  )  [virtual]

Pushes a clip area onto the stack.

The x and y coordinates in the Rectangle will be relative to the last pushed clip area. If the new area falls outside the current clip area, it will be clipped as necessary.

Parameters:
area the clip area to be pushed onto the stack.
Returns:
false if the the new area lays totally outside the current clip area. Note that an empty clip area will be pused in this case.

Reimplemented in gcn::AllegroGraphics, gcn::OpenGLGraphics, and gcn::SDLGraphics.

Definition at line 75 of file graphics.cpp.

References gcn::Rectangle::height, gcn::Rectangle::intersect(), mClipStack, gcn::Rectangle::width, gcn::Rectangle::x, gcn::ClipRectangle::xOffset, gcn::Rectangle::y, and gcn::ClipRectangle::yOffset.

Referenced by gcn::Gui::draw(), gcn::BasicContainer::drawChildren(), gcn::ScrollArea::drawDownButton(), gcn::ScrollArea::drawHBar(), gcn::ScrollArea::drawHMarker(), gcn::ScrollArea::drawLeftButton(), gcn::ScrollArea::drawRightButton(), gcn::ScrollArea::drawUpButton(), gcn::ScrollArea::drawVBar(), gcn::ScrollArea::drawVMarker(), gcn::SDLGraphics::pushClipArea(), gcn::OpenGLGraphics::pushClipArea(), and gcn::AllegroGraphics::pushClipArea().

virtual void gcn::Graphics::setColor ( const Color color  )  [pure virtual]

Sets the Color to use when drawing.

Parameters:
color a Color.

Implemented in gcn::AllegroGraphics, gcn::OpenGLGraphics, and gcn::SDLGraphics.

Referenced by gcn::Window::draw(), gcn::TextField::draw(), gcn::TextBox::draw(), gcn::Slider::draw(), gcn::ScrollArea::draw(), gcn::RadioButton::draw(), gcn::ListBox::draw(), gcn::Label::draw(), gcn::DropDown::draw(), gcn::Container::draw(), gcn::CheckBox::draw(), gcn::Button::draw(), gcn::ScrollArea::drawBackground(), gcn::Window::drawBorder(), gcn::TextField::drawBorder(), gcn::TextBox::drawBorder(), gcn::Slider::drawBorder(), gcn::ScrollArea::drawBorder(), gcn::RadioButton::drawBorder(), gcn::ListBox::drawBorder(), gcn::Label::drawBorder(), gcn::Icon::drawBorder(), gcn::DropDown::drawBorder(), gcn::Container::drawBorder(), gcn::CheckBox::drawBorder(), gcn::Button::drawBorder(), gcn::RadioButton::drawBox(), gcn::CheckBox::drawBox(), gcn::DropDown::drawButton(), gcn::TextField::drawCaret(), gcn::TextBox::drawCaret(), gcn::ScrollArea::drawDownButton(), gcn::ScrollArea::drawHBar(), gcn::ScrollArea::drawHMarker(), gcn::ScrollArea::drawLeftButton(), gcn::Slider::drawMarker(), gcn::ScrollArea::drawRightButton(), gcn::ScrollArea::drawUpButton(), gcn::ScrollArea::drawVBar(), and gcn::ScrollArea::drawVMarker().

void gcn::Graphics::setFont ( Font font  )  [virtual]

Sets the font to use when drawing text.

Parameters:
font the Font to use when drawing.

Definition at line 129 of file graphics.cpp.

References mFont.

Referenced by gcn::Window::draw(), gcn::TextField::draw(), gcn::TextBox::draw(), gcn::RadioButton::draw(), gcn::ListBox::draw(), gcn::Label::draw(), gcn::DropDown::draw(), gcn::CheckBox::draw(), and gcn::Button::draw().


The documentation for this class was generated from the following files:
Generated on Sat Jul 29 19:38:48 2006 for Guichan by  doxygen 1.4.7