#include <graphics.hpp>

Inheritance diagram for fcn::opengl::Graphics:

Public Member Functions
void	_beginDraw () override
void	_endDraw () override
void	drawBezier (PointVector const &points, int steps, unsigned int width) override
void	drawCircle (Point const &p, unsigned int radius) override
void	drawCircleSegment (Point const &p, unsigned int radius, int sangle, int eangle) override
void	drawFillCircle (Point const &p, unsigned int radius) override
void	drawFillCircleSegment (Point const &p, unsigned int radius, int sangle, int eangle) override
void	drawImage (fcn::Image const *image, int srcX, int srcY, int dstX, int dstY, int width, int height) override
void	drawImage (fcn::opengl::Image const *image, int srcX, int srcY, int dstX, int dstY, int width, int height)
virtual void	drawImage (Image const *image, int dstX, int dstY)
void	drawLine (int x1, int y1, int x2, int y2) override
void	drawLine (int x1, int y1, int x2, int y2, unsigned int width) override
void	drawPoint (int x, int y) override
void	drawPolyLine (PointVector const &points, unsigned int width) override
void	drawRectangle (Rectangle const &rectangle) override
void	fillRectangle (Rectangle const &rectangle) override
Color const &	getColor () const override
	Graphics ()
	Graphics (int width, int height)
void	popClipArea () override
bool	pushClipArea (Rectangle area) override
void	setColor (Color const &color) override
void	setTargetPlane (int width, int height)
Public Member Functions inherited from fcn::Graphics
virtual std::shared_ptr< Font >	createFont (std::string const &filename, int size)
void	drawRectangle (int x, int y, int width, int height)
virtual void	drawRoundStroke (int x1, int y1, int x2, int y2, unsigned int width)
void	drawText (std::string const &text, int x, int y)
virtual void	drawText (std::string const &text, int x, int y, Alignment alignment)
void	fillRectangle (int x, int y, int width, int height)
virtual ClipRectangle const &	getCurrentClipArea ()
	Graphics (Graphics &&)=delete
	Graphics (Graphics const &)=delete
Graphics &	operator= (Graphics &&)=delete
Graphics &	operator= (Graphics const &)=delete
virtual void	setFont (Font *font)

Protected Member Functions
virtual int	getTargetPlaneHeight () const
virtual int	getTargetPlaneWidth () const
virtual void	setTargetPlaneImpl (int width, int height)

Protected Attributes
bool	mAlpha {}
Color	mColor
int	mHeight {}
int	mWidth {}
Protected Attributes inherited from fcn::Graphics
std::stack< ClipRectangle >	mClipStack
Font *	mFont {nullptr}

Additional Inherited Members
Public Types inherited from fcn::Graphics
enum class	Alignment : uint8_t { Left = 0 , Center , Right }
enum class	VerticalAlignment : uint8_t { Top = 0 , Center , Bottom }

Detailed Description

OpenGL-specific implementation of the Graphics interface.

Definition at line 23 of file backends/opengl/graphics.hpp.

Constructor & Destructor Documentation

◆ Graphics() [1/2]

fcn::opengl::Graphics::Graphics ( )

Constructor.

Definition at line 28 of file backends/opengl/graphics.cpp.

References mHeight, and mWidth.

◆ Graphics() [2/2]

fcn::opengl::Graphics::Graphics	(	int	width,
		int	height )

Constructor.

Parameters

width	the width of the logical drawing surface. Should be the same as the screen resolution.
height	the height ot the logical drawing surface. Should be the same as the screen resolution.

Definition at line 32 of file backends/opengl/graphics.cpp.

References mHeight, and mWidth.

◆ ~Graphics()

fcn::opengl::Graphics::~Graphics ( )

overridevirtualdefault

Reimplemented from fcn::Graphics.

Member Function Documentation

◆ _beginDraw()

void fcn::opengl::Graphics::_beginDraw ( )

overridevirtual

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 is the OpenGLGraphics.

Note: You will never need to call this function yourself, unless you use a Graphics object outside the library.

See also: _endDraw, Gui::draw

Reimplemented from fcn::Graphics.

Definition at line 43 of file backends/opengl/graphics.cpp.

References mHeight, mWidth, and pushClipArea().

◆ _endDraw()

void fcn::opengl::Graphics::_endDraw ( )

overridevirtual

Deinitializes the drawing process.

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

