Detailed Description

This virtual class represents objects that can be moved to an arbitrary 2D location+rotation.

The current transformation is set through SetCoordinateBase. To ease the implementation of descendent classes, mpMovableObject will be in charge of Bounding Box computation and layer render, assuming that the object updates its shape in m_shape_xs & m_shape_ys.

#include <mrpt/otherlibs/mathplot/mathplot.h>

Inheritance diagram for mpBitmapLayer:

[legend]

List of all members.

Public Member Functions
	mpBitmapLayer ()
	Default constructor.
virtual	~mpBitmapLayer ()
void	GetBitmapCopy (wxImage &outBmp) const
	Returns a copy of the current bitmap assigned to the layer.
void	SetBitmap (const wxImage &inBmp, double x, double y, double lx, double ly)
	Change the bitmap associated with the layer (to update the screen, refresh the mpWindow).
virtual bool	HasBBox ()
	Check whether this layer has a bounding box.
virtual double	GetMinX ()
	Get inclusive left border of bounding box.
virtual double	GetMaxX ()
	Get inclusive right border of bounding box.
virtual double	GetMinY ()
	Get inclusive bottom border of bounding box.
virtual double	GetMaxY ()
	Get inclusive top border of bounding box.
virtual void	Plot (wxDC &dc, mpWindow &w)
	Plot given view of layer to the given device context.
void	SetAlign (int align)
	Set label axis alignment.
virtual bool	IsInfo ()
	Check whether the layer is an info box.
wxString	GetName () const
	Get layer name.
const wxFont &	GetFont () const
	Get font set for this layer.
const wxPen &	GetPen () const
	Get pen set for this layer.
void	SetContinuity (bool continuity)
	Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).
bool	GetContinuity () const
	Gets the 'continuity' property of the layer.
void	ShowName (bool show)
	Shows or hides the text label with the name of the layer (default is visible).
void	SetName (wxString name)
	Set layer name.
void	SetFont (wxFont &font)
	Set layer font.
void	SetPen (wxPen pen)
	Set layer pen.
void	SetDrawOutsideMargins (bool drawModeOutside)
	Set Draw mode: inside or outside margins.
bool	GetDrawOutsideMargins ()
	Get Draw mode: inside or outside margins.
wxBitmap	GetColourSquare (int side=16)
	Get a small square bitmap filled with the colour of the pen used in the layer.
mpLayerType	GetLayerType ()
	Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value.
bool	IsVisible ()
	Checks whether the layer is visible or not.
void	SetVisible (bool show)
	Sets layer visibility.
const wxBrush &	GetBrush () const
	Get brush set for this layer.
void	SetBrush (wxBrush brush)
	Set layer brush.
Protected Attributes
int	m_flags
	Holds label alignment.
wxImage	m_bitmap
	The internal copy of the Bitmap:
wxBitmap	m_scaledBitmap
wxCoord	m_scaledBitmap_offset_x
wxCoord	m_scaledBitmap_offset_y
bool	m_validImg
double	m_min_x
	The shape of the bitmap:
double	m_max_x
double	m_min_y
double	m_max_y
wxFont	m_font
	Layer's font.
wxPen	m_pen
	Layer's pen.
wxBrush	m_brush
	Layer's brush.
wxString	m_name
	Layer's name.
bool	m_continuous
	Specify if the layer will be plotted as a continuous line or a set of points.
bool	m_showName
	States whether the name of the layer must be shown (default is true).
bool	m_drawOutsideMargins
	select if the layer should draw only inside margins or over all DC
mpLayerType	m_type
	Define layer type, which is assigned by constructor.
bool	m_visible
	Toggles layer visibility.

Constructor & Destructor Documentation

mpBitmapLayer::mpBitmapLayer ( ) [inline]

Default constructor.

Definition at line 1673 of file mathplot.h.

References mpLAYER_BITMAP.

virtual mpBitmapLayer::~mpBitmapLayer ( ) [inline, virtual]

Definition at line 1681 of file mathplot.h.

Member Function Documentation

void mpBitmapLayer::GetBitmapCopy ( wxImage & outBmp ) const

Returns a copy of the current bitmap assigned to the layer.

const wxBrush& mpLayer::GetBrush ( ) const [inline, inherited]

Get brush set for this layer.

Returns:: brush.

Definition at line 314 of file mathplot.h.

wxBitmap mpLayer::GetColourSquare ( int side = 16 ) [inherited]

Get a small square bitmap filled with the colour of the pen used in the layer.

Useful to create legends or similar reference to the layers.

Parameters:

side	side length in pixels

Returns:: a wxBitmap filled with layer's colour

bool mpLayer::GetContinuity ( ) const [inline, inherited]

Gets the 'continuity' property of the layer.

See also:: SetContinuity

