Main MRPT website > C++ reference for MRPT 1.5.6
List of all members | Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | Private Attributes
mrpt::utils::CEnhancedMetaFile Class Reference

Detailed Description

This class represents a Windows Enhanced Meta File (EMF) for generating and saving graphics.

If used under Linux, a ".png", non-vectorial, file will be generated instead.

Definition at line 24 of file CEnhancedMetaFile.h.

#include <mrpt/utils/CEnhancedMetaFile.h>

Inheritance diagram for mrpt::utils::CEnhancedMetaFile:
Inheritance graph

Public Types

enum  TPenStyle {
  psSolid = 0, psDash, psDot, psDashDot,
  psDashDotDot
}
 Definition of pen styles. More...
 

Public Member Functions

 CEnhancedMetaFile (const std::string &targetFileName, int scaleFactor=1)
 Constructor. More...
 
virtual ~CEnhancedMetaFile ()
 Destructor. More...
 
void setPixel (int x, int y, size_t color) MRPT_OVERRIDE
 Changes the value of the pixel (x,y). More...
 
size_t getWidth () const MRPT_OVERRIDE
 Returns the width of the image in pixels (this currently has no applicability for a EMF file...) More...
 
size_t getHeight () const MRPT_OVERRIDE
 Returns the height of the image in pixels (this currently has no applicability for a EMF file...) More...
 
void drawImage (int x, int y, const utils::CImage &img) MRPT_OVERRIDE
 Draws an image as a bitmap at a given position. More...
 
void line (int x0, int y0, int x1, int y1, const mrpt::utils::TColor color, unsigned int width=1, TPenStyle penStyle=psSolid) MRPT_OVERRIDE
 Draws a line. More...
 
void textOut (int x0, int y0, const std::string &str, const mrpt::utils::TColor color) MRPT_OVERRIDE
 Places a text label. More...
 
virtual void selectVectorTextFont (const std::string &fontName, int fontSize, bool bold=false, bool italic=false)
 Select the current font used when drawing text. More...
 
void drawImage (int x, int y, const utils::CImage &img, float rotation, float scale) MRPT_OVERRIDE
 Draws an image as a bitmap at a given position, with some custom scale and rotation changes. More...
 
virtual void rectangle (int x0, int y0, int x1, int y1, const mrpt::utils::TColor color, unsigned int width=1)
 Draws a rectangle (an empty rectangle, without filling) More...
 
template<class T >
void ellipseGaussian (math::CMatrixTemplateNumeric< T > *cov2D, T mean_x, T mean_y, float confIntervalStds=2, const mrpt::utils::TColor &color=mrpt::utils::TColor(255, 255, 255), unsigned int width=1, int nEllipsePoints=20)
 Draws an ellipse representing a given confidence interval of a 2D Gaussian distribution. More...
 
void triangle (int x0, int y0, int size, const mrpt::utils::TColor color, bool inferior=true, unsigned int width=1)
 Draws a triangle. More...
 
virtual void filledRectangle (int x0, int y0, int x1, int y1, const mrpt::utils::TColor color)
 Draws a filled rectangle. More...
 
virtual void selectTextFont (const std::string &fontName)
 Select the current font used when drawing text. More...
 
void cross (int x0, int y0, const mrpt::utils::TColor color, char type, unsigned int size=5, unsigned int width=1)
 Draw a cross. More...
 
virtual void drawCircle (int x, int y, int radius, const mrpt::utils::TColor &color=mrpt::utils::TColor(255, 255, 255), unsigned int width=1)
 Draws a circle of a given radius. More...
 
template<class MATRIX2X2 >
void ellipseGaussian (const MATRIX2X2 *cov2D, const double mean_x, const double mean_y, double confIntervalStds=2, const mrpt::utils::TColor &color=mrpt::utils::TColor(255, 255, 255), unsigned int width=1, int nEllipsePoints=20)
 Draws an ellipse representing a given confidence interval of a 2D Gaussian distribution. More...
 