Note: You generally won't need to call this function yourself unless you are using a Graphics object outside of the library.

See also: _beginDraw, Gui::draw

Reimplemented from fcn::Graphics.

Definition at line 80 of file backends/opengl/graphics.cpp.

References popClipArea().

◆ drawBezier()

void fcn::opengl::Graphics::drawBezier	(	PointVector const &	points,
		int	steps,
		unsigned int	width )

overridevirtual

Draws a bezier curve.

Parameters

points	The coordinates as points in a vector.
steps	The steps for each line between two points.
width	The line width.

Implements fcn::Graphics.

Definition at line 239 of file backends/opengl/graphics.cpp.

Referenced by drawImage().

◆ drawCircle()

void fcn::opengl::Graphics::drawCircle	(	Point const &	p,
		unsigned int	radius )

overridevirtual

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

Parameters

p	The circle center coordinate as point.
radius	The circle radius.

Implements fcn::Graphics.

Definition at line 278 of file backends/opengl/graphics.cpp.

Referenced by drawImage().

◆ drawCircleSegment()

void fcn::opengl::Graphics::drawCircleSegment	(	Point const &	p,
		unsigned int	radius,
		int	sangle,
		int	eangle )

overridevirtual

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

Note: The start angle must be less than the end angle. 0 angle is right side.

Parameters

p	The circle center coordinate as point.
radius	The circle radius.
sangle	The start angle of the segment.
eangle	The end angle of the segment.

Implements fcn::Graphics.

Definition at line 288 of file backends/opengl/graphics.cpp.

Referenced by drawImage().

◆ drawFillCircle()

void fcn::opengl::Graphics::drawFillCircle	(	Point const &	p,
		unsigned int	radius )

overridevirtual

Draws a filled circle.

Parameters

p	The circle center coordinate as point.
radius	The circle radius.

Implements fcn::Graphics.

Definition at line 283 of file backends/opengl/graphics.cpp.

Referenced by drawImage().

◆ drawFillCircleSegment()

void fcn::opengl::Graphics::drawFillCircleSegment	(	Point const &	p,
		unsigned int	radius,
		int	sangle,
		int	eangle )

overridevirtual

Draws a filled circle segment.

Note: The start angle must be less than the end angle. 0 angle is right side.

Parameters

p	The circle center coordinate as point.
radius	The circle radius.
sangle	The start angle of the segment.
eangle	The end angle of the segment.

Implements fcn::Graphics.

Definition at line 293 of file backends/opengl/graphics.cpp.

Referenced by drawImage().

◆ drawImage() [1/3]

void fcn::opengl::Graphics::drawImage	(	fcn::Image const *	image,
		int	srcX,
		int	srcY,
		int	dstX,
		int	dstY,
		int	width,
		int	height )

overridevirtual

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);

fcn::opengl::Graphics::drawImage
void drawImage(fcn::Image const *image, int srcX, int srcY, int dstX, int dstY, int width, int height) override
Draws a part of an image.
Definition backends/opengl/graphics.cpp:130

This draws a rectangular region of myImage starting at (10, 10) with width and height 40. The extracted region is placed with its top-left corner at (20, 20).

Parameters

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

See also: drawImage(const Image& image, int dstX, int dstY)

Implements fcn::Graphics.

Definition at line 130 of file backends/opengl/graphics.cpp.

References fcn::Graphics::mClipStack, fcn::throwException(), fcn::ClipRectangle::xOffset, and fcn::ClipRectangle::yOffset.

◆ drawImage() [2/3]

void fcn::opengl::Graphics::drawImage	(	fcn::opengl::Image const *	image,
		int	srcX,
		int	srcY,
		int	dstX,
		int	dstY,
		int	width,
		int	height )

Draws an OpenGL-specific image.

Parameters

image	Pointer to the OpenGL image to draw.
srcX	Source X coordinate.
srcY	Source Y coordinate.
dstX	Destination X coordinate.
dstY	Destination Y coordinate.
width	Width of the region to draw.
height	Height of the region to draw.

References drawBezier(), drawCircle(), drawCircleSegment(), drawFillCircle(), drawFillCircleSegment(), drawLine(), drawPoint(), drawPolyLine(), drawRectangle(), fillRectangle(), getColor(), getTargetPlaneHeight(), getTargetPlaneWidth(), setColor(), and setTargetPlaneImpl().

◆ drawImage() [3/3]

