Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
mpFXYVector Class Reference

Detailed Description

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)

Definition at line 1289 of file mathplot.h.

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

Inheritance diagram for mpFXYVector:
Inheritance graph

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.
 

Constructor & Destructor Documentation

◆ mpFXYVector()

mpFXYVector::mpFXYVector ( wxString  name = wxEmptyString,
int  flags = mpALIGN_NE 
)
Parameters
nameLabel
flagsLabel alignment, pass one of mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGN_SE.

Member Function Documentation

◆ AppendDataPoint()

void mpFXYVector::AppendDataPoint ( float  x,
float  y 
)

Append a new data point (x,y)

See also
SetData

◆ Clear()

void mpFXYVector::Clear ( )

Clears all the data, leaving the layer empty.

See also
SetData

◆ GetBrush()

const wxBrush & mpLayer::GetBrush ( ) const
inlineinherited

Get brush set for this layer.

Returns
brush.

Definition at line 322 of file mathplot.h.

◆ GetColourSquare()

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.

Parameters
sideside length in pixels
Returns
a wxBitmap filled with layer's colour

◆ GetContinuity()

bool mpLayer::GetContinuity ( ) const
inlineinherited

Gets the 'continuity' property of the layer.

See also
SetContinuity

Definition at line 274 of file mathplot.h.

◆ GetDataLength()

size_t mpFXYVector::GetDataLength ( ) const
inline

Returns the number of data points currently hold in X & Y.

See also
SetData

Definition at line 1317 of file mathplot.h.

◆ GetDrawOutsideMargins()

bool mpLayer::GetDrawOutsideMargins ( )
inlineinherited

Get Draw mode: inside or outside margins.

Returns
The draw mode

Definition at line 301 of file mathplot.h.

◆ GetFont()

const wxFont & mpLayer::GetFont ( ) const
inlineinherited

Get font set for this layer.

Returns
Font

Definition at line 259 of file mathplot.h.

◆ GetLayerType()

mpLayerType mpLayer::GetLayerType ( )
inlineinherited

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 310 of file mathplot.h.

◆ GetMaxX()

double mpFXYVector::GetMaxX ( )
inlinevirtual

Returns the actual maximum X data (loaded in SetData).

Reimplemented from mpLayer.

Definition at line 1363 of file mathplot.h.

◆ GetMaxY()

double mpFXYVector::GetMaxY ( )
inlinevirtual

Returns the actual maximum Y data (loaded in SetData).

Reimplemented from mpLayer.

Definition at line 1367 of file mathplot.h.

◆ GetMinX()

double mpFXYVector::GetMinX ( )
inlinevirtual

Returns the actual minimum X data (loaded in SetData).

Reimplemented from mpLayer.

Definition at line 1355 of file mathplot.h.

◆ GetMinY()

double mpFXYVector::GetMinY ( )
inlinevirtual

Returns the actual minimum Y data (loaded in SetData).

Reimplemented from mpLayer.

Definition at line 1359 of file mathplot.h.

◆ GetName()

wxString mpLayer::GetName ( ) const
inlineinherited

Get layer name.

Returns
Name

Definition at line 254 of file mathplot.h.

◆ GetNextXY()

bool mpFXYVector::GetNextXY ( double &  x,
double &  y 
)
protectedvirtual

Get locus value for next N.

Overridden in this implementation.

Parameters
xReturns X value
yReturns Y value

Implements mpFXY.

◆ GetPen()

const wxPen & mpLayer::GetPen ( ) const
inlineinherited

Get pen set for this layer.

Returns
Pen

Definition at line 264 of file mathplot.h.

◆ HasBBox()

virtual bool mpLayer::HasBBox ( )
inlinevirtualinherited

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 178 of file mathplot.h.

◆ IsInfo()

virtual bool mpLayer::IsInfo ( )
inlinevirtualinherited

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 186 of file mathplot.h.

◆ IsVisible()

bool mpLayer::IsVisible ( )
inlineinherited

Checks whether the layer is visible or not.

Returns
true if visible

Definition at line 314 of file mathplot.h.

◆ Plot()

virtual void mpFXY::Plot ( wxDC &  dc,
mpWindow w 
)
virtualinherited

Layer plot handler.

This implementation will plot the locus in the visible area and put a label according to the alignment specified.

Implements mpLayer.

◆ Rewind()

void mpFXYVector::Rewind ( )
protectedvirtual

Rewind value enumeration with mpFXY::GetNextXY.

Overridden in this implementation.

Implements mpFXY.

◆ SetBrush()

void mpLayer::SetBrush ( wxBrush  brush)
inlineinherited

Set layer brush.

Parameters
brushbrush, will be copied to internal class member

Definition at line 326 of file mathplot.h.

◆ SetContinuity()

void mpLayer::SetContinuity ( bool  continuity)
inlineinherited

Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).

See also
GetContinuity

Definition at line 269 of file mathplot.h.

◆ SetData() [1/2]