template<class FEATURELIST >
void drawFeaturesSimple (const FEATURELIST &list, const TColor &color=TColor::red, const int cross_size=5)
 Draws a set of marks onto the image, given a generic container of entities having just "x" and "y" fields. More...
 
template<class FEATURELIST >
void drawFeatures (const FEATURELIST &list, const TColor &color=TColor::red, const bool showIDs=false, const bool showResponse=false)
 Draws a set of marks (or scaled circles for features with scale) onto the image, given a generic container of features. More...
 

Static Public Attributes

static int LINUX_IMG_WIDTH
 In Linux, the size of the bitmap image that emulates the EMF (Default:800) More...
 
static int LINUX_IMG_HEIGHT
 In Linux, the size of the bitmap image that emulates the EMF (Default:600) More...
 

Protected Attributes

std::string m_selectedFont
 The selected font name. More...
 
const uint32_tm_selectedFontBitmaps
 Direct access to character bitmaps. More...
 

Private Attributes

void_ptr_noncopy m_hdc
 
int m_scale
 
void_ptr_noncopy m_hFont
 
std::string m_targetFile
 

Member Enumeration Documentation

Definition of pen styles.

Enumerator
psSolid 
psDash 
psDot 
psDashDot 
psDashDotDot 

Definition at line 53 of file CCanvas.h.

Constructor & Destructor Documentation

mrpt::utils::CEnhancedMetaFile::CEnhancedMetaFile ( const std::string targetFileName,
int  scaleFactor = 1 
)

Constructor.

Parameters
targetFileNameThis file will be created and the EMF saved there.
scaleFactorAll coordinates in draw commands will be internally multiplied by this scale, to provide a way of obtaining "subpixel" drawing.
virtual mrpt::utils::CEnhancedMetaFile::~CEnhancedMetaFile ( )
virtual

Destructor.

Member Function Documentation

void CCanvas::cross ( int  x0,
int  y0,
const mrpt::utils::TColor  color,
char  type,
unsigned int  size = 5,
unsigned int  width = 1 
)
inherited

Draw a cross.

Parameters
x0The point x coordinate
y0The point y coordinate
colorThe color of the cross
sizeThe size of the cross
typeThe cross type. It could be: 'x', '+' or ':'(like '+' but clear at the center dot)
widthThe desired width of the cross (this is IGNORED yet)

Definition at line 329 of file CCanvas.cpp.

References mrpt::utils::CCanvas::line(), and THROW_EXCEPTION.

Referenced by find_chessboard_corners_multiple(), and mrpt::gui::CDisplayWindow::plot().

void CCanvas::drawCircle ( int  x,
int  y,
int  radius,
const mrpt::utils::TColor color = mrpt::utils::TColor(255,255,255),
unsigned int  width = 1 
)
virtualinherited

Draws a circle of a given radius.

Parameters
xThe center - x coordinate in pixels.
yThe center - y coordinate in pixels.
radiusThe radius - in pixels.
colorThe color of the circle.
widthThe desired width of the line (this is IGNORED in this virtual class)

Reimplemented in mrpt::utils::CImage.

Definition at line 355 of file CCanvas.cpp.

References int(), mrpt::utils::CCanvas::line(), M_2PI, and mrpt::utils::round().

template<class FEATURELIST >
void mrpt::utils::CCanvas::drawFeatures ( const FEATURELIST &  list,
const TColor color = TColor::red,
const bool  showIDs = false,
const bool  showResponse = false 
)
inlineinherited

Draws a set of marks (or scaled circles for features with scale) onto the image, given a generic container of features.

The class of FEATURELIST can be:

See Also
drawFeaturesSimple

Definition at line 322 of file CCanvas.h.

References cross(), mrpt::format(), mrpt::utils::TColor::red, and mrpt::utils::round().

template<class FEATURELIST >
void mrpt::utils::CCanvas::drawFeaturesSimple ( const FEATURELIST &  list,
const TColor color = TColor::red,
const int  cross_size = 5 
)
inlineinherited

Draws a set of marks onto the image, given a generic container of entities having just "x" and "y" fields.

The class of FEATURELIST can be, for example, std::vector<mrpt::math::TPoint2D>, std::vector<TPixelCoordsf> or mrpt::vision::CFeatureList

See Also
drawFeatures

Definition at line 304 of file CCanvas.h.

References cross(), and mrpt::utils::round().

void mrpt::utils::CEnhancedMetaFile::drawImage ( int  x,
int  y,
const utils::CImage img 
)
virtual

Draws an image as a bitmap at a given position.

Parameters
x0The top-left corner x coordinates on this canvas where the image is to be drawn
y0The top-left corner y coordinates on this canvas where the image is to be drawn
imgThe image to be drawn in this canvas This method may be redefined in some classes implementing this interface in a more appropiate manner.

Reimplemented from mrpt::utils::CCanvas.

Referenced by mrpt::slam::CMetricMapBuilderICP::saveCurrentEstimationToImage().

void mrpt::utils::CEnhancedMetaFile::drawImage ( int  x,
int  y,
const utils::CImage img,
float  rotation,
float  scale 
)
inlinevirtual

Draws an image as a bitmap at a given position, with some custom scale and rotation changes.

Parameters
x0The top-left corner x coordinates on this canvas where the image is to be drawn
y0The top-left corner y coordinates on this canvas where the image is to be drawn
rotationThe rotation in radians, positive values being anti-clockwise direction, 0 is the normal position.
scaleThe scale factor, e.g. 2 means twice the original size.
imgThe image to be drawn in this canvas This method may be redefined in some classes implementing this interface in a more appropiate manner.

Reimplemented from mrpt::utils::CCanvas.

Definition at line 123 of file CEnhancedMetaFile.h.

References mrpt::utils::CCanvas::drawImage().

template<class T >
void mrpt::utils::CEnhancedMetaFile::ellipseGaussian ( math::CMatrixTemplateNumeric< T > *  cov2D,
mean_x,
mean_y,
float  confIntervalStds = 2,
const mrpt::utils::TColor color = mrpt::utils::TColor(255,255,255),
unsigned int  width = 1,
int  nEllipsePoints = 20 
)
inline

Draws an ellipse representing a given confidence interval of a 2D Gaussian distribution.

Parameters
mean_xThe x coordinate of the center point of the ellipse.
mean_yThe y coordinate of the center point of the ellipse.
cov2DA 2x2 covariance matrix.
confIntervalStdsHow many "sigmas" for the confidence level (i.e. 2->95%, 3=99.97%,...)
colorThe color of the ellipse
widthThe desired width of the line (this is IGNORED in this virtual class)
nEllipsePointsThe number of points to generate to approximate the ellipse shape.
Exceptions
std::exceptionOn an invalid matrix.

Definition at line 160 of file CEnhancedMetaFile.h.

References M_2PI, MRPT_END_WITH_CLEAN_UP, MRPT_START, and mrpt::utils::round().

template<class MATRIX2X2 >
void mrpt::utils::CCanvas::ellipseGaussian ( const MATRIX2X2 *  cov2D,
const double  mean_x,
const double  mean_y,
double  confIntervalStds = 2,
const mrpt::utils::TColor color = mrpt::utils::TColor(255,255,255),
unsigned int  width = 1,
int  nEllipsePoints = 20 
)
inlineinherited

Draws an ellipse representing a given confidence interval of a 2D Gaussian distribution.

Parameters
mean_xThe x coordinate of the center point of the ellipse.
mean_yThe y coordinate of the center point of the ellipse.
cov2DA 2x2 covariance matrix.
confIntervalStdsHow many "sigmas" for the confidence level (i.e. 2->95%, 3=99.97%,...)
colorThe color of the ellipse
widthThe desired width of the line (this is IGNORED in this virtual class)
nEllipsePointsThe number of points to generate to approximate the ellipse shape.
Exceptions
std::exceptionOn an invalid matrix.