void fcn::Graphics::drawImage	(	Image const *	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.

Example: It is equivalent to calling:
drawImage(image, 0, 0, dstX, dstY, image->getWidth(), image->getHeight());

Parameters

image	The image to draw.
dstX	The destination x coordinate.
dstY	The destination y coordinate.

Reimplemented from fcn::Graphics.

Definition at line 200 of file graphics.cpp.

◆ drawLine() [1/2]

void fcn::opengl::Graphics::drawLine	(	int	x1,
		int	y1,
		int	x2,
		int	y2 )

overridevirtual

Draws a line.

Parameters

x1	The first x coordinate.
y1	The first y coordinate.
x2	The second x coordinate.
y2	The second y coordinate.

Implements fcn::Graphics.

Definition at line 201 of file backends/opengl/graphics.cpp.

References fcn::Graphics::mClipStack, fcn::throwException(), fcn::ClipRectangle::xOffset, and fcn::ClipRectangle::yOffset.

Referenced by drawImage().

◆ drawLine() [2/2]

void fcn::opengl::Graphics::drawLine	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		unsigned int	width )

overridevirtual

Draws a thick line.

Parameters

x1	The first x coordinate.
y1	The first y coordinate.
x2	The second x coordinate.
y2	The second y coordinate.
width	The line width.

Implements fcn::Graphics.

Definition at line 229 of file backends/opengl/graphics.cpp.

◆ drawPoint()

void fcn::opengl::Graphics::drawPoint	(	int	x,
		int	y )

overridevirtual

Draws a single point/pixel.

Parameters

x	The x coordinate.
y	The y coordinate.

Implements fcn::Graphics.

Definition at line 184 of file backends/opengl/graphics.cpp.

References fcn::Graphics::mClipStack, fcn::throwException(), fcn::ClipRectangle::xOffset, and fcn::ClipRectangle::yOffset.

Referenced by drawImage().

◆ drawPolyLine()

void fcn::opengl::Graphics::drawPolyLine	(	PointVector const &	points,
		unsigned int	width )

overridevirtual

Draws lines between points with given width.

Parameters

points	Contains the points that are used for drawing.
width	The line width.

Implements fcn::Graphics.

Definition at line 234 of file backends/opengl/graphics.cpp.

Referenced by drawImage().

◆ drawRectangle()

void fcn::opengl::Graphics::drawRectangle ( Rectangle const & rectangle )

overridevirtual

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

Parameters

rectangle The rectangle to draw.

Implements fcn::Graphics.

Definition at line 244 of file backends/opengl/graphics.cpp.

References fcn::Rectangle::height, fcn::Graphics::mClipStack, fcn::throwException(), fcn::Rectangle::width, fcn::Rectangle::x, fcn::ClipRectangle::xOffset, fcn::Rectangle::y, and fcn::ClipRectangle::yOffset.

Referenced by drawImage().

◆ fillRectangle()

void fcn::opengl::Graphics::fillRectangle ( Rectangle const & rectangle )

overridevirtual

Draws a filled rectangle.

Parameters

rectangle The filled rectangle to draw.

Implements fcn::Graphics.

Definition at line 261 of file backends/opengl/graphics.cpp.

References fcn::Rectangle::height, fcn::Graphics::mClipStack, fcn::throwException(), fcn::Rectangle::width, fcn::Rectangle::x, fcn::ClipRectangle::xOffset, fcn::Rectangle::y, and fcn::ClipRectangle::yOffset.

Referenced by drawImage().

◆ getColor()

Color const & fcn::opengl::Graphics::getColor ( ) const

overridevirtual

Gets the color to use when drawing.

Returns: The color used when drawing.

See also: setColor

Implements fcn::Graphics.

Definition at line 314 of file backends/opengl/graphics.cpp.

References mColor.

Referenced by drawImage().

◆ getTargetPlaneHeight()

int fcn::opengl::Graphics::getTargetPlaneHeight ( ) const

protectedvirtual

Gets the target plane height.

Returns: The target plane height.

Definition at line 324 of file backends/opengl/graphics.cpp.

References mHeight.

Referenced by drawImage().

◆ getTargetPlaneWidth()

int fcn::opengl::Graphics::getTargetPlaneWidth ( ) const

protectedvirtual

Gets the target plane width.

Returns: The target plane width.

Definition at line 319 of file backends/opengl/graphics.cpp.

References mWidth.

Referenced by drawImage().

