TdkAbstractGraphicalService Class Reference
[The Core Module]

#include <TdkAbstractGraphicalService.h>

Inheritance diagram for TdkAbstractGraphicalService:


Public Member Functions
virtual void	initialize ()=0
	Method called in the applicaiton initialization.
virtual void	finalize ()=0
	Method called when the applicaiton is closing.
virtual void	drawView (TeView &view, TdkCanvas &canvas, int buffer=TdkCanvas::cbrBack, double angle=0., TdkMathMatrix *matrix=NULL, bool refreshTheme=true)=0
virtual void	drawView (TeView &view, TdkImageRGB &image, TeBox &world, TeColor &backgroundColor)=0
virtual void	drawViewTree (TeViewTree viewTree, TdkCanvas canvas, int buffer=TdkCanvas::cbrBack, double angle=0., TdkMathMatrix *matrix=NULL, bool refreshTheme=true)=0
virtual void	drawTheme (TdkTheme &theme, TdkCanvas &canvas, TeProjection &projection, double angle=0., TdkMathMatrix *matrix=NULL)=0
virtual void	drawTheme (TdkTheme &theme, TdkImageRGB &image, TeProjection &projection, TeBox &world, TeColor &backgroundColor)=0
virtual void	drawThemeObjects (TdkThemeObjects &tobjs, int color_red, int color_green, int color_blue, double world_x1, double world_y1, double world_x2, double world_y2, TeProjection &projection, int image_width, int image_height, int backcolor_red, int backcolor_green, int backcolor_blue, unsigned char red, unsigned char green, unsigned char *blue)=0
virtual TeDecoderMemory *	TdkGetLayerRaster (TdkLayer *layer, const TeBox &box, double scale)=0
virtual long int *	createCanvasPalette (TeRasterParams &par)=0
virtual TdkImageRepType	getRasterColorModel (TeRasterParams &par)=0
virtual void	drawRasterFile (TeRaster raster, TdkCanvas canvas, double angle, TdkMathMatrix *matrix, bool useMask, unsigned char maskRed, unsigned char maskGreen, unsigned char maskBlue)=0
virtual TdkImageFormatted *	createImage (TdkCanvas *canvas, TdkImageFormat format)=0
virtual void	wc2pixel (double &pX, double &pY, double wcX, double wcY, int width, int height, double wcXmin, double wcYmin, double wcXmax, double wcYmax)=0
virtual void	pixel2wc (double &wcX, double &wcY, double pX, double pY, int width, int height, double wcXmin, double wcYmin, double wcXmax, double wcYmax)=0
virtual void	pickBox (double pixelX, double pixelY, int width, int height, double wcXmin, double wcYmin, double wcXmax, double wcYmax, double &xmin, double &ymin, double &xmax, double &ymax, int tollerance=2)=0
virtual double	getPixelSize (TdkCanvas *canvas, double scale)=0
virtual double	getScale (TdkCanvas *canvas, double pixelSize)=0
virtual void	drawPoint (TdkPointStyle &style, TdkCanvas &canvas, TePoint &point, TeColor &externColor, double externSizeFactor)=0
	TODO: Complete mehtod documentation.
virtual void	drawPointSample (TdkPointStyle &style, TdkCanvas &canvas, int x, int y, TeColor &externColor)=0
	TODO: Complete method documentation.
virtual void	drawPolygonContour (TdkPolygonStyle &style, TdkCanvas &canvas, TePolygon &polygon, TeColor &externContournColor, double externSizeFactor)=0
	TODO: Complete method documentation.
virtual void	drawPolygonContourSample (TdkPolygonStyle &style, TdkCanvas &canvas, int x, int y, TeColor &externContournColor)=0
	TODO: Complete method documentation.
virtual void	drawPolygon (TdkPolygonStyle &style, TdkCanvas &canvas, TePolygon &polygon, TeColor &externColor, TeColor &externContourColor, double externSizeFactor)=0
	TODO: Complete method documentation.
virtual void	drawPolygonSample (TdkPolygonStyle &style, TdkCanvas &canvas, int x, int y, TeColor &externColor, TeColor &externContourColor)=0
	TODO: Complete method documentation.
virtual void	drawText (TdkTextStyle &style, TdkCanvas &canvas, TeText &text, TeColor &externColor, double externWidthFactor)=0
virtual void	drawTextSample (TdkTextStyle &style, TdkCanvas &canvas, int x, int y, TeColor &externColor)=0
virtual void	drawLineVertex (TdkLineStyle &style, TdkCanvas *canvas, TeLine2D &line, TeColor &externVertexColor, double externSizeFactor)=0
	TODO: Document this method.