void mpFXYVector::SetData ( const std::vector< double > &  xs,
const std::vector< double > &  ys 
)

Changes the internal data: the set of points to draw.

Both vectors MUST be of the same length. This method DOES NOT refresh the mpWindow; do it manually.

See also
Clear

◆ SetData() [2/2]

void mpFXYVector::SetData ( const std::vector< float > &  xs,
const std::vector< float > &  ys 
)

Changes the internal data: the set of points to draw.

Both vectors MUST be of the same length. This method DOES NOT refresh the mpWindow; do it manually.

See also
Clear

◆ SetDrawOutsideMargins()

void mpLayer::SetDrawOutsideMargins ( bool  drawModeOutside)
inlineinherited

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 297 of file mathplot.h.

◆ SetFont()

void mpLayer::SetFont ( wxFont &  font)
inlineinherited

Set layer font.

Parameters
fontFont, will be copied to internal class member

Definition at line 288 of file mathplot.h.

◆ SetName()

void mpLayer::SetName ( wxString  name)
inlineinherited

Set layer name.

Parameters
nameName, will be copied to internal class member

Definition at line 283 of file mathplot.h.

◆ SetPen()

void mpLayer::SetPen ( wxPen  pen)
inlineinherited

Set layer pen.

Parameters
penPen, will be copied to internal class member

Definition at line 293 of file mathplot.h.

◆ SetVisible()

void mpLayer::SetVisible ( bool  show)
inlineinherited

Sets layer visibility.

Parameters
showvisibility bool.

Definition at line 318 of file mathplot.h.

◆ ShowName()

void mpLayer::ShowName ( bool  show)
inlineinherited

Shows or hides the text label with the name of the layer (default is visible).

Definition at line 278 of file mathplot.h.

◆ UpdateViewBoundary()

void mpFXY::UpdateViewBoundary ( wxCoord  xnew,
wxCoord  ynew 
)
protectedinherited

Update label positioning data.

Parameters
xnewNew x coordinate
ynewNew y coordinate

Member Data Documentation

◆ m_brush

wxBrush mpLayer::m_brush
protectedinherited

Layer's brush.

Definition at line 331 of file mathplot.h.

◆ m_continuous

bool mpLayer::m_continuous
protectedinherited

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

Definition at line 333 of file mathplot.h.

◆ m_drawOutsideMargins

bool mpLayer::m_drawOutsideMargins
protectedinherited

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

Definition at line 335 of file mathplot.h.

◆ m_flags

int mpFXYVector::m_flags
protected

Holds label alignment.

Definition at line 1370 of file mathplot.h.

◆ m_font

wxFont mpLayer::m_font
protectedinherited

Layer's font.

Definition at line 329 of file mathplot.h.

◆ m_index

size_t mpFXYVector::m_index
protected

The internal counter for the "GetNextXY" interface.

Definition at line 1334 of file mathplot.h.

◆ m_maxX

double mpFXYVector::m_maxX
protected

Definition at line 1338 of file mathplot.h.

◆ m_maxY

double mpFXYVector::m_maxY
protected

Definition at line 1338 of file mathplot.h.

◆ m_minX

double mpFXYVector::m_minX
protected

Loaded at SetData.

Definition at line 1338 of file mathplot.h.

◆ m_minY

double mpFXYVector::m_minY
protected

Definition at line 1338 of file mathplot.h.

◆ m_name

wxString mpLayer::m_name
protectedinherited

Layer's name.

Definition at line 332 of file mathplot.h.

◆ m_pen

wxPen mpLayer::m_pen
protectedinherited

Layer's pen.

Definition at line 330 of file mathplot.h.

◆ m_showName

bool mpLayer::m_showName
protectedinherited

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

Definition at line 334 of file mathplot.h.

◆ m_type

mpLayerType mpLayer::m_type
protectedinherited

Define layer type, which is assigned by constructor.

Definition at line 336 of file mathplot.h.

◆ m_visible

bool mpLayer::m_visible
protectedinherited

Toggles layer visibility.

Definition at line 337 of file mathplot.h.

◆ m_xs

std::vector<double> mpFXYVector::m_xs
protected

The internal copy of the set of data to draw.

Definition at line 1330 of file mathplot.h.

◆ m_ys

std::vector<double> mpFXYVector::m_ys
protected

Definition at line 1330 of file mathplot.h.

◆ maxDrawX

wxCoord mpFXY::maxDrawX
protectedinherited

Definition at line 635 of file mathplot.h.

◆ maxDrawY

wxCoord mpFXY::maxDrawY
protectedinherited

Definition at line 635 of file mathplot.h.

◆ minDrawX

wxCoord mpFXY::minDrawX
protectedinherited

Definition at line 635 of file mathplot.h.

◆ minDrawY

wxCoord mpFXY::minDrawY
protectedinherited

Definition at line 635 of file mathplot.h.




Page generated by Doxygen 1.9.7 for MRPT 1.4.0 SVN: at Tue Jun 27 15:23:24 UTC 2023