A class providing graphs functionality for a 2D plot (either continuous or a set of points), from vectors of data.
This class can be used directly, the user does not need to derive any new class. Simply pass the data as two vectors with the same length containing the X and Y coordinates to the method SetData.
To generate a graph with a set of points, call
layerVar->SetContinuity(false)
or
layerVar->SetContinuity(true)
to render the sequence of coordinates as a continuous line.
(Added: Jose Luis Blanco, AGO-2007)
#include <mrpt/otherlibs/mathplot/mathplot.h>
Public Member Functions | |
| mpFXYVector (wxString name=wxEmptyString, int flags=mpALIGN_NE) | |
| void | SetData (const std::vector< double > &xs, const std::vector< double > &ys) |
| Changes the internal data: the set of points to draw. | |
| void | SetData (const std::vector< float > &xs, const std::vector< float > &ys) |
| Changes the internal data: the set of points to draw. | |
| void | Clear () |
| Clears all the data, leaving the layer empty. | |
| size_t | GetDataLength () const |
| Returns the number of data points currently hold in X & Y. | |
| void | AppendDataPoint (float x, float y) |
| Append a new data point (x,y) | |
| double | GetMinX () |
| Returns the actual minimum X data (loaded in SetData). | |
| double | GetMinY () |
| Returns the actual minimum Y data (loaded in SetData). | |
| double | GetMaxX () |
| Returns the actual maximum X data (loaded in SetData). | |
| double | GetMaxY () |
| Returns the actual maximum Y data (loaded in SetData). | |
| virtual void | Plot (wxDC &dc, mpWindow &w) |
| Layer plot handler. | |
| virtual bool | HasBBox () |
| Check whether this layer has a bounding box. | |
| virtual bool | IsInfo () |
| Check whether the layer is an info 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 Member Functions | |
| void | Rewind () |
| Rewind value enumeration with mpFXY::GetNextXY. | |
| bool | GetNextXY (double &x, double &y) |
| Get locus value for next N. | |
| void | UpdateViewBoundary (wxCoord xnew, wxCoord ynew) |
| Update label positioning data. | |
Protected Attributes | |
| std::vector< double > | m_xs |
| The internal copy of the set of data to draw. | |
| std::vector< double > | m_ys |
| size_t | m_index |
| The internal counter for the "GetNextXY" interface. | |
| double | m_minX |
| Loaded at SetData. | |
| double | m_maxX |
| double | m_minY |
| double | m_maxY |
| int | m_flags |
| Holds label alignment. | |
| wxCoord | maxDrawX |
| wxCoord | minDrawX |
| wxCoord | maxDrawY |
| wxCoord | minDrawY |
| 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. | |
| mpFXYVector::mpFXYVector | ( | wxString | name = wxEmptyString, |
| int | flags = mpALIGN_NE |
||
| ) |
| name | Label |
| flags | Label alignment, pass one of mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGN_SE. |
| void mpFXYVector::AppendDataPoint | ( | float | x, |
| float | y | ||
| ) |
Append a new data point (x,y)
| void mpFXYVector::Clear | ( | ) |
Clears all the data, leaving the layer empty.
| 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.
| size_t mpFXYVector::GetDataLength | ( | ) | const [inline] |
Returns the number of data points currently hold in X & Y.
Definition at line 1309 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.
| double mpFXYVector::GetMaxX | ( | ) | [inline, virtual] |
Returns the actual maximum X data (loaded in SetData).
Reimplemented from mpLayer.
Definition at line 1355 of file mathplot.h.
| double mpFXYVector::GetMaxY | ( | ) | [inline, virtual] |
Returns the actual maximum Y data (loaded in SetData).
Reimplemented from mpLayer.
Definition at line 1359 of file mathplot.h.
| double mpFXYVector::GetMinX | ( | ) | [inline, virtual] |
Returns the actual minimum X data (loaded in SetData).
Reimplemented from mpLayer.
Definition at line 1347 of file mathplot.h.
| double mpFXYVector::GetMinY | ( | ) | [inline, virtual] |
Returns the actual minimum Y data (loaded in SetData).
Reimplemented from mpLayer.
Definition at line 1351 of file mathplot.h.
| wxString mpLayer::GetName | ( | ) | const [inline, inherited] |
| bool mpFXYVector::GetNextXY | ( | double & | x, |
| double & | y | ||
| ) | [protected, virtual] |
Get locus value for next N.
Overridden in this implementation.
| x | Returns X value |
| y | Returns Y value |
Implements mpFXY.
| const wxPen& mpLayer::GetPen | ( | ) | const [inline, inherited] |
| virtual bool mpLayer::HasBBox | ( | ) | [inline, virtual, inherited] |
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.
| TRUE | Has bounding box |
| FALSE | Has not bounding box |
Reimplemented in mpBitmapLayer, mpMovableObject, mpText, mpScaleY, mpScaleX, and mpInfoLayer.
Definition at line 170 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 mpFXY::Plot | ( | wxDC & | dc, |
| mpWindow & | w | ||
| ) | [virtual, inherited] |
Layer plot handler.
This implementation will plot the locus in the visible area and put a label according to the alignment specified.
Implements mpLayer.
| void mpFXYVector::Rewind | ( | ) | [protected, virtual] |
Rewind value enumeration with mpFXY::GetNextXY.
Overridden in this implementation.
Implements mpFXY.
| 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 mpFXYVector::SetData | ( | const std::vector< double > & | xs, |
| const std::vector< double > & | ys | ||
| ) |
| void mpFXYVector::SetData | ( | const std::vector< float > & | xs, |
| const std::vector< float > & | ys | ||
| ) |
| 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 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 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.
| void mpFXY::UpdateViewBoundary | ( | wxCoord | xnew, |
| wxCoord | ynew | ||
| ) | [protected, inherited] |
Update label positioning data.
| xnew | New x coordinate |
| ynew | New y coordinate |
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 mpFXYVector::m_flags [protected] |
wxFont mpLayer::m_font [protected, inherited] |
Layer's font.
Definition at line 318 of file mathplot.h.
size_t mpFXYVector::m_index [protected] |
The internal counter for the "GetNextXY" interface.
Definition at line 1326 of file mathplot.h.
double mpFXYVector::m_maxX [protected] |
Definition at line 1330 of file mathplot.h.
double mpFXYVector::m_maxY [protected] |
Definition at line 1330 of file mathplot.h.
double mpFXYVector::m_minX [protected] |
Loaded at SetData.
Definition at line 1330 of file mathplot.h.
double mpFXYVector::m_minY [protected] |
Definition at line 1330 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.
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.
std::vector<double> mpFXYVector::m_xs [protected] |
The internal copy of the set of data to draw.
Definition at line 1322 of file mathplot.h.
std::vector<double> mpFXYVector::m_ys [protected] |
Definition at line 1322 of file mathplot.h.
wxCoord mpFXY::maxDrawX [protected, inherited] |
Definition at line 627 of file mathplot.h.
wxCoord mpFXY::maxDrawY [protected, inherited] |
Definition at line 627 of file mathplot.h.
wxCoord mpFXY::minDrawX [protected, inherited] |
Definition at line 627 of file mathplot.h.
wxCoord mpFXY::minDrawY [protected, inherited] |
Definition at line 627 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 |