virtual void	drawLine (TdkLineStyle &style, TdkCanvas *canvas, TeLine2D &line, TeColor &externColor, double externWidthFactor)=0
	TODO: Document this method.
virtual void	drawLineSample (TdkLineStyle &style, TdkCanvas *canvas, int x, int y, TeColor &externColor)=0
	TODO: Document this method.
virtual void	drawLineSampleContour (TdkLineStyle &style, TdkCanvas *canvas, int x, int y, TeColor &externColor)=0
	TODO: Document this method.
virtual void	drawGeometry (TePolygon &geom, TdkCanvas *canvas, double size_factor, TeLegendEntry &legendEntry, const TeBox &drawArea)=0
virtual void	drawGeometry (TeLine2D &geom, TdkCanvas *canvas, double size_factor, TeLegendEntry &legendEntry, const TeBox &drawArea)=0
virtual void	drawGeometry (TePoint &geom, TdkCanvas *canvas, double size_factor, TeLegendEntry &legendEntry, const TeBox &drawArea)=0
virtual void	drawGeometry (TeText &geom, TdkCanvas *canvas, double size_factor, TeLegendEntry &legendEntry, const TeBox &drawArea)=0
virtual void	drawGeometrySet (TePointSet &geomSet, TdkCanvas *canvas, double size_factor, TeLegendEntry &legendEntry, const TeBox &drawArea)=0
virtual void	drawGeometrySet (TeLineSet &geomSet, TdkCanvas *canvas, double size_factor, TeLegendEntry &legendEntry, const TeBox &drawArea)=0
virtual void	drawGeometrySet (TePolygonSet &geomSet, TdkCanvas *canvas, double size_factor, TeLegendEntry &legendEntry, const TeBox &drawArea)=0
virtual void	drawGeometrySet (TeTextSet &geomSet, TdkCanvas *canvas, double size_factor, TeLegendEntry &legendEntry, const TeBox &drawArea)=0
	Draws a geometries set in a given canvas.
virtual void	drawGeometryVector (std::vector< TePolygon * > &geoms, TdkCanvas *canvas, double size_factor, TeLegendEntry &legendEntry, const TeBox &drawArea)=0
virtual void	drawGeometryVector (std::vector< TePoint * > &geoms, TdkCanvas *canvas, double size_factor, TeLegendEntry &legendEntry, const TeBox &drawArea)=0
virtual void	drawGeometryVector (std::vector< TeLine2D * > &geoms, TdkCanvas *canvas, double size_factor, TeLegendEntry &legendEntry, const TeBox &drawArea)=0
virtual void	drawGeometryVector (std::vector< TeText * > &geoms, TdkCanvas *canvas, double size_factor, TeLegendEntry &legendEntry, const TeBox &drawArea)=0
	Draws geometries in a given canvas.
virtual void	drawMultiGeometry (TeMultiGeometry &geometries, TdkCanvas canvas, double size_factor, TdkMathMatrix matrix, TeLegendEntry &legendEntry, const TeBox &drawArea)=0
	Draws geometries in a given canvas.
virtual void	drawMultiGeometry (TeMultiGeometry &geometries, TdkCanvas canvas, double size_factor, TdkMathMatrix matrix, TdkTheme *theme, const TeBox &drawArea)=0
virtual void	setPolygonStyle (TdkVisual style, TdkCanvas cv)=0
virtual void	setLineStyle (TdkVisual style, TdkCanvas cv)=0
virtual void	setPointStyle (TdkVisual style, TdkCanvas cv)=0
virtual void	setTextStyle (TdkVisual style, TdkCanvas cv)=0
virtual void	drawObjectsIdentification (TeViewTree viewtree, TdkCanvas canvas)=0
virtual void	drawObjectIdentification (TeCoord2D c, string text, TdkCanvas *canvas)=0
virtual void	drawSelectedObjects (TeViewTree viewtree, TdkCanvas canvas)=0
virtual void	drawLegend (TeViewTree viewTree, TdkCanvas canvas, double wx0, double wy0, double wx1, double wy1, bool multipleColumns, TdkViewNodeMap *nodeMap=NULL)=0
	Draws a legend (related to a TerraLib view) in a canvas.
virtual void	drawLegend (TdkViewNodeMap &nodeMap, TdkCanvas *canvas, double wx0, double wy0, double wx1, double wy1, bool multipleColumns)=0
	Draws a legend (related to a TdkViewNodeMap) in a canvas.

Detailed Description

TdkAbstractGraphicalService class. This class represents the interface for the Graphical Service in a TDK application

Member Function Documentation

virtual void TdkAbstractGraphicalService::initialize ( ) [pure virtual]

Method called in the applicaiton initialization.

Implemented in TdkDefaultGraphicalService.

virtual void TdkAbstractGraphicalService::finalize ( ) [pure virtual]

