Plot layer implementing an abstract scale ruler. More...

#include <mathplot.h>

Inheritance diagram for mpScale:

Collaboration diagram for mpScale:

Public Member Functions
	mpScale (const wxString &name, int flags, bool grids)
	Full constructor. More...

virtual bool	HasBBox ()
	Check whether this layer has a bounding box. More...

void	ShowTicks (bool ticks)
	Set axis ticks. More...

bool	GetShowTicks () const
	Get axis ticks. More...

void	ShowGrids (bool grids)
	Set axis grids. More...

bool	GetShowGrids () const
	Get axis grids. More...

virtual void	SetLabelFormat (const wxString &format)
	Set axis Label format (used for mpX_NORMAL draw mode). More...

const wxString &	GetLabelFormat () const
	Get axis Label format (used for mpX_NORMAL draw mode). More...

void	SetGridPen (const wxPen &pen)
	Set grid pen. More...

const wxPen &	GetGridPen () const
	Get pen set for this axis. More...

void	SetAuto (bool automaticScalingIsEnabled)
	Enable/Disable automatic scaling for this axis. More...

bool	GetAuto () const
	Is automatic scaling enabled for this axis? More...

void	SetMinScale (double min)

double	GetMinScale () const

void	SetMaxScale (double max)

double	GetMaxScale () const

virtual bool	IsLogAxis ()=0

virtual void	SetLogAxis (bool log)=0

Public Member Functions inherited from mpLayer
	mpLayer (mpLayerType layerType)

void	SetWindow (mpWindow &w)
	Set the wxWindow handle.

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

int	GetLayerSubType () const
	Get layer subtype: each layer type can have several flavors. More...

virtual bool	IsLayerType (mpLayerType type, int *sub_type)
	Specifies that if the layer is of type "type". More...

virtual double	GetMinX ()
	Get inclusive left border of bounding box. More...

virtual double	GetMaxX ()
	Get inclusive right border of bounding box. More...

virtual double	GetMinY ()
	Get inclusive bottom border of bounding box. More...

virtual double	GetMaxY ()
	Get inclusive top border of bounding box. More...

void	Plot (wxDC &dc, mpWindow &w)
	Plot given view of layer to the given device context. More...

void	SetName (const wxString &name)
	Set layer name. More...

const wxString &	GetName () const
	Get layer name. More...

void	SetFont (const wxFont &font)
	Set layer font. More...

const wxFont &	GetFont () const
	Get font set for this layer. More...

void	SetFontColour (const wxColour &colour)
	Set layer font foreground colour. More...

const wxColour &	GetFontColour () const
	Get font foreground colour set for this layer. More...

void	SetPen (const wxPen &pen)
	Set layer pen. More...

const wxPen &	GetPen () const
	Get pen set for this layer. More...

void	SetBrush (const wxBrush &brush)
	Set layer brush. More...

const wxBrush &	GetBrush () const
	Get brush set for this layer. More...

void	SetShowName (bool show)
	Set Name visibility. More...

bool	GetShowName () const
	Get Name visibility. More...

void	SetDrawOutsideMargins (bool drawModeOutside)
	Set Draw mode: inside or outside margins. More...

bool	GetDrawOutsideMargins () const
	Get Draw mode: inside or outside margins. More...

wxBitmap	GetColourSquare (int side=16)
	Get a small square bitmap filled with the colour of the pen used in the layer. More...

bool	IsVisible () const
	Checks whether the layer is visible or not. More...

virtual void	SetVisible (bool show)
	Sets layer visibility. More...

bool	IsTractable () const
	Checks whether the layer is tractable or not. More...

virtual void	SetTractable (bool track)
	Sets layer tractability. More...

void	SetAlign (int align)
	Set X/Y alignment. More...

int	GetAlign () const
	Get X/Y alignment. More...

void	SetCanDelete (bool canDelete)
	Set CanDelete for plot. More...

bool	GetCanDelete (void) const
	Get CanDelete for plot. More...

mpLayerZOrder	GetZIndex (void) const
	Get the ZIndex of the plot. More...

Protected Member Functions
virtual int	GetOrigin (mpWindow &w)=0

double	GetStep (double scale, int minLabelSpacing)
	Calculate a 'nice' label step size for the given dataset and desired pixel spacing. More...

virtual void	DrawScaleName (wxDC &dc, mpWindow &w, int origin, int labelSize)=0

wxString	FormatLogValue (double n)

	wxDECLARE_DYNAMIC_CLASS (mpScale)

Protected Member Functions inherited from mpLayer
void	UpdateContext (wxDC &dc) const
	Initialize the context.

virtual void	DoPlot (wxDC &dc, mpWindow &w)=0
	Pure virtual method to plot the layer. More...

