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

Detailed Description

Plot layer implementing a y-scale ruler.

If align is set to mpALIGN_CENTER, the ruler is fixed at X=0 in the coordinate system. If the align is set to mpALIGN_TOP or mpALIGN_BOTTOM, the axis is always drawn respectively at top or bottom of the window. A label is plotted at the top-right hand of the ruler. The scale numbering automatically adjusts to view and zoom factor.

Definition at line 755 of file mathplot.h.

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

Inheritance diagram for mpScaleY:
Inheritance graph

Public Member Functions

 mpScaleY (wxString name=wxT("Y"), int flags=mpALIGN_CENTER, bool ticks=true)
 
virtual void Plot (wxDC &dc, mpWindow &w)
 Layer plot handler.
 
virtual bool HasBBox ()
 Check whether this layer has a bounding box.
 
void SetAlign (int align)
 Set Y axis alignment.
 
void SetTicks (bool ticks)
 Set Y axis ticks or grid.
 
bool GetTicks ()
 Get Y axis ticks or grid.
 
void SetLabelFormat (const wxString &format)
 Set Y axis Label format.
 
const wxString & SetLabelFormat ()
 Get Y axis Label format.
 
virtual bool IsInfo ()
 Check whether the layer is an info box.
 
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

int m_flags
 Flag for axis alignment.
 
bool m_ticks
 Flag to toggle between ticks or grid.
 
wxString m_labelFormat
 Format string used to print labels.
 
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

◆ mpScaleY()

mpScaleY::mpScaleY ( wxString  name = wxT("Y"),
int  flags = mpALIGN_CENTER,
bool  ticks = true 
)
Parameters
nameLabel to plot by the ruler
flagsSet position of the scale respect to the window.
ticksSelect ticks or grid. Give TRUE (default) for drawing axis ticks, FALSE for drawing the grid

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.

◆ GetTicks()

bool mpScaleY::GetTicks ( )
inline

Get Y axis ticks or grid.

Returns
TRUE if plot is drawing axis ticks, FALSE if the grid is active.

Definition at line 784 of file mathplot.h.

◆ HasBBox()

virtual bool mpScaleY::HasBBox ( )
inlinevirtual

Check whether this layer has a bounding box.

This implementation returns FALSE thus making the ruler invisible to the plot layer bounding box calculation by mpWindow.

Reimplemented from mpLayer.

Definition at line 772 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 mpScaleY::Plot ( wxDC &  dc,
mpWindow w 
)
virtual

Layer plot handler.

This implementation will plot the ruler adjusted to the visible area.

Implements mpLayer.

◆ SetAlign()

void mpScaleY::SetAlign ( int  align)
inline

Set Y axis alignment.

Parameters
alignalignment (choose between mpALIGN_BORDER_LEFT, mpALIGN_LEFT, mpALIGN_CENTER, mpALIGN_RIGHT, mpALIGN_BORDER_RIGHT)

Definition at line 776 of file mathplot.h.

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

◆ SetLabelFormat() [1/2]

const wxString & mpScaleY::SetLabelFormat ( )
inline

Get Y axis Label format.

Returns
The format string

Definition at line 792 of file mathplot.h.

◆ SetLabelFormat() [2/2]

void mpScaleY::SetLabelFormat ( const wxString &  format)
inline

Set Y axis Label format.

Parameters
formatThe format string

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

◆ SetTicks()

void mpScaleY::SetTicks ( bool  ticks)
inline

Set Y axis ticks or grid.

Parameters
ticksTRUE to plot axis ticks, FALSE to plot grid.

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

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 mpScaleY::m_flags
protected

Flag for axis alignment.

Definition at line 795 of file mathplot.h.

◆ m_font

wxFont mpLayer::m_font
protectedinherited

Layer's font.

Definition at line 329 of file mathplot.h.

◆ m_labelFormat

wxString mpScaleY::m_labelFormat
protected

Format string used to print labels.

Definition at line 797 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_ticks

bool mpScaleY::m_ticks
protected

Flag to toggle between ticks or grid.

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




Page generated by Doxygen 1.9.6 for MRPT 1.4.0 SVN: at Wed Mar 22 06:08:57 UTC 2023