Main MRPT website > C++ reference
MRPT logo
Public Member Functions | Protected Attributes

mpLayer Class Reference


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.

Definition at line 156 of file mathplot.h.

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

Inheritance diagram for mpLayer:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 mpLayer ()
virtual ~mpLayer ()
virtual bool HasBBox ()
 Check whether this layer has a bounding box.
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.
virtual void Plot (wxDC &dc, mpWindow &w)=0
 Plot given view of layer to the given device context.
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

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

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

Definition at line 161 of file mathplot.h.


Member Function Documentation

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

Get brush set for this layer.

Returns:
brush.

Definition at line 314 of file mathplot.h.

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:
sideside length in pixels
Returns:
a wxBitmap filled with layer's colour
bool mpLayer::GetContinuity (  ) const [inline]

Gets the 'continuity' property of the layer.

See also:
SetContinuity

Definition at line 266 of file mathplot.h.

bool mpLayer::GetDrawOutsideMargins (  ) [inline]

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]

Get font set for this layer.

Returns:
Font

Definition at line 251 of file mathplot.h.

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

Definition at line 302 of file mathplot.h.

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

Get inclusive right border of bounding box.

Returns:
Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 188 of file mathplot.h.

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

Get inclusive top border of bounding box.

Returns:
Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 198 of file mathplot.h.

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

Get inclusive left border of bounding box.

Returns:
Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 183 of file mathplot.h.

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

Get inclusive bottom border of bounding box.

Returns:
Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 193 of file mathplot.h.

wxString mpLayer::GetName (  ) const [inline]

Get layer name.

Returns:
Name

Definition at line 246 of file mathplot.h.

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

Get pen set for this layer.

Returns:
Pen

Definition at line 256 of file mathplot.h.

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:
TRUEHas bounding box
FALSEHas not bounding box

Reimplemented in mpInfoLayer, mpScaleX, mpScaleY, mpText, mpMovableObject, and mpBitmapLayer.

Definition at line 170 of file mathplot.h.

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.

Definition at line 178 of file mathplot.h.

bool mpLayer::IsVisible (  ) [inline]

Checks whether the layer is visible or not.

Returns:
true if visible

Definition at line 306 of file mathplot.h.

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:
dcDevice context to plot to.
wView to plot. The visible area can be retrieved from this object.
See also:
mpWindow::p2x,mpWindow::p2y,mpWindow::x2p,mpWindow::y2p

Implemented in mpInfoLayer, mpInfoCoords, mpInfoLegend, mpFX, mpFY, mpFXY, mpProfile, mpScaleX, mpScaleY, mpText, mpMovableObject, and mpBitmapLayer.

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

Set layer brush.

Parameters:
brushbrush, will be copied to internal class member

Definition at line 318 of file mathplot.h.

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

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]

Set Draw mode: inside or outside margins.

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

Parameters:
drawModeOutsideThe draw mode to be set

Definition at line 289 of file mathplot.h.

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

Set layer font.

Parameters:
fontFont, will be copied to internal class member

Definition at line 280 of file mathplot.h.

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

Set layer name.

Parameters:
nameName, will be copied to internal class member

Definition at line 275 of file mathplot.h.

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

Set layer pen.

Parameters:
penPen, will be copied to internal class member

Definition at line 285 of file mathplot.h.

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

Sets layer visibility.

Parameters:
showvisibility bool.

Definition at line 310 of file mathplot.h.

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

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 [protected]

Layer's brush.

Reimplemented in mpInfoLayer.

Definition at line 323 of file mathplot.h.

bool mpLayer::m_continuous [protected]

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

Definition at line 325 of file mathplot.h.

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

Definition at line 327 of file mathplot.h.

wxFont mpLayer::m_font [protected]

Layer's font.

Definition at line 318 of file mathplot.h.

wxString mpLayer::m_name [protected]

Layer's name.

Definition at line 324 of file mathplot.h.

wxPen mpLayer::m_pen [protected]

Layer's pen.

Definition at line 322 of file mathplot.h.

bool mpLayer::m_showName [protected]

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

Definition at line 326 of file mathplot.h.

Define layer type, which is assigned by constructor.

Definition at line 328 of file mathplot.h.

bool mpLayer::m_visible [protected]

Toggles layer visibility.

Definition at line 329 of file mathplot.h.




Page generated by Doxygen 1.7.2 for MRPT 0.9.4 SVN: at Mon Jan 10 22:30:30 UTC 2011