Definition at line 266 of file mathplot.h.

bool mpLayer::GetDrawOutsideMargins ( ) [inline, inherited]

Get Draw mode: inside or outside margins.

Returns:: The draw mode

Definition at line 293 of file mathplot.h.

const wxFont& mpLayer::GetFont ( ) const [inline, inherited]

Get font set for this layer.

Returns:: Font

Definition at line 251 of file mathplot.h.

mpLayerType mpLayer::GetLayerType ( ) [inline, inherited]

Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value.

Returns:: An integer indicating layer type

Definition at line 302 of file mathplot.h.

virtual double mpBitmapLayer::GetMaxX ( ) [inline, virtual]

Get inclusive right border of bounding box.

Reimplemented from mpLayer.

Definition at line 1704 of file mathplot.h.

virtual double mpBitmapLayer::GetMaxY ( ) [inline, virtual]

Get inclusive top border of bounding box.

Reimplemented from mpLayer.

Definition at line 1712 of file mathplot.h.

virtual double mpBitmapLayer::GetMinX ( ) [inline, virtual]

Get inclusive left border of bounding box.

Reimplemented from mpLayer.

Definition at line 1700 of file mathplot.h.

virtual double mpBitmapLayer::GetMinY ( ) [inline, virtual]

Get inclusive bottom border of bounding box.

Reimplemented from mpLayer.

Definition at line 1708 of file mathplot.h.

wxString mpLayer::GetName ( ) const [inline, inherited]

Get layer name.

Returns:: Name

Definition at line 246 of file mathplot.h.

const wxPen& mpLayer::GetPen ( ) const [inline, inherited]

Get pen set for this layer.

Returns:: Pen

Definition at line 256 of file mathplot.h.

virtual bool mpBitmapLayer::HasBBox ( ) [inline, virtual]

Check whether this layer has a bounding box.

The default implementation returns TRUE. Override and return FALSE if your mpLayer implementation should be ignored by the calculation of the global bounding box for all layers in a mpWindow.

Return values:

TRUE	Has bounding box
FALSE	Has not bounding box

Reimplemented from mpLayer.

Definition at line 1696 of file mathplot.h.

virtual bool mpLayer::IsInfo ( ) [inline, virtual, inherited]

Check whether the layer is an info box.

The default implementation returns FALSE. It is overrided to TRUE for mpInfoLayer class and its derivative. It is necessary to define mouse actions behaviour over info boxes.

Returns:: whether the layer is an info boxes

See also:: mpInfoLayer::IsInfo

Reimplemented in mpInfoLayer.

Definition at line 178 of file mathplot.h.

bool mpLayer::IsVisible ( ) [inline, inherited]

Checks whether the layer is visible or not.

Returns:: true if visible

Definition at line 306 of file mathplot.h.

virtual void mpBitmapLayer::Plot	(	wxDC &	dc,
		mpWindow &	w
	)		`[virtual]`

Plot given view of layer to the given device context.

An implementation of this function has to transform layer coordinates to wxDC coordinates based on the view parameters retrievable from the mpWindow passed in w. Note that the public methods of mpWindow: x2p,y2p and p2x,p2y are already provided which transform layer coordinates to DC pixel coordinates, and user code should rely on them for portability and future changes to be applied transparently, instead of implementing the following formulas manually.

The passed device context dc has its coordinate origin set to the top-left corner of the visible area (the default). The coordinate orientation is as shown in the following picture:

        (wxDC origin 0,0)
               x-------------> ascending X ----------------+
               |                                           |
               |                                           |
               V ascending Y                               |
	           |                                           |
	           |                                           |
	           |                                           |
	           +-------------------------------------------+  <-- right-bottom corner of the mpWindow visible area.

Note that Y ascends in downward direction, whereas the usual vertical orientation for mathematical plots is vice versa. Thus Y-orientation will be swapped usually, when transforming between wxDC and mpLayer coordinates. This change of coordinates is taken into account in the methods p2x,p2y,x2p,y2p.

Rules for transformation between mpLayer and wxDC coordinates

        dc_X = (layer_X - mpWindow::GetPosX()) * mpWindow::GetScaleX()
        dc_Y = (mpWindow::GetPosY() - layer_Y) * mpWindow::GetScaleY() // swapping Y-orientation

        layer_X = (dc_X / mpWindow::GetScaleX()) + mpWindow::GetPosX() // scale guaranteed to be not 0
        layer_Y = mpWindow::GetPosY() - (dc_Y / mpWindow::GetScaleY()) // swapping Y-orientation

Parameters:

dc	Device context to plot to.
w	View to plot. The visible area can be retrieved from this object.

See also:: mpWindow::p2x,mpWindow::p2y,mpWindow::x2p,mpWindow::y2p

Implements mpLayer.

