mpLayer Class Reference

#include <mathplot.h>

Inheritance diagram for mpLayer:

Public Member Functions
	mpLayer ()
virtual	~mpLayer ()
virtual bool	HasBBox ()
virtual bool	IsInfo ()
virtual double	GetMinX ()
virtual double	GetMaxX ()
virtual double	GetMinY ()
virtual double	GetMaxY ()
virtual void	Plot (wxDC &dc, mpWindow &w)=0
wxString	GetName () const
const wxFont &	GetFont () const
const wxPen &	GetPen () const
void	SetContinuity (bool continuity)
bool	GetContinuity () const
void	ShowName (bool show)
void	SetName (wxString name)
void	SetFont (wxFont &font)
void	SetPen (wxPen pen)
void	SetDrawOutsideMargins (bool drawModeOutside)
bool	GetDrawOutsideMargins ()
wxBitmap	GetColourSquare (int side=16)
mpLayerType	GetLayerType ()
bool	IsVisible ()
void	SetVisible (bool show)
const wxBrush &	GetBrush () const
void	SetBrush (wxBrush brush)
Protected Attributes
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.

Detailed Description

Plot layer, abstract base class. Any number of mpLayer implementations can be attached to mpWindow. Examples for mpLayer implementations are function graphs, or scale rulers.

For convenience mpLayer defines a name, a font (wxFont), a pen (wxPen), and a continuity property (bool) as class members. The default values at constructor are the default font, a black pen, and continuity set to false (draw separate points). These may or may not be used by implementations.

Constructor & Destructor Documentation

mpLayer::mpLayer ( )

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

Member Function Documentation

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

Get brush set for this layer.

Returns:: brush.

wxBitmap mpLayer::GetColourSquare ( int side = 16 )

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

References m_pen.

bool mpLayer::GetContinuity ( ) const [inline]

Gets the 'continuity' property of the layer.

See also:: SetContinuity

bool mpLayer::GetDrawOutsideMargins ( ) [inline]

Get Draw mode: inside or outside margins.

Returns:: The draw mode

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

Get font set for this layer.

Returns:: Font

mpLayerType mpLayer::GetLayerType ( ) [inline]

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

Referenced by mpInfoLegend::Plot().

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

Get inclusive right border of bounding box.

Returns:: Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Referenced by mpWindow::UpdateBBox().

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

Get inclusive top border of bounding box.

Returns:: Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Referenced by mpWindow::UpdateBBox().

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

Get inclusive left border of bounding box.

Returns:: Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Referenced by mpWindow::UpdateBBox().

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

Get inclusive bottom border of bounding box.

Returns:: Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Referenced by mpWindow::UpdateBBox().

wxString mpLayer::GetName ( ) const [inline]

Get layer name.

Returns:: Name

Referenced by mpText::Plot(), and mpInfoLegend::Plot().

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

Get pen set for this layer.

Returns:: Pen

Referenced by mpInfoLegend::Plot().

virtual bool mpLayer::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 in mpInfoLayer, mpScaleX, mpScaleY, mpText, mpMovableObject, and mpBitmapLayer.

Referenced by mpWindow::UpdateBBox().

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

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.

bool mpLayer::IsVisible ( ) [inline]

Checks whether the layer is visible or not.

Returns:: true if visible

Referenced by mpWindow::IsLayerVisible(), and mpInfoLegend::Plot().

virtual void mpLayer::Plot	(	wxDC &	dc,
		mpWindow &	w
	)			`[pure 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: