MosaicCanvas Class Reference

This is the actual mosaic data-structure which will hold the matrix of sub-images to be written. More...

#include <mosaiccanvas.h>

Public Member Functions
	MosaicCanvas (int theRows, int theColumns)
	Default constructor. More...
	MosaicCanvas (const MosaicCanvas &source)
	Copy constructor. More...
int	getRows () const
	Retrieve the number of rows of images. More...
int	getColumns () const
	Retrieve the number of columns of images. More...
void	setTile (int row, int column, TileImage *img)
	Set the TiledImage for a particular region. More...
const TileImage &	getTile (int row, int column)
	Retrieve the current TileImage for a particular row and column. More...
PNG	drawMosaic (int pixelsPerTile)
	Save the current MosaicCanvas as a file with the following pixels per tile. More...

Static Public Attributes
static bool	enableOutput = false

Detailed Description

This is the actual mosaic data-structure which will hold the matrix of sub-images to be written.

This is effectively just a 2-D array of TileImage objects which can be accessed via convenience methods.

Constructor & Destructor Documentation

MosaicCanvas() [1/2]

MosaicCanvas::MosaicCanvas	(	int	theRows,
		int	theColumns
	)

Default constructor.

Constructor.

Parameters

theRows	Number of rows to divide the canvas into
theColumns	Number of columns to divide the canvas into

MosaicCanvas() [2/2]

MosaicCanvas::MosaicCanvas

(

const MosaicCanvas &

source

)

Copy constructor.

Parameters

source

The MosaicCanvas object to copy

Member Function Documentation

drawMosaic()

PNG MosaicCanvas::drawMosaic

(

int

pixelsPerTile

)

Save the current MosaicCanvas as a file with the following pixels per tile.

Parameters

pixelsPerTile

pixels per Photomosaic tile

Returns

the Photomosaic as a PNG object

getColumns()

int MosaicCanvas::getColumns

(

)

const

Retrieve the number of columns of images.

Returns

The number of columns in the mosaic, or -1 on error

The number of columns in the mosaic, or -1 or error

getRows()

int MosaicCanvas::getRows

(

)

const

Retrieve the number of rows of images.

Returns

The number of rows in the mosaic, or -1 on error

The number or rows in the mosaic, or -1 on error

getTile()

const TileImage & MosaicCanvas::getTile	(	int	row,
		int	column
	)

Retrieve the current TileImage for a particular row and column.

If the row or column is out of bounds, the default TileImage is returned. Note that row and tile indices should be zero-based.

Parameters

row	The row
column	The column

Returns

The current TileImage for a particular, or the default TileImage if none is set.

setTile()

void MosaicCanvas::setTile	(	int	row,
		int	column,
		TileImage *	img
	)

Set the TiledImage for a particular region.

Note that row and tile indices should be zero-based.

Parameters

row	The row
column	The column
img	The TileImage to set

Returns

0 on success, or non-zero otherwise

---

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

• src/mosaiccanvas.h
• src/mosaiccanvas.cpp