void mpBitmapLayer::SetAlign ( int align ) [inline]

Set label axis alignment.

Parameters:

align alignment (choose between mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGN_SE

Definition at line 1719 of file mathplot.h.

void mpBitmapLayer::SetBitmap	(	const wxImage &	inBmp,
		double	x,
		double	y,
		double	lx,
		double	ly
	)

Change the bitmap associated with the layer (to update the screen, refresh the mpWindow).

Parameters:

inBmp	The bitmap to associate. A copy is made, thus it can be released after calling this.
x	The left corner X coordinate (in plot units).
y	The top corner Y coordinate (in plot units).
lx	The width in plot units.
ly	The height in plot units.

void mpLayer::SetBrush ( wxBrush brush ) [inline, inherited]

Set layer brush.

Parameters:

brush brush, will be copied to internal class member

Definition at line 318 of file mathplot.h.

void mpLayer::SetContinuity ( bool continuity ) [inline, inherited]

Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).

See also:: GetContinuity

Definition at line 261 of file mathplot.h.

void mpLayer::SetDrawOutsideMargins ( bool drawModeOutside ) [inline, inherited]

Set Draw mode: inside or outside margins.

Default is outside, which allows the layer to draw up to the mpWindow border.

Parameters:

drawModeOutside The draw mode to be set

Definition at line 289 of file mathplot.h.

void mpLayer::SetFont ( wxFont & font ) [inline, inherited]

Set layer font.

Parameters:

font	Font, will be copied to internal class member

Definition at line 280 of file mathplot.h.

void mpLayer::SetName ( wxString name ) [inline, inherited]

Set layer name.

Parameters:

name	Name, will be copied to internal class member

Definition at line 275 of file mathplot.h.

void mpLayer::SetPen ( wxPen pen ) [inline, inherited]

Set layer pen.

Parameters:

pen	Pen, will be copied to internal class member

Definition at line 285 of file mathplot.h.

void mpLayer::SetVisible ( bool show ) [inline, inherited]

Sets layer visibility.

Parameters:

show	visibility bool.

Definition at line 310 of file mathplot.h.

void mpLayer::ShowName ( bool show ) [inline, inherited]

Shows or hides the text label with the name of the layer (default is visible).

Definition at line 270 of file mathplot.h.

Member Data Documentation

wxImage mpBitmapLayer::m_bitmap [protected]

The internal copy of the Bitmap:

Definition at line 1726 of file mathplot.h.

wxBrush mpLayer::m_brush [protected, inherited]

Layer's brush.

Reimplemented in mpInfoLayer.

Definition at line 323 of file mathplot.h.

bool mpLayer::m_continuous [protected, inherited]

Specify if the layer will be plotted as a continuous line or a set of points.

Definition at line 325 of file mathplot.h.

bool mpLayer::m_drawOutsideMargins [protected, inherited]

select if the layer should draw only inside margins or over all DC

Definition at line 327 of file mathplot.h.

int mpBitmapLayer::m_flags [protected]

Holds label alignment.

Definition at line 1719 of file mathplot.h.

wxFont mpLayer::m_font [protected, inherited]

Layer's font.

Definition at line 318 of file mathplot.h.

double mpBitmapLayer::m_max_x [protected]

Definition at line 1736 of file mathplot.h.

double mpBitmapLayer::m_max_y [protected]

Definition at line 1736 of file mathplot.h.

double mpBitmapLayer::m_min_x [protected]

The shape of the bitmap:

Definition at line 1736 of file mathplot.h.

double mpBitmapLayer::m_min_y [protected]

Definition at line 1736 of file mathplot.h.

wxString mpLayer::m_name [protected, inherited]

Layer's name.

Definition at line 324 of file mathplot.h.

wxPen mpLayer::m_pen [protected, inherited]

Layer's pen.

Definition at line 322 of file mathplot.h.

wxBitmap mpBitmapLayer::m_scaledBitmap [protected]

Definition at line 1727 of file mathplot.h.

wxCoord mpBitmapLayer::m_scaledBitmap_offset_x [protected]

Definition at line 1728 of file mathplot.h.

wxCoord mpBitmapLayer::m_scaledBitmap_offset_y [protected]

Definition at line 1728 of file mathplot.h.

bool mpLayer::m_showName [protected, inherited]

States whether the name of the layer must be shown (default is true).

Definition at line 326 of file mathplot.h.

mpLayerType mpLayer::m_type [protected, inherited]

Define layer type, which is assigned by constructor.

Definition at line 328 of file mathplot.h.

bool mpBitmapLayer::m_validImg [protected]

Definition at line 1731 of file mathplot.h.

bool mpLayer::m_visible [protected, inherited]

Toggles layer visibility.

Definition at line 329 of file mathplot.h.

Detailed Description

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation