Plot layer implementing a y-scale ruler.
If align is set to mpALIGN_CENTER, the ruler is fixed at X=0 in the coordinate system. If the align is set to mpALIGN_TOP or mpALIGN_BOTTOM, the axis is always drawn respectively at top or bottom of the window. A label is plotted at the top-right hand of the ruler. The scale numbering automatically adjusts to view and zoom factor.
#include <mrpt/otherlibs/mathplot/mathplot.h>
Public Member Functions | |
| mpScaleY (wxString name=wxT("Y"), int flags=mpALIGN_CENTER, bool ticks=true) | |
| 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 Y axis alignment. | |
| void | SetTicks (bool ticks) |
| Set Y axis ticks or grid. | |
| bool | GetTicks () |
| Get Y axis ticks or grid. | |
| void | SetLabelFormat (const wxString &format) |
| Set Y axis Label format. | |
| const wxString & | SetLabelFormat () |
| Get Y axis Label format. | |
| 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. | |
| 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. | |
| mpScaleY::mpScaleY | ( | wxString | name = wxT("Y"), |
| int | flags = mpALIGN_CENTER, |
||
| bool | ticks = true |
||
| ) |
| name | Label to plot by the ruler |
| flags | Set position of the scale respect to the window. |
| ticks | Select ticks or grid. Give TRUE (default) for drawing axis ticks, FALSE for drawing the grid |
| const wxBrush& mpLayer::GetBrush | ( | ) | const [inline, inherited] |
| 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.
| side | side length in pixels |
| bool mpLayer::GetContinuity | ( | ) | const [inline, inherited] |
Gets the 'continuity' property of the layer.
Definition at line 266 of file mathplot.h.
| bool mpLayer::GetDrawOutsideMargins | ( | ) | [inline, inherited] |
Get Draw mode: inside or outside margins.
Definition at line 293 of file mathplot.h.
| const wxFont& mpLayer::GetFont | ( | ) | const [inline, inherited] |
| mpLayerType mpLayer::GetLayerType | ( | ) | [inline, inherited] |
Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value.
Definition at line 302 of file mathplot.h.
| virtual double mpLayer::GetMaxX | ( | ) | [inline, virtual, inherited] |
Get inclusive right border of bounding box.
Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.
Definition at line 188 of file mathplot.h.
| virtual double mpLayer::GetMaxY | ( | ) | [inline, virtual, inherited] |
Get inclusive top border of bounding box.
Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.
Definition at line 198 of file mathplot.h.
| virtual double mpLayer::GetMinX | ( | ) | [inline, virtual, inherited] |
Get inclusive left border of bounding box.
Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.
Definition at line 183 of file mathplot.h.
| virtual double mpLayer::GetMinY | ( | ) | [inline, virtual, inherited] |
Get inclusive bottom border of bounding box.
Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.
Definition at line 193 of file mathplot.h.
| wxString mpLayer::GetName | ( | ) | const [inline, inherited] |
| const wxPen& mpLayer::GetPen | ( | ) | const [inline, inherited] |
| bool mpScaleY::GetTicks | ( | ) | [inline] |
Get Y axis ticks or grid.
Definition at line 776 of file mathplot.h.
| virtual bool mpScaleY::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 764 of file mathplot.h.
| virtual bool mpLayer::IsInfo | ( | ) | [inline, virtual, inherited] |
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.
Reimplemented in mpInfoLayer.
Definition at line 178 of file mathplot.h.
| bool mpLayer::IsVisible | ( | ) | [inline, inherited] |
Checks whether the layer is visible or not.
Definition at line 306 of file mathplot.h.
| virtual void mpScaleY::Plot | ( | wxDC & | dc, |
| mpWindow & | w | ||
| ) | [virtual] |
Layer plot handler.
This implementation will plot the ruler adjusted to the visible area.
Implements mpLayer.
| void mpScaleY::SetAlign | ( | int | align | ) | [inline] |
Set Y axis alignment.
| align | alignment (choose between mpALIGN_BORDER_LEFT, mpALIGN_LEFT, mpALIGN_CENTER, mpALIGN_RIGHT, mpALIGN_BORDER_RIGHT) |
Definition at line 768 of file mathplot.h.
| void mpLayer::SetBrush | ( | wxBrush | brush | ) | [inline, inherited] |
Set layer brush.
| brush | brush, will be copied to internal class member |
Definition at line 318 of file mathplot.h.
| void mpLayer::SetContinuity | ( | bool | continuity | ) | [inline, inherited] |
Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).
Definition at line 261 of file mathplot.h.
| void mpLayer::SetDrawOutsideMargins | ( | bool | drawModeOutside | ) | [inline, inherited] |
Set Draw mode: inside or outside margins.
Default is outside, which allows the layer to draw up to the mpWindow border.
| drawModeOutside | The draw mode to be set |
Definition at line 289 of file mathplot.h.
| void mpLayer::SetFont | ( | wxFont & | font | ) | [inline, inherited] |
Set layer font.
| font | Font, will be copied to internal class member |
Definition at line 280 of file mathplot.h.
| void mpScaleY::SetLabelFormat | ( | const wxString & | format | ) | [inline] |
Set Y axis Label format.
| format | The format string |
Definition at line 780 of file mathplot.h.
References mrpt::format().
| const wxString& mpScaleY::SetLabelFormat | ( | ) | [inline] |
| void mpLayer::SetName | ( | wxString | name | ) | [inline, inherited] |
Set layer name.
| name | Name, will be copied to internal class member |
Definition at line 275 of file mathplot.h.
| void mpLayer::SetPen | ( | wxPen | pen | ) | [inline, inherited] |
Set layer pen.
| pen | Pen, will be copied to internal class member |
Definition at line 285 of file mathplot.h.
| void mpScaleY::SetTicks | ( | bool | ticks | ) | [inline] |
Set Y axis ticks or grid.
| ticks | TRUE to plot axis ticks, FALSE to plot grid. |
Definition at line 772 of file mathplot.h.
| void mpLayer::SetVisible | ( | bool | show | ) | [inline, inherited] |
| void mpLayer::ShowName | ( | bool | show | ) | [inline, inherited] |
Shows or hides the text label with the name of the layer (default is visible).
Definition at line 270 of file mathplot.h.
wxBrush mpLayer::m_brush [protected, inherited] |
bool mpLayer::m_continuous [protected, inherited] |
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 [protected, inherited] |
select if the layer should draw only inside margins or over all DC
Definition at line 327 of file mathplot.h.
int mpScaleY::m_flags [protected] |
Flag for axis alignment.
Definition at line 784 of file mathplot.h.
wxFont mpLayer::m_font [protected, inherited] |
Layer's font.
Definition at line 318 of file mathplot.h.
wxString mpScaleY::m_labelFormat [protected] |
Format string used to print labels.
Definition at line 789 of file mathplot.h.
wxString mpLayer::m_name [protected, inherited] |
Layer's name.
Definition at line 324 of file mathplot.h.
wxPen mpLayer::m_pen [protected, inherited] |
Layer's pen.
Definition at line 322 of file mathplot.h.
bool mpLayer::m_showName [protected, inherited] |
States whether the name of the layer must be shown (default is true).
Definition at line 326 of file mathplot.h.
bool mpScaleY::m_ticks [protected] |
Flag to toggle between ticks or grid.
Definition at line 788 of file mathplot.h.
mpLayerType mpLayer::m_type [protected, inherited] |
Define layer type, which is assigned by constructor.
Definition at line 328 of file mathplot.h.
bool mpLayer::m_visible [protected, inherited] |
Toggles layer visibility.
Definition at line 329 of file mathplot.h.
| Page generated by Doxygen 1.7.5 for MRPT 0.9.5 SVN: at Thu Oct 13 21:25:36 UTC 2011 |