Method called when the applicaiton is closing.

Implemented in TdkDefaultGraphicalService.

virtual void TdkAbstractGraphicalService::drawView	(	TeView &	view,
		TdkCanvas &	canvas,
		int	buffer = `TdkCanvas::cbrBack`,
		double	angle = `0.`,
		TdkMathMatrix *	matrix = `NULL`,
		bool	refreshTheme = `true`
	)			`[pure virtual]`

Draws a view in a canvas. Draws in the canvas the view themes that are visible with the given transformation in the given buffer.

Parameters:

	view	The view to draw.
	canvas	The canvas.
	buffer	The canvas buffer where to draw.
	angle	The angle to draw a rotated image.
	matrix	The transformation matrix that will be applied to the drawing.
	refreshTheme	Whether the canvas should be refreshed after each theme is drawn.

Implemented in TdkDefaultGraphicalService.

virtual void TdkAbstractGraphicalService::drawView	(	TeView &	view,
		TdkImageRGB &	image,
		TeBox &	world,
		TeColor &	backgroundColor
	)			`[pure virtual]`

Draws a view in a RGB image. Creates a canvas with the given rgb image and configures this canvas with the view projection, the back color and the world area. Finally it draws in the canvas the view themes that are visible, filling the rgb buffers.

Parameters:

	view	View to draw.
	image	The image to draw to.
	world	The area to draw in world coordinates.
	backgroundColor	The back color of the output image.

Implemented in TdkDefaultGraphicalService.

virtual void TdkAbstractGraphicalService::drawViewTree	(	TeViewTree *	viewTree,
		TdkCanvas *	canvas,
		int	buffer = `TdkCanvas::cbrBack`,
		double	angle = `0.`,
		TdkMathMatrix *	matrix = `NULL`,
		bool	refreshTheme = `true`
	)			`[pure virtual]`

TODO: This method shall become protected soon. Draws a viewTree in a canvas. Draws in the canvas the view themes that are visible with the given transformation in the given buffer.

Parameters:

	viewTree	viewTree to draw.
	canvas	The canvas.
	buffer	The canvas buffer where to draw.
	angle	The angle to draw a rotated image.
	matrix	The transformation matrix that will be applied to the drawing.
	refreshTheme	Whether the canvas should be refreshed after each theme is drawn.

Implemented in TdkDefaultGraphicalService.

virtual void TdkAbstractGraphicalService::drawTheme	(	TdkTheme &	theme,
		TdkCanvas &	canvas,
		TeProjection &	projection,
		double	angle = `0.`,
		TdkMathMatrix *	matrix = `NULL`
	)			`[pure virtual]`

Draws the theme in a canvas.

Parameters:

	theme	Theme to draw.
	canvas	The canvas.
	projection	The view projection.
	angle	The angle to draw a rotated image.
	matrix	The transformation matrix that will be applied to the drawing.

Implemented in TdkDefaultGraphicalService.

virtual void TdkAbstractGraphicalService::drawTheme	(	TdkTheme &	theme,
		TdkImageRGB &	image,
		TeProjection &	projection,
		TeBox &	world,
		TeColor &	backgroundColor
	)			`[pure virtual]`

Draws a theme in a RGB image. Creates a canvas with the given rgb image and configures this canvas with the given projection, the back color and the world area. Finally it draws in the canvas the theme, filling the image.

Parameters:

	theme	Theme to draw.
	image	The image to draw to.
	projection	The view projection.
	world	The area to draw in world coordinates.
	backgroundColor	The back color of the output image.

Implemented in TdkDefaultGraphicalService.

virtual void TdkAbstractGraphicalService::drawThemeObjects	(	TdkThemeObjects &	tobjs,
		int	color_red,
		int	color_green,
		int	color_blue,
		double	world_x1,
		double	world_y1,
		double	world_x2,
		double	world_y2,
		TeProjection &	projection,
		int	image_width,
		int	image_height,
		int	backcolor_red,
		int	backcolor_green,
		int	backcolor_blue,
		unsigned char *	red,
		unsigned char *	green,
		unsigned char *	blue
	)			`[pure virtual]`

Draws the theme objects in RGB buffers. Creates a canvas with the given rgb buffers and configures this canvas with the projection, the back color and the world area. Finally it draws in the canvas the theme objects, filling the rgb buffers.

Parameters:

	tobjs	The theme objects to draw
	color_red,color_green,color_blue	The color to draw the theme objects.
	world_x1,world_y1,world_x2,world_y2	The area to draw in world coordinates.
	projection	The view projection.
	image_width,image_height	The width and height of the output image.
	backcolor_red,backcolor_green,backcolor_blue	The back color of the output image.
	red,green,blue	The output RGB buffers.

