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

Detailed Description

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>

Inheritance diagram for mpInfoLegend:
Inheritance graph

Public Member Functions

 mpInfoLegend ()
 Default constructor. More...
 
 mpInfoLegend (wxRect rect, const wxBrush *brush=wxTRANSPARENT_BRUSH)
 Complete constructor, setting initial rectangle and background brush. More...
 
 ~mpInfoLegend ()
 Default destructor. More...
 
virtual void UpdateInfo (mpWindow &w, wxEvent &event)
 Updates the content of the info box. More...
 
virtual void Plot (wxDC &dc, mpWindow &w)
 Plot method. More...
 
virtual bool HasBBox ()
 mpInfoLayer has not bounding box. 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...
 

Constructor & Destructor Documentation

◆ mpInfoLegend() [1/2]

mpInfoLegend::mpInfoLegend ( )

Default constructor.

◆ mpInfoLegend() [2/2]

mpInfoLegend::mpInfoLegend ( wxRect  rect,
const wxBrush *  brush = wxTRANSPARENT_BRUSH 
)

Complete constructor, setting initial rectangle and background brush.

Parameters
rectThe initial bounding rectangle.
brushThe wxBrush to be used for box background: default is transparent
See also
mpInfoLayer::mpInfoLayer

◆ ~mpInfoLegend()

mpInfoLegend::~mpInfoLegend ( )

Default destructor.

Member Function Documentation

◆ 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.

◆ 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()

virtual double mpLayer::GetMaxX ( )
inlinevirtualinherited

Get inclusive right border of bounding box.

Returns
Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 196 of file mathplot.h.

◆ GetMaxY()

virtual double mpLayer::GetMaxY ( )
inlinevirtualinherited

Get inclusive top border of bounding box.

Returns
Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 206 of file mathplot.h.

◆ GetMinX()

virtual double mpLayer::GetMinX ( )
inlinevirtualinherited

Get inclusive left border of bounding box.

Returns
Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 191 of file mathplot.h.

◆ GetMinY()

virtual double mpLayer::GetMinY ( )
inlinevirtualinherited

Get inclusive bottom border of bounding box.

Returns
Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 201 of file mathplot.h.

◆ GetName()

wxString mpLayer::GetName ( ) const
inlineinherited

Get layer name.

Returns
Name

Definition at line 254 of file mathplot.h.

◆ GetPen()

const wxPen & mpLayer::GetPen ( ) const
inlineinherited

Get pen set for this layer.

Returns
Pen

Definition at line 264 of file mathplot.h.

◆ GetPosition()

wxPoint mpInfoLayer::GetPosition ( )
inherited

Returns the position of the upper left corner of the box (in pixels)

Returns
The rectangle position

◆ GetRectangle()

const wxRect & mpInfoLayer::GetRectangle ( )
inlineinherited

Returns the current rectangle coordinates.

Returns
The info layer rectangle

Definition at line 407 of file mathplot.h.

◆ GetSize()

wxSize mpInfoLayer::GetSize ( )
inherited

Returns the size of the box (in pixels)

Returns
The rectangle size

◆ HasBBox()

virtual bool mpInfoLayer::HasBBox ( )
inlinevirtualinherited

mpInfoLayer has not bounding box.

See also
mpLayer::HasBBox
Returns
always FALSE

Reimplemented from mpLayer.

Definition at line 372 of file mathplot.h.

◆ Inside()

virtual bool mpInfoLayer::Inside ( wxPoint &  point)
virtualinherited

Checks whether a point is inside the info box rectangle.

Parameters
pointThe point to be checked
Returns
true if the point is inside the bounding box

◆ IsInfo()

virtual bool mpInfoLayer::IsInfo ( )
inlinevirtualinherited

Specifies that this is an Info box layer.

Returns
always TRUE
See also
mpLayer::IsInfo

Reimplemented from mpLayer.

Definition at line 383 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.

◆ Move()

virtual void mpInfoLayer::Move ( wxPoint  delta)
virtualinherited

Moves the layer rectangle of given pixel deltas.

Parameters
deltaThe wxPoint container for delta coordinates along x and y. Units are in pixels.

◆ Plot()

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

Plot method.

Parameters
dcthe device content where to plot
wthe window to plot
See also
mpLayer::Plot

Reimplemented from mpInfoLayer.

◆ 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.

◆ 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.

◆ UpdateInfo()

virtual void mpInfoLegend::UpdateInfo ( mpWindow w,
wxEvent &  event 
)
virtual

Updates the content of the info box.

Unused in this class.

Parameters
wparent mpWindow from which to obtain information
eventThe event which called the update.

Reimplemented from mpInfoLayer.

◆ UpdateReference()

virtual void mpInfoLayer::UpdateReference ( )
virtualinherited

Updates the rectangle reference point.

Used by internal methods of mpWindow to correctly move mpInfoLayers.

Member Data Documentation

◆ m_brush

wxBrush mpInfoLayer::m_brush
protectedinherited

The brush to be used for the background.

Definition at line 412 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_dim

wxRect mpInfoLayer::m_dim
protectedinherited

The bounding rectangle of the box. It may be resized dynamically by the Plot method.

Definition at line 410 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_font

wxFont mpLayer::m_font
protectedinherited

Layer's font.

Definition at line 329 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_reference

wxPoint mpInfoLayer::m_reference
protectedinherited

Holds the reference point for movements.

Definition at line 411 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_winX

int mpInfoLayer::m_winX
protectedinherited

Definition at line 413 of file mathplot.h.

◆ m_winY

int mpInfoLayer::m_winY
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.5 for MRPT 1.4.0 SVN: at Sun Nov 27 02:56:26 UTC 2022