mpScaleX Class Reference

Detailed Description

Plot layer implementing a x-scale ruler.

The ruler is fixed at Y=0 in the coordinate system. A label is plotted at the bottom-right hand of the ruler. The scale numbering automatically adjusts to view and zoom factor.

Definition at line 686 of file mathplot.h.

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

Inheritance diagram for mpScaleX:

Public Member Functions
	mpScaleX (wxString name=wxT("X"), int flags=mpALIGN_CENTER, bool ticks=true, unsigned int type=mpX_NORMAL)
	Full constructor.
virtual void	Plot (wxDC &dc, mpWindow &w)
	Layer plot handler.
virtual bool	HasBBox ()
	Check whether this layer has a bounding box.
void	SetAlign (int align)
	Set X axis alignment.
void	SetTicks (bool ticks)
	Set X axis ticks or grid.
bool	GetTicks ()
	Get X axis ticks or grid.
unsigned int	GetLabelMode ()
	Get X axis label view mode.
void	SetLabelMode (unsigned int mode)
	Set X axis label view mode.
void	SetLabelFormat (const wxString &format)
	Set X axis Label format (used for mpX_NORMAL draw mode).
const wxString &	SetLabelFormat ()
	Get X axis Label format (used for mpX_NORMAL draw mode).
virtual bool	IsInfo ()
	Check whether the layer is an info 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.
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
	Flag for axis alignment.
bool	m_ticks
	Flag to toggle between ticks or grid.
unsigned int	m_labelType
	Select labels mode: mpX_NORMAL for normal labels, mpX_TIME for time axis in hours, minutes, seconds.
wxString	m_labelFormat
	Format string used to print labels.
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

mpScaleX::mpScaleX	(	wxString	name = wxT("X"),
		int	flags = mpALIGN_CENTER,
		bool	ticks = true,
		unsigned int	type = mpX_NORMAL
	)

Full constructor.

Parameters

name	Label to plot by the ruler
flags	Set the position of the scale with respect to the window.
ticks	Select ticks or grid. Give TRUE (default) for drawing axis ticks, FALSE for drawing the grid.
type	mpX_NORMAL for normal labels, mpX_TIME for time axis in hours, minutes, seconds.

Member Function Documentation

const wxBrush& mpLayer::GetBrush ( ) const

inlineinherited

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

inlineinherited

Gets the 'continuity' property of the layer.

See Also

SetContinuity

Definition at line 266 of file mathplot.h.

bool mpLayer::GetDrawOutsideMargins ( )

inlineinherited

Get Draw mode: inside or outside margins.

Returns

The draw mode

Definition at line 293 of file mathplot.h.

const wxFont& mpLayer::GetFont ( ) const

inlineinherited

Get font set for this layer.

Returns

Font

Definition at line 251 of file mathplot.h.

unsigned int mpScaleX::GetLabelMode ( )

inline

Get X axis label view mode.

Returns

mpX_NORMAL for normal labels, mpX_TIME for time axis in hours, minutes, seconds.

Definition at line 719 of file mathplot.h.

mpLayerType mpLayer::GetLayerType ( )

inlineinherited

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 mpLayer::GetMaxX ( )

inlinevirtualinherited

Get inclusive right border of bounding box.

Returns

Value

Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.

Definition at line 188 of file mathplot.h.

virtual double mpLayer::GetMaxY ( )

inlinevirtualinherited

Get inclusive top border of bounding box.

Returns

Value

Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.

Definition at line 198 of file mathplot.h.

virtual double mpLayer::GetMinX ( )

inlinevirtualinherited

Get inclusive left border of bounding box.

Returns

Value

Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.

Definition at line 183 of file mathplot.h.

virtual double mpLayer::GetMinY ( )

inlinevirtualinherited

Get inclusive bottom border of bounding box.

Returns

Value

Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.

Definition at line 193 of file mathplot.h.

wxString mpLayer::GetName ( ) const

inlineinherited

Get layer name.

Returns

Name

Definition at line 246 of file mathplot.h.

const wxPen& mpLayer::GetPen ( ) const

inlineinherited

Get pen set for this layer.

Returns

Pen

Definition at line 256 of file mathplot.h.

bool mpScaleX::GetTicks ( )

inline

Get X axis ticks or grid.

Returns