Definition at line 255 of file CCanvas.h.

References M_2PI, MRPT_END_WITH_CLEAN_UP, MRPT_START, and mrpt::utils::round().

void CCanvas::filledRectangle ( int  x0,
int  y0,
int  x1,
int  y1,
const mrpt::utils::TColor  color 
)
virtualinherited

Draws a filled rectangle.

Parameters
x0The top-left x coordinate
y0The top-left y coordinate
x1The right-bottom x coordinate
y1The right-bottom y coordinate
colorThe color of the rectangle fill This method may be redefined in some classes implementing this interface in a more appropiate manner.
See Also
rectangle

Definition at line 229 of file CCanvas.cpp.

References mrpt::utils::CCanvas::getHeight(), mrpt::utils::CCanvas::getWidth(), min, and mrpt::utils::CCanvas::setPixel().

Referenced by mrpt::slam::CGridMapAligner::AlignPDF_robustMatch(), mrpt::gui::CDisplayWindow::plot(), and mrpt::maps::COccupancyGridMap2D::saveAsBitmapTwoMapsWithCorrespondences().

size_t mrpt::utils::CEnhancedMetaFile::getHeight ( ) const
inlinevirtual

Returns the height of the image in pixels (this currently has no applicability for a EMF file...)

Implements mrpt::utils::CCanvas.

Definition at line 61 of file CEnhancedMetaFile.h.

size_t mrpt::utils::CEnhancedMetaFile::getWidth ( ) const
inlinevirtual

Returns the width of the image in pixels (this currently has no applicability for a EMF file...)

Implements mrpt::utils::CCanvas.

Definition at line 58 of file CEnhancedMetaFile.h.

void mrpt::utils::CEnhancedMetaFile::line ( int  x0,
int  y0,
int  x1,
int  y1,
const mrpt::utils::TColor  color,
unsigned int  width = 1,
TPenStyle  penStyle = psSolid 
)
virtual

Draws a line.

Parameters
x0The starting point x coordinate
y0The starting point y coordinate
x1The end point x coordinate
y1The end point y coordinate
colorThe color of the line
widthThe desired width of the line (this is IGNORED in this virtual class) This method may be redefined in some classes implementing this interface in a more appropiate manner.

Reimplemented from mrpt::utils::CCanvas.

Referenced by mrpt::slam::CMetricMapBuilderICP::saveCurrentEstimationToImage().

virtual void mrpt::utils::CEnhancedMetaFile::rectangle ( int  x0,
int  y0,
int  x1,
int  y1,
const mrpt::utils::TColor  color,
unsigned int  width = 1 
)
virtual

Draws a rectangle (an empty rectangle, without filling)

Parameters
x0The top-left x coordinate
y0The top-left y coordinate
x1The right-bottom x coordinate
y1The right-bottom y coordinate
colorThe color of the line
widthThe desired width of the line.
See Also
filledRectangle
void CCanvas::selectTextFont ( const std::string fontName)
virtualinherited

Select the current font used when drawing text.

Parameters
fontNameThe name of the font

Valid font names:

  • 5x7
  • 6x13
  • 6x13B
  • 6x13O
  • 9x15 (Default at start-up)
  • 9x15B
  • 10x20
  • 18x18ja (Asian characters for UTF-8 strings - Only available if MRPT is built with MRPT_HAS_ASIAN_FONTS = true)

See Also
textOut, The example in this page.

Definition at line 249 of file CCanvas.cpp.

References init_fonts_list(), list_registered_fonts, mrpt::utils::CCanvas::m_selectedFont, and mrpt::utils::CCanvas::m_selectedFontBitmaps.

