Base class to create small rectangular info boxes mpInfoLayer is the base class to create a small rectangular info box in transparent overlay over plot layers.
It is used to implement objects like legends.
Definition at line 350 of file mathplot.h.
#include <mrpt/otherlibs/mathplot/mathplot.h>
Public Member Functions | |
mpInfoLayer () | |
Default constructor. More... | |
mpInfoLayer (wxRect rect, const wxBrush *brush=wxTRANSPARENT_BRUSH) | |
Complete constructor. More... | |
virtual | ~mpInfoLayer () |
Destructor. More... | |
virtual void | UpdateInfo (mpWindow &w, wxEvent &event) |
Updates the content of the info box. More... | |
virtual bool | HasBBox () |
mpInfoLayer has not bounding box. More... | |
virtual void | Plot (wxDC &dc, mpWindow &w) |
Plot method. More... | |
virtual bool | IsInfo () |
Specifies that this is an Info box layer. More... | |
virtual bool | Inside (wxPoint &point) |
Checks whether a point is inside the info box rectangle. More... | |
virtual void | Move (wxPoint delta) |
Moves the layer rectangle of given pixel deltas. More... | |
virtual void | UpdateReference () |
Updates the rectangle reference point. More... | |
wxPoint | GetPosition () |
Returns the position of the upper left corner of the box (in pixels) More... | |
wxSize | GetSize () |
Returns the size of the box (in pixels) More... | |
const wxRect & | GetRectangle () |
Returns the current rectangle coordinates. More... | |
virtual double | GetMinX () |
Get inclusive left border of bounding box. More... | |
virtual double | GetMaxX () |
Get inclusive right border of bounding box. More... | |
virtual double | GetMinY () |
Get inclusive bottom border of bounding box. More... | |
virtual double | GetMaxY () |
Get inclusive top border of bounding box. More... | |
wxString | GetName () const |
Get layer name. More... | |
const wxFont & | GetFont () const |
Get font set for this layer. More... | |
const wxPen & | GetPen () const |
Get pen set for this layer. More... | |
void | SetContinuity (bool continuity) |
Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points). More... | |
bool | GetContinuity () const |
Gets the 'continuity' property of the layer. More... | |
void | ShowName (bool show) |
Shows or hides the text label with the name of the layer (default is visible). More... | |
void | SetName (wxString name) |
Set layer name. More... | |
void | SetFont (wxFont &font) |
Set layer font. More... | |
void | SetPen (wxPen pen) |
Set layer pen. More... | |
void | SetDrawOutsideMargins (bool drawModeOutside) |
Set Draw mode: inside or outside margins. More... | |
bool | GetDrawOutsideMargins () |
Get Draw mode: inside or outside margins. More... | |
wxBitmap | GetColourSquare (int side=16) |
Get a small square bitmap filled with the colour of the pen used in the layer. More... | |
mpLayerType | GetLayerType () |
Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value. More... | |
bool | IsVisible () |
Checks whether the layer is visible or not. More... | |
void | SetVisible (bool show) |
Sets layer visibility. More... | |
const wxBrush & | GetBrush () const |
Get brush set for this layer. More... | |
void | SetBrush (wxBrush brush) |
Set layer brush. More... | |
Protected Attributes | |
wxRect | m_dim |
The bounding rectangle of the box. It may be resized dynamically by the Plot method. More... | |
wxPoint | m_reference |
Holds the reference point for movements. More... | |
wxBrush | m_brush |
The brush to be used for the background. More... | |
int | m_winX |
int | m_winY |
Holds the mpWindow size. Used to rescale position when window is resized. More... | |
wxFont | m_font |
Layer's font. More... | |
wxPen | m_pen |
Layer's pen. More... | |
wxString | m_name |
Layer's name. More... | |
bool | m_continuous |
Specify if the layer will be plotted as a continuous line or a set of points. More... | |
bool | m_showName |
States whether the name of the layer must be shown (default is true). More... | |
bool | m_drawOutsideMargins |
select if the layer should draw only inside margins or over all DC More... | |
mpLayerType | m_type |
Define layer type, which is assigned by constructor. More... | |
bool | m_visible |
Toggles layer visibility. More... | |
mpInfoLayer::mpInfoLayer | ( | ) |
Default constructor.
mpInfoLayer::mpInfoLayer | ( | wxRect | rect, |
const wxBrush * | brush = wxTRANSPARENT_BRUSH |
||
) |
Complete constructor.
rect | Sets the initial size rectangle of the layer. |
brush | pointer to a fill brush. Default is transparent |
|
virtual |
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 mpBitmapLayer, mpMovableObject, and mpFXYVector.
Definition at line 196 of file mathplot.h.
|
inlinevirtualinherited |
Get inclusive top border of bounding box.
Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.
Definition at line 206 of file mathplot.h.
|
inlinevirtualinherited |
Get inclusive left border of bounding box.
Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.
Definition at line 191 of file mathplot.h.
|
inlinevirtualinherited |
Get inclusive bottom border of bounding box.
Reimplemented in mpBitmapLayer, mpMovableObject, and mpFXYVector.
Definition at line 201 of file mathplot.h.
|
inlineinherited |
|
inlineinherited |
wxPoint mpInfoLayer::GetPosition | ( | ) |
Returns the position of the upper left corner of the box (in pixels)
|
inline |
Returns the current rectangle coordinates.
Definition at line 407 of file mathplot.h.
wxSize mpInfoLayer::GetSize | ( | ) |
Returns the size of the box (in pixels)
|
inlinevirtual |
mpInfoLayer has not bounding box.
Reimplemented from mpLayer.
Definition at line 372 of file mathplot.h.
References mpLayer::Plot().
|
virtual |
Checks whether a point is inside the info box rectangle.
point | The point to be checked |
|
inlinevirtual |
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.
|
virtual |
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.
Can be overidden by derived classes.
dc | the device content where to plot |
w | the window to plot |
Implements mpLayer.
Reimplemented in mpInfoLegend, and mpInfoCoords.
|
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.
Should be overidden by derived classes. Update may behave in different ways according to the type of event which called it.
w | parent mpWindow from which to obtain informations |
event | The event which called the update. |
Reimplemented in mpInfoLegend, and mpInfoCoords.
|
virtual |
Updates the rectangle reference point.
Used by internal methods of mpWindow to correctly move mpInfoLayers.
|
protected |
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.
|
protected |
The bounding rectangle of the box. It may be resized dynamically by the Plot method.
Definition at line 407 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 326 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.
|
protected |
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.
|
protected |
Definition at line 413 of file mathplot.h.
|
protected |
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.8.11 for MRPT 1.4.0 SVN: at Mon Aug 15 11:50:21 UTC 2016 |