TRUE if plot is drawing axis ticks, FALSE if the grid is active.

Definition at line 715 of file mathplot.h.

virtual bool mpScaleX::HasBBox ( )

inlinevirtual

Check whether this layer has a bounding box.

This implementation returns FALSE thus making the ruler invisible to the plot layer bounding box calculation by mpWindow.

Reimplemented from mpLayer.

Definition at line 703 of file mathplot.h.

virtual bool mpLayer::IsInfo ( )

inlinevirtualinherited

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

inlineinherited

Checks whether the layer is visible or not.

Returns

true if visible

Definition at line 306 of file mathplot.h.

virtual void mpScaleX::Plot ( wxDC &  dc, mpWindow &  w  )

virtual

Layer plot handler.

This implementation will plot the ruler adjusted to the visible area.

Implements mpLayer.

void mpScaleX::SetAlign ( int  align )

inline

Set X axis alignment.

Parameters

align

alignment (choose between mpALIGN_BORDER_BOTTOM, mpALIGN_BOTTOM, mpALIGN_CENTER, mpALIGN_TOP, mpALIGN_BORDER_TOP

Definition at line 707 of file mathplot.h.

void mpLayer::SetBrush ( wxBrush  brush )

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

Set layer font.

Parameters

font	Font, will be copied to internal class member

Definition at line 280 of file mathplot.h.

void mpScaleX::SetLabelFormat ( const wxString &  format )

inline

Set X axis Label format (used for mpX_NORMAL draw mode).

Parameters

format

The format string

Definition at line 727 of file mathplot.h.

References mrpt::format().

const wxString& mpScaleX::SetLabelFormat ( )

inline

Get X axis Label format (used for mpX_NORMAL draw mode).

Returns

The format string

Definition at line 731 of file mathplot.h.

void mpScaleX::SetLabelMode ( unsigned int  mode )

inline

Set X axis label view mode.

Parameters

mode	mpX_NORMAL for normal labels, mpX_TIME for time axis in hours, minutes, seconds.

Definition at line 723 of file mathplot.h.

void mpLayer::SetName ( wxString  name )

inlineinherited

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 )

inlineinherited

Set layer pen.

Parameters

pen	Pen, will be copied to internal class member

Definition at line 285 of file mathplot.h.

void mpScaleX::SetTicks ( bool  ticks )

inline

Set X axis ticks or grid.

Parameters

ticks

TRUE to plot axis ticks, FALSE to plot grid.

Definition at line 711 of file mathplot.h.

void mpLayer::SetVisible ( bool  show )

inlineinherited

Sets layer visibility.

Parameters

show	visibility bool.

Definition at line 310 of file mathplot.h.

void mpLayer::ShowName ( bool  show )

inlineinherited

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

wxBrush mpLayer::m_brush

protectedinherited

Layer's brush.

Definition at line 323 of file mathplot.h.

bool mpLayer::m_continuous

protectedinherited

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

protectedinherited

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

Definition at line 327 of file mathplot.h.

int mpScaleX::m_flags

protected

Flag for axis alignment.

Definition at line 731 of file mathplot.h.

wxFont mpLayer::m_font

protectedinherited

Layer's font.

Definition at line 318 of file mathplot.h.

wxString mpScaleX::m_labelFormat

protected

Format string used to print labels.

Definition at line 737 of file mathplot.h.

unsigned int mpScaleX::m_labelType

protected

Select labels mode: mpX_NORMAL for normal labels, mpX_TIME for time axis in hours, minutes, seconds.

Definition at line 736 of file mathplot.h.

wxString mpLayer::m_name

protectedinherited

Layer's name.

Definition at line 324 of file mathplot.h.

wxPen mpLayer::m_pen

protectedinherited

Layer's pen.

Definition at line 322 of file mathplot.h.

bool mpLayer::m_showName

protectedinherited

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

Definition at line 326 of file mathplot.h.

bool mpScaleX::m_ticks

protected

Flag to toggle between ticks or grid.

Definition at line 735 of file mathplot.h.

mpLayerType mpLayer::m_type

protectedinherited

Define layer type, which is assigned by constructor.

Definition at line 328 of file mathplot.h.

bool mpLayer::m_visible

protectedinherited

Toggles layer visibility.

Definition at line 329 of file mathplot.h.