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:

List of all members.

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

---

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

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.

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

(

)

[inline, virtual]

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 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 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 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.

---

Member Data Documentation

int mpScaleX::m_flags [protected]

Flag for axis alignment.

Definition at line 731 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.

bool mpScaleX::m_ticks [protected]

Flag to toggle between ticks or grid.

Definition at line 735 of file mathplot.h.