◆ popClipArea()

void fcn::opengl::Graphics::popClipArea ( )

overridevirtual

Removes the top most clip area from the stack.

Exceptions

Exception if the stack is empty.

Reimplemented from fcn::Graphics.

Definition at line 109 of file backends/opengl/graphics.cpp.

References fcn::Graphics::mClipStack, mHeight, and fcn::Graphics::popClipArea().

Referenced by _endDraw().

◆ pushClipArea()

bool fcn::opengl::Graphics::pushClipArea ( Rectangle area )

overridevirtual

Pushes a clip area onto the stack.

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

If a clip area is outside of the top clip area a clip area with zero width and height will be pushed.

Parameters

area	The clip area to be pushed onto the stack.

Returns: False if the the new area lays outside the current clip area.

Reimplemented from fcn::Graphics.

Definition at line 96 of file backends/opengl/graphics.cpp.

References fcn::Graphics::mClipStack, mHeight, and fcn::Graphics::pushClipArea().

Referenced by _beginDraw().

◆ setColor()

void fcn::opengl::Graphics::setColor ( Color const & color )

overridevirtual

Sets the color to use when drawing.

Parameters

color A color.

See also: getColor

Implements fcn::Graphics.

Definition at line 298 of file backends/opengl/graphics.cpp.

References fcn::Color::a, fcn::Color::b, fcn::Color::g, mAlpha, mColor, and fcn::Color::r.

Referenced by drawImage().

◆ setTargetPlane()

void fcn::opengl::Graphics::setTargetPlane	(	int	width,
		int	height )

Sets the target plane on where to draw.

Parameters

width	the width of the logical drawing surface. Should be the same as the screen resolution.
height	the height ot the logical drawing surface. Should be the same as the screen resolution.

Definition at line 36 of file backends/opengl/graphics.cpp.

References setTargetPlaneImpl().

◆ setTargetPlaneImpl()

void fcn::opengl::Graphics::setTargetPlaneImpl	(	int	width,
		int	height )

protectedvirtual

Backend hook that actually applies the logical target plane size.

Subclasses may override to update platform or API specific state.

Parameters

width	Logical plane width in pixels.
height	Logical plane height in pixels.

Definition at line 124 of file backends/opengl/graphics.cpp.

References mHeight, and mWidth.

Referenced by drawImage(), and setTargetPlane().

Member Data Documentation

◆ mAlpha

bool fcn::opengl::Graphics::mAlpha {}

protected

Whether alpha blending is enabled.

Definition at line 140 of file backends/opengl/graphics.hpp.

Referenced by setColor().

◆ mColor

Color fcn::opengl::Graphics::mColor

protected

Current drawing color.

Definition at line 143 of file backends/opengl/graphics.hpp.

Referenced by getColor(), and setColor().

◆ mHeight

int fcn::opengl::Graphics::mHeight {}

protected

Height of the logical target plane.

Definition at line 137 of file backends/opengl/graphics.hpp.

Referenced by _beginDraw(), getTargetPlaneHeight(), Graphics(), Graphics(), popClipArea(), pushClipArea(), and setTargetPlaneImpl().

◆ mWidth

int fcn::opengl::Graphics::mWidth {}

protected

Width of the logical target plane.

Definition at line 134 of file backends/opengl/graphics.hpp.

Referenced by _beginDraw(), getTargetPlaneWidth(), Graphics(), Graphics(), and setTargetPlaneImpl().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Graphics() [1/2]

◆ Graphics() [2/2]

◆ ~Graphics()

Member Function Documentation

◆ _beginDraw()

◆ _endDraw()

◆ drawBezier()

◆ drawCircle()

◆ drawCircleSegment()

◆ drawFillCircle()

◆ drawFillCircleSegment()

◆ drawImage() [1/3]

◆ drawImage() [2/3]

◆ drawImage() [3/3]

◆ drawLine() [1/2]

◆ drawLine() [2/2]

◆ drawPoint()

◆ drawPolyLine()

◆ drawRectangle()

◆ fillRectangle()

◆ getColor()

◆ getTargetPlaneHeight()

◆ getTargetPlaneWidth()

◆ popClipArea()

◆ pushClipArea()

◆ setColor()

◆ setTargetPlane()

◆ setTargetPlaneImpl()

Member Data Documentation

◆ mAlpha

◆ mColor

◆ mHeight

◆ mWidth