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

Detailed Description

Abstract base class providing plot and labeling functionality for functions F:Y->X.

Override mpProfile::GetX to implement a function. This class is similar to mpFY, but the Plot method is different. The plot is in fact represented by lines instead of points, which gives best rendering of rapidly-varying functions, and in general, data which are not so close one to another. Optionally implement a constructor and pass a name (label) and a label alignment to the constructor mpProfile::mpProfile. If the layer name is empty, no label will be plotted.

Definition at line 653 of file mathplot.h.

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

Inheritance diagram for mpProfile:
Inheritance graph

Public Member Functions

 mpProfile (wxString name=wxEmptyString, int flags=mpALIGN_TOP)
 
virtual double GetY (double x)=0
 Get function value for argument. More...
 
virtual void Plot (wxDC &dc, mpWindow &w)
 Layer plot handler. More...
 
virtual bool HasBBox ()
 Check whether this layer has a bounding box. More...
 
virtual bool IsInfo ()
 Check whether the layer is an info box. 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

int m_flags
 Holds label alignment. More...
 
wxFont m_font
 Layer's font. More...
 
wxPen m_pen
 Layer's pen. More...
 
wxBrush m_brush
 Layer's brush. 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

◆ mpProfile()

mpProfile::mpProfile ( wxString  name = wxEmptyString,
int  flags = mpALIGN_TOP 
)
Parameters
nameLabel
flagsLabel alignment, pass one of mpALIGN_BOTTOM, mpALIGN_CENTER, mpALIGN_TOP.

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.

◆ GetY()

virtual double mpProfile::GetY ( double  x)
pure virtual

Get function value for argument.

Override this function in your implementation.

Parameters
xArgument
Returns
Function value

◆ 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 mpProfile::Plot ( wxDC &  dc,
mpWindow w 
)
virtual

Layer plot handler.

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

Implements mpLayer.

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

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

Holds label alignment.

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




Page generated by Doxygen 1.9.5 for MRPT 1.4.0 SVN: at Tue Dec 27 00:54:45 UTC 2022