Referenced by mrpt::utils::CImage::drawChessboardCorners(), and mrpt::utils::CCanvas::textOut().

virtual void mrpt::utils::CEnhancedMetaFile::selectVectorTextFont ( const std::string fontName,
int  fontSize,
bool  bold = false,
bool  italic = false 
)
virtual

Select the current font used when drawing text.

Parameters
fontNameThe face name of a font (e.g. "Arial","System",...)
fontSizeThe size of the font in pts.
boldWhether the font is bold
italicWhether the font is italic
See Also
textOut, CCanvas::selectTextFont
void mrpt::utils::CEnhancedMetaFile::setPixel ( int  x,
int  y,
size_t  color 
)
virtual

Changes the value of the pixel (x,y).

Pixel coordinates starts at the left-top corner of the image, and start in (0,0). The meaning of the parameter "color" depends on the implementation: it will usually be a 24bit RGB value (0x00RRGGBB), but it can also be just a 8bit gray level. This method must support (x,y) values OUT of the actual image size without neither raising exceptions, nor leading to memory access errors.

Implements mrpt::utils::CCanvas.

void mrpt::utils::CEnhancedMetaFile::textOut ( int  x0,
int  y0,
const std::string str,
const mrpt::utils::TColor  color 
)
virtual

Places a text label.

Parameters
x0The x coordinates
y0The y coordinates
strThe string to put
colorThe text color
fontSizeThe font size, in "points" This method may be redefined in some classes implementing this interface in a more appropiate manner.
See Also
rectangle

Reimplemented from mrpt::utils::CCanvas.

void CCanvas::triangle ( int  x0,
int  y0,
int  size,
const mrpt::utils::TColor  color,
bool  inferior = true,
unsigned int  width = 1 
)
inherited

Draws a triangle.

Parameters
x0The triangle center x coordinate
y0The triangle center y coordinate
sizeThe size of the triangle
colorThe color of the line
inferiorThe position of the triangle
widthThe desired width of the line.
See Also
triangle

Definition at line 200 of file CCanvas.cpp.

References mrpt::utils::CCanvas::line(), and mrpt::utils::round().

Member Data Documentation

int mrpt::utils::CEnhancedMetaFile::LINUX_IMG_HEIGHT
static

In Linux, the size of the bitmap image that emulates the EMF (Default:600)

Definition at line 34 of file CEnhancedMetaFile.h.

int mrpt::utils::CEnhancedMetaFile::LINUX_IMG_WIDTH
static

In Linux, the size of the bitmap image that emulates the EMF (Default:800)

Definition at line 33 of file CEnhancedMetaFile.h.

void_ptr_noncopy mrpt::utils::CEnhancedMetaFile::m_hdc
private

Definition at line 27 of file CEnhancedMetaFile.h.

void_ptr_noncopy mrpt::utils::CEnhancedMetaFile::m_hFont
private

Definition at line 29 of file CEnhancedMetaFile.h.

int mrpt::utils::CEnhancedMetaFile::m_scale
private

Definition at line 28 of file CEnhancedMetaFile.h.

std::string mrpt::utils::CCanvas::m_selectedFont
protectedinherited

The selected font name.

Definition at line 43 of file CCanvas.h.

Referenced by mrpt::utils::CCanvas::selectTextFont().

const uint32_t* mrpt::utils::CCanvas::m_selectedFontBitmaps
protectedinherited

Direct access to character bitmaps.

Definition at line 45 of file CCanvas.h.

Referenced by mrpt::utils::CCanvas::selectTextFont(), and mrpt::utils::CCanvas::textOut().

std::string mrpt::utils::CEnhancedMetaFile::m_targetFile
private

Definition at line 30 of file CEnhancedMetaFile.h.




Page generated by Doxygen 1.8.6 for MRPT 1.5.6 Git: 4c65e84 Tue Apr 24 08:18:17 2018 +0200 at mar abr 24 08:26:17 CEST 2018