Implements the legend to be added to the plot This layer allows you to add a legend to describe the plots in the window.
The legend uses the layer name as a label, and displays only layers of type mpLAYER_PLOT.
Definition at line 452 of file mathplot.h.
#include <mrpt/otherlibs/mathplot/mathplot.h>
Public Member Functions | |
mpInfoLegend () | |
Default constructor. | |
mpInfoLegend (wxRect rect, const wxBrush *brush=wxTRANSPARENT_BRUSH) | |
Complete constructor, setting initial rectangle and background brush. | |
~mpInfoLegend () | |
Default destructor. | |
virtual void | UpdateInfo (mpWindow &w, wxEvent &event) |
Updates the content of the info box. | |
virtual void | Plot (wxDC &dc, mpWindow &w) |
Plot method. | |
virtual bool | HasBBox () |
mpInfoLayer has not bounding box. | |
virtual bool | IsInfo () |
Specifies that this is an Info box layer. | |
virtual bool | Inside (wxPoint &point) |
Checks whether a point is inside the info box rectangle. | |
virtual void | Move (wxPoint delta) |
Moves the layer rectangle of given pixel deltas. | |
virtual void | UpdateReference () |
Updates the rectangle reference point. | |
wxPoint | GetPosition () |
Returns the position of the upper left corner of the box (in pixels) | |
wxSize | GetSize () |
Returns the size of the box (in pixels) | |
const wxRect & | GetRectangle () |
Returns the current rectangle coordinates. | |
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 | |
wxRect | m_dim |
The bounding rectangle of the box. It may be resized dynamically by the Plot method. | |
wxPoint | m_reference |
Holds the reference point for movements. | |
wxBrush | m_brush |
The brush to be used for the background. | |
int | m_winX |
int | m_winY |
Holds the mpWindow size. Used to rescale position when window is resized. | |
wxFont | m_font |
Layer's font. | |
wxPen | m_pen |
Layer's pen. | |
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. | |
mpInfoLegend::mpInfoLegend | ( | ) |
Default constructor.
mpInfoLegend::mpInfoLegend | ( | wxRect | rect, |
const wxBrush * | brush = wxTRANSPARENT_BRUSH |
||
) |
Complete constructor, setting initial rectangle and background brush.
rect | The initial bounding rectangle. |
brush | The wxBrush to be used for box background: default is transparent |
mpInfoLegend::~mpInfoLegend | ( | ) |
Default destructor.
|
inlineinherited |
|
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 |
|
inlineinherited |
Gets the 'continuity' property of the layer.
Definition at line 274 of file mathplot.h.
|
inlineinherited |
Get Draw mode: inside or outside margins.
Definition at line 301 of file mathplot.h.
|
inlineinherited |
|
inlineinherited |
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 310 of file mathplot.h.
|
inlinevirtualinherited |
Get inclusive right border of bounding box.
Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.
Definition at line 196 of file mathplot.h.
|
inlinevirtualinherited |
Get inclusive top border of bounding box.
Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.
Definition at line 206 of file mathplot.h.
|
inlinevirtualinherited |
Get inclusive left border of bounding box.
Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.
Definition at line 191 of file mathplot.h.
|
inlinevirtualinherited |
Get inclusive bottom border of bounding box.
Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.
Definition at line 201 of file mathplot.h.
|
inlineinherited |
|
inlineinherited |
|
inherited |
Returns the position of the upper left corner of the box (in pixels)
|
inlineinherited |
Returns the current rectangle coordinates.
Definition at line 407 of file mathplot.h.
|
inherited |
Returns the size of the box (in pixels)
|
inlinevirtualinherited |
mpInfoLayer has not bounding box.
Reimplemented from mpLayer.
Definition at line 372 of file mathplot.h.
|
virtualinherited |
Checks whether a point is inside the info box rectangle.
point | The point to be checked |
|
inlinevirtualinherited |
Specifies that this is an Info box layer.
Reimplemented from mpLayer.
Definition at line 383 of file mathplot.h.
|
inlineinherited |
Checks whether the layer is visible or not.
Definition at line 314 of file mathplot.h.
|
virtualinherited |
Moves the layer rectangle of given pixel deltas.
delta | The wxPoint container for delta coordinates along x and y. Units are in pixels. |
|
virtual |
Plot method.
dc | the device content where to plot |
w | the window to plot |
Reimplemented from mpInfoLayer.
|
inlineinherited |
Set layer brush.
brush | brush, will be copied to internal class member |
Definition at line 326 of file mathplot.h.
|
inlineinherited |
Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).
Definition at line 269 of file mathplot.h.
|
inlineinherited |
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 297 of file mathplot.h.
|
inlineinherited |
Set layer font.
font | Font, will be copied to internal class member |
Definition at line 288 of file mathplot.h.
|
inlineinherited |
Set layer name.
name | Name, will be copied to internal class member |
Definition at line 283 of file mathplot.h.
|
inlineinherited |
Set layer pen.
pen | Pen, will be copied to internal class member |
Definition at line 293 of file mathplot.h.
|
inlineinherited |
|
inlineinherited |
Shows or hides the text label with the name of the layer (default is visible).
Definition at line 278 of file mathplot.h.
|
virtual |
Updates the content of the info box.
Unused in this class.
w | parent mpWindow from which to obtain information |
event | The event which called the update. |
Reimplemented from mpInfoLayer.
|
virtualinherited |
Updates the rectangle reference point.
Used by internal methods of mpWindow to correctly move mpInfoLayers.
|
protectedinherited |
The brush to be used for the background.
Definition at line 412 of file mathplot.h.
|
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.
|
protectedinherited |
The bounding rectangle of the box. It may be resized dynamically by the Plot method.
Definition at line 410 of file mathplot.h.
|
protectedinherited |
select if the layer should draw only inside margins or over all DC
Definition at line 335 of file mathplot.h.
|
protectedinherited |
Layer's font.
Definition at line 329 of file mathplot.h.
|
protectedinherited |
Layer's name.
Definition at line 332 of file mathplot.h.
|
protectedinherited |
Layer's pen.
Definition at line 330 of file mathplot.h.
|
protectedinherited |
Holds the reference point for movements.
Definition at line 411 of file mathplot.h.
|
protectedinherited |
States whether the name of the layer must be shown (default is true).
Definition at line 334 of file mathplot.h.
|
protectedinherited |
Define layer type, which is assigned by constructor.
Definition at line 336 of file mathplot.h.
|
protectedinherited |
Toggles layer visibility.
Definition at line 337 of file mathplot.h.
|
protectedinherited |
Definition at line 413 of file mathplot.h.
|
protectedinherited |
Holds the mpWindow size. Used to rescale position when window is resized.
Definition at line 413 of file mathplot.h.
Page generated by Doxygen 1.9.6 for MRPT 1.4.0 SVN: at Wed Mar 22 04:35:51 UTC 2023 |