Implemented in TdkDefaultGraphicalService.

virtual TeDecoderMemory* TdkAbstractGraphicalService::TdkGetLayerRaster	(	TdkLayer *	layer,
		const TeBox &	box,
		double	scale
	)			`[pure virtual]`

Implemented in TdkDefaultGraphicalService.

virtual long int* TdkAbstractGraphicalService::createCanvasPalette ( TeRasterParams & par ) [pure virtual]

Returns a palette at the TdkCanvas format for a raster with the given raster parameters.

Implemented in TdkDefaultGraphicalService.

virtual TdkImageRepType TdkAbstractGraphicalService::getRasterColorModel ( TeRasterParams & par ) [pure virtual]

Implemented in TdkDefaultGraphicalService.

virtual void TdkAbstractGraphicalService::drawRasterFile	(	TeRaster *	raster,
		TdkCanvas *	canvas,
		double	angle,
		TdkMathMatrix *	matrix,
		bool	useMask,
		unsigned char	maskRed,
		unsigned char	maskGreen,
		unsigned char	maskBlue
	)			`[pure virtual]`

Implemented in TdkDefaultGraphicalService.

virtual TdkImageFormatted* TdkAbstractGraphicalService::createImage	(	TdkCanvas *	canvas,
		TdkImageFormat	format
	)			`[pure virtual]`

Implemented in TdkDefaultGraphicalService.

virtual void TdkAbstractGraphicalService::wc2pixel	(	double &	pX,
		double &	pY,
		double	wcX,
		double	wcY,
		int	width,
		int	height,
		double	wcXmin,
		double	wcYmin,
		double	wcXmax,
		double	wcYmax
	)			`[pure virtual]`

Transform the point coordinates from world coordinates to pixel. Given a world canvas point coordinate, the function returns the same point in pixel coordinate.

Parameters:

	Reference	to X pixel coordinate.
	Reference	to Y pixel coordinate.
	Value	of X world coordinate.
	Value	of Y world coordinate.
	Value	of width.
	Value	of height.
	Value	of x min world coordinate bounding box.
	Value	of y min world coordinate bounding box.
	Value	of x max world coordinate bounding box.
	Value	of y max world coordinate bounding box.

Implemented in TdkDefaultGraphicalService.

virtual void TdkAbstractGraphicalService::pixel2wc	(	double &	wcX,
		double &	wcY,
		double	pX,
		double	pY,
		int	width,
		int	height,
		double	wcXmin,
		double	wcYmin,
		double	wcXmax,
		double	wcYmax
	)			`[pure virtual]`

Transform the point coordinates from pixel to world coordinates. Given a pixel point coordinate, the function returns the same point in world canvas coordinate.

Parameters:

	Reference	to X world coordinate.
	Reference	to Y world coordinate.
	Value	of X pixel coordinate.
	Value	of Y pixel coordinate.
	Value	of width.
	Value	of height.
	Value	of x min world coordinate bounding box.
	Value	of y min world coordinate bounding box.
	Value	of x max world coordinate bounding box.
	Value	of y max world coordinate bounding box.

Implemented in TdkDefaultGraphicalService.

virtual void TdkAbstractGraphicalService::pickBox	(	double	pixelX,
		double	pixelY,
		int	width,
		int	height,
		double	wcXmin,
		double	wcYmin,
		double	wcXmax,
		double	wcYmax,
		double &	xmin,
		double &	ymin,
		double &	xmax,
		double &	ymax,
		int	tollerance = `2`
	)			`[pure virtual]`

Implemented in TdkDefaultGraphicalService.

virtual double TdkAbstractGraphicalService::getPixelSize	(	TdkCanvas *	canvas,
		double	scale
	)			`[pure virtual]`

TODO: Complete method documentation Returns the pixel size for a given scale in the projection units (using as error level in multiresolution)

Implemented in TdkDefaultGraphicalService.

virtual double TdkAbstractGraphicalService::getScale	(	TdkCanvas *	canvas,
		double	pixelSize
	)			`[pure virtual]`

TODO: Complete mehtod documentation Returns the canvas scale to a given pixel size

Implemented in TdkDefaultGraphicalService.

virtual void TdkAbstractGraphicalService::drawPoint	(	TdkPointStyle &	style,
		TdkCanvas &	canvas,
		TePoint &	point,
		TeColor &	externColor,
		double	externSizeFactor
	)			`[pure virtual]`

TODO: Complete mehtod documentation.

Implemented in TdkDefaultGraphicalService.

virtual void TdkAbstractGraphicalService::drawPointSample	(	TdkPointStyle &	style,
		TdkCanvas &	canvas,
		int	x,
		int	y,
		TeColor &	externColor
	)			`[pure virtual]`