virtual void	DoBeforePlot ()
	If we need to do something before plot like reinitialize some parameters ...

void	CheckLog (double x, double y)
	Test if we are in log axis and if true return the log of the values.

Protected Attributes
wxPen	m_gridpen
	Grid's pen. Default Colour = LIGHT_GREY, width = 1, style = wxPENSTYLE_DOT.

bool	m_ticks
	Flag to show ticks. Default true.

bool	m_grids
	Flag to show grids. Default false.

bool	m_auto
	Flag to autosize grids. Default true.

double	m_min

double	m_max
	Min and max axis values when autosize is false.

wxString	m_labelFormat
	Format string used to print labels.

Protected Attributes inherited from mpLayer
const mpLayerType	m_type
	Layer type mpLAYER_*.

mpWindow *	m_win
	The wxWindow handle.

int	m_subtype
	Layer sub type, set in constructors.

wxFont	m_font
	Layer's font.

wxColour	m_fontcolour
	Layer's font foreground colour.

wxPen	m_pen
	Layer's pen. Default Colour = Black, width = 1, style = wxPENSTYLE_SOLID.

wxBrush	m_brush
	Layer's brush. Default wxTRANSPARENT_BRUSH.

wxString	m_name
	Layer's name.

bool	m_showName
	States whether the name of the layer must be shown. Default : false.

bool	m_drawOutsideMargins
	Select if the layer should draw only inside margins or over all DC. Default : false.

bool	m_visible
	Toggles layer visibility. Default : true.

bool	m_tractable
	Is the layer tractable.

int	m_flags
	Holds label alignment. Default : mpALIGN_NE.

mpRect	m_plotBoundaries
	The boundaries for plotting curve calculated by mpWindow.

bool	m_CanDelete
	Is the layer can be deleted.

mpLayerZOrder	m_ZIndex
	The index in Z-Order to draw the layer.

Detailed Description

Plot layer implementing an abstract scale ruler.

The scale numbering automatically adjusts to view and zoom factor.

Constructor & Destructor Documentation

◆ mpScale()

mpScale::mpScale	(	const wxString &	name,
		int	flags,
		bool	grids
	)

Full constructor.

Parameters

name	Label to plot by the ruler
flags	Set the position of the scale with respect to the window.
grids	Show grid or not. Give false (default) for not drawing the grid.

Member Function Documentation

◆ GetAuto()

bool mpScale::GetAuto ( ) const

inline

Is automatic scaling enabled for this axis?

Returns: automaticScalingIsEnabled

◆ GetGridPen()

const wxPen& mpScale::GetGridPen ( ) const

inline

Get pen set for this axis.

Returns: Pen

◆ GetLabelFormat()

const wxString& mpScale::GetLabelFormat ( ) const

inline

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

Returns: The format string

◆ GetShowGrids()

bool mpScale::GetShowGrids ( ) const

inline

Get axis grids.

Returns: true if grids are shown

◆ GetShowTicks()

bool mpScale::GetShowTicks ( ) const

inline

Get axis ticks.

Returns: true if ticks are shown

◆ GetStep()

double mpScale::GetStep	(	double	scale,
		int	minLabelSpacing
	)

protected

Calculate a 'nice' label step size for the given dataset and desired pixel spacing.

Label step size are considered nice if they are 1, 2, 5 or 10 raised to an appropriate power of 10.

Parameters

The	scale of the axis, denoted in [pixels / data value]
The	minimum wanted label spacing in pixels

Returns: The 'nice' step size for the interval

◆ HasBBox()

virtual bool mpScale::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.

◆ SetAuto()

void mpScale::SetAuto ( bool automaticScalingIsEnabled )

inline

Enable/Disable automatic scaling for this axis.

Parameters

automaticScalingIsEnabled

◆ SetGridPen()

void mpScale::SetGridPen ( const wxPen & pen )

inline

Set grid pen.

Parameters

pen	Pen, will be copied to internal class member

◆ SetLabelFormat()

virtual void mpScale::SetLabelFormat ( const wxString & format )

inlinevirtual

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

Parameters

format The format string

Reimplemented in mpScaleX.

◆ ShowGrids()

void mpScale::ShowGrids ( bool grids )

inline

Set axis grids.

Parameters

grids TRUE to plot axis grids.

◆ ShowTicks()

void mpScale::ShowTicks ( bool ticks )

inline

Set axis ticks.

Parameters

ticks TRUE to plot axis ticks.

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ mpScale()

Member Function Documentation

◆ GetAuto()

◆ GetGridPen()

◆ GetLabelFormat()

◆ GetShowGrids()

◆ GetShowTicks()

◆ GetStep()

◆ HasBBox()

◆ SetAuto()

◆ SetGridPen()

◆ SetLabelFormat()

◆ ShowGrids()

◆ ShowTicks()