Plot layer implementing a text string. More...

#include <mathplot.h>

Inheritance diagram for mpText:

Public Member Functions
	mpText (const wxString &name=wxT("Title"), int offsetx=5, int offsety=50)

virtual void	Plot (wxDC &dc, mpWindow &w) override
	Text Layer plot handler. More...

virtual bool	HasBBox () const override
	mpText should not be used for scaling decisions. More...

virtual bool	IsInfo () const
	Check whether the layer is an info box. More...

virtual double	GetMinX () const
	Get inclusive left border of bounding box. More...

virtual double	GetMaxX () const
	Get inclusive right border of bounding box. More...

virtual double	GetMinY () const
	Get inclusive bottom border of bounding box. More...

virtual double	GetMaxY () const
	Get inclusive top border of bounding box. More...

const 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) const
	Get a small square bitmap filled with the colour of the pen used in the layer. More...

mpLayerType	GetLayerType () const
	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 () const
	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_offsetx

int	m_offsety

wxFont	m_font

wxPen	m_pen

wxBrush	m_brush

wxString	m_name

bool	m_continuous

bool	m_showName

bool	m_drawOutsideMargins

mpLayerType	m_type

bool	m_visible

Detailed Description

Plot layer implementing a text string.

The text is plotted using a percentage system 0-100%, so the actual coordinates for the location are not required, and the text stays on the plot regardless of the other layers location and scaling factors.

Definition at line 1671 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpText()

mpText::mpText	(	const wxString &	name = `wxT("Title")`,
		int	offsetx = `5`,
		int	offsety = `50`
	)

Parameters

name	text to be drawn in the plot
offsetx	holds offset for the X location in percentage (0-100)
offsety	holds offset for the Y location in percentage (0-100)
name	text to be displayed
offsetx	x position in percentage (0-100)
offsetx	y position in percentage (0-100)

Definition at line 2971 of file mathplot.cpp.

{
 SetName( name );
 
 if( offsetx >= 0 && offsetx <= 100 )
 m_offsetx = offsetx;
 else
  m_offsetx = 5;
 
 if( offsety >= 0 && offsety <= 100 )
 m_offsety = offsety;
 else
 m_offsety = 50;
 
 m_type = mpLAYER_INFO;
}

References mpLAYER_INFO, and name.

Member Function Documentation

◆ GetBrush()

const wxBrush & mpLayer::GetBrush ( ) const

inlineinherited

Get brush set for this layer.

Returns: brush.

Definition at line 306 of file mathplot.h.

306{ return m_brush; };

mpLayer::m_brush

wxBrush m_brush

Definition: mathplot.h:316

◆ GetColourSquare()

wxBitmap mpLayer::GetColourSquare ( int side = 16 ) const

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

side	side length in pixels

Returns: a wxBitmap filled with layer's colour

Definition at line 75 of file mathplot.cpp.

{
 wxBitmap square( side, side, -1 );
 wxColour filler = m_pen.GetColour();
 wxBrush brush( filler, wxBRUSHSTYLE_SOLID );
 wxMemoryDC dc;
 
 dc.SelectObject( square );
 dc.SetBackground( brush );
 dc.Clear();
 dc.SelectObject( wxNullBitmap );
 return square;
}

References mpLayer::m_pen, and square().

◆ GetContinuity()

bool mpLayer::GetContinuity ( ) const

inlineinherited

Gets the 'continuity' property of the layer.

See also: SetContinuity

Definition at line 258 of file mathplot.h.

258{ return m_continuous; }

mpLayer::m_continuous

bool m_continuous

Definition: mathplot.h:318

◆ GetDrawOutsideMargins()

bool mpLayer::GetDrawOutsideMargins ( )

inlineinherited

Get Draw mode: inside or outside margins.

Returns: The draw mode

Definition at line 285 of file mathplot.h.

285{ return m_drawOutsideMargins; };

mpLayer::m_drawOutsideMargins

bool m_drawOutsideMargins

Definition: mathplot.h:320

◆ GetFont()

const wxFont & mpLayer::GetFont ( ) const

inlineinherited

Get font set for this layer.

Returns: Font

Definition at line 243 of file mathplot.h.

243{ return m_font; }

mpLayer::m_font

wxFont m_font

Definition: mathplot.h:314

◆ GetLayerType()

mpLayerType mpLayer::GetLayerType ( ) const

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 294 of file mathplot.h.

294{ return m_type; };

Referenced by mpInfoLegend::Plot().

◆ GetMaxX()

virtual double mpLayer::GetMaxX ( ) const

inlinevirtualinherited

Get inclusive right border of bounding box.

Returns: Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 180 of file mathplot.h.

180{ return 1.0; }

Referenced by mpFXY::UpdateScales().

◆ GetMaxY()

virtual double mpLayer::GetMaxY ( ) const

inlinevirtualinherited

Get inclusive top border of bounding box.

Returns: Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 190 of file mathplot.h.

190{ return 1.0; }

Referenced by mpFXY::UpdateScales().

◆ GetMinX()

virtual double mpLayer::GetMinX ( ) const

inlinevirtualinherited

Get inclusive left border of bounding box.

Returns: Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 175 of file mathplot.h.

175{ return -1.0; }

Referenced by mpFXY::UpdateScales().

◆ GetMinY()

virtual double mpLayer::GetMinY ( ) const

inlinevirtualinherited

Get inclusive bottom border of bounding box.

Returns: Value

Reimplemented in mpFXYVector, mpMovableObject, and mpBitmapLayer.

Definition at line 185 of file mathplot.h.

185{ return -1.0; }

Referenced by mpFXY::UpdateScales().

◆ GetName()

const wxString & mpLayer::GetName ( void ) const

inlineinherited

Get layer name.

Returns: Name

Definition at line 238 of file mathplot.h.

238{ return m_name; }

mpLayer::m_name

wxString m_name

Definition: mathplot.h:317

Referenced by SIM_PLOT_PANEL::GetLabelX(), SIM_PLOT_PANEL::GetLabelY1(), SIM_PLOT_PANEL::GetLabelY2(), mpInfoLegend::Plot(), and Plot().

◆ GetPen()

const wxPen & mpLayer::GetPen ( ) const

inlineinherited

Get pen set for this layer.

Returns: Pen

Definition at line 248 of file mathplot.h.

248{ return m_pen; }

Referenced by CURSOR::Plot(), and mpInfoLegend::Plot().

◆ HasBBox()

virtual bool mpText::HasBBox ( ) const

inlineoverridevirtual

mpText should not be used for scaling decisions.

Reimplemented from mpLayer.

Definition at line 1684 of file mathplot.h.

1684{ return false; }

◆ IsInfo()

virtual bool mpLayer::IsInfo ( ) const

inlinevirtualinherited

Check whether the layer is an info box.

The default implementation returns false. It is overridden 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 170 of file mathplot.h.

170{ return false; };

◆ IsVisible()

bool mpLayer::IsVisible ( ) const

inlineinherited

Checks whether the layer is visible or not.

Returns: true if visible

Definition at line 298 of file mathplot.h.

298{ return m_visible; };

mpLayer::m_visible

bool m_visible

Definition: mathplot.h:322

Referenced by mpWindow::IsLayerVisible(), SIM_PLOT_PANEL::IsLegendShown(), and mpInfoLegend::Plot().

◆ Plot()

void mpText::Plot	(	wxDC &	dc,
		mpWindow &	w
	)

overridevirtual

Text Layer plot handler.

mpText Layer plot handler.

This implementation will plot text adjusted to the visible area.

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

Implements mpLayer.

Definition at line 2993 of file mathplot.cpp.

{
 if( m_visible )
 {
 dc.SetPen( m_pen );
 dc.SetFont( m_font );
 
 wxCoord tw = 0, th = 0;
 dc.GetTextExtent( GetName(), &tw, &th );
 
 // int left = -dc.LogicalToDeviceX(0);
 // int width = dc.LogicalToDeviceX(0) - left;
 // int bottom = dc.LogicalToDeviceY(0);
 // int height = bottom - -dc.LogicalToDeviceY(0);
 
 /* dc.DrawText( GetName(),
 * (int)((((float)width/100.0) * m_offsety) + left - (tw/2)),
 * (int)((((float)height/100.0) * m_offsetx) - bottom) );*/
 int px = m_offsetx * ( w.GetScrX() - w.GetMarginLeft() - w.GetMarginRight() ) / 100;
 int py = m_offsety * ( w.GetScrY() - w.GetMarginTop() - w.GetMarginBottom() ) / 100;
 dc.DrawText( GetName(), px, py );
 }
}

References mpWindow::GetMarginBottom(), mpWindow::GetMarginLeft(), mpWindow::GetMarginRight(), mpWindow::GetMarginTop(), mpLayer::GetName(), mpWindow::GetScrX(), mpWindow::GetScrY(), mpLayer::m_font, m_offsetx, m_offsety, mpLayer::m_pen, and mpLayer::m_visible.

◆ SetBrush()

void mpLayer::SetBrush ( wxBrush brush )

inlineinherited

Set layer brush.

Parameters

brush brush, will be copied to internal class member

Definition at line 310 of file mathplot.h.

310{ m_brush = brush; };

◆ 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 253 of file mathplot.h.

253{ m_continuous = continuity; }

Referenced by TRACE::TRACE().

◆ 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

drawModeOutside The draw mode to be set

Definition at line 281 of file mathplot.h.

281{ m_drawOutsideMargins = drawModeOutside; };

Referenced by CURSOR::CURSOR(), and TRACE::TRACE().

◆ SetFont()

void mpLayer::SetFont ( wxFont & font )

inlineinherited

Set layer font.

Parameters

font	Font, will be copied to internal class member

Definition at line 272 of file mathplot.h.

272{ m_font = font; }

◆ SetName()

void mpLayer::SetName ( wxString name )

inlineinherited

Set layer name.

Parameters

name	Name, will be copied to internal class member

Definition at line 267 of file mathplot.h.

267{ m_name = name; }

References name.

◆ SetPen()

void mpLayer::SetPen ( wxPen pen )

inlineinherited

Set layer pen.

Parameters

pen	Pen, will be copied to internal class member

Definition at line 277 of file mathplot.h.

277{ m_pen = pen; }

Referenced by SIM_PLOT_PANEL::EnableCursor(), and SIM_PLOT_PANEL::UpdateTraceStyle().

◆ SetVisible()

void mpLayer::SetVisible ( bool show )

inlineinherited

Sets layer visibility.

Parameters

show	visibility bool.

Definition at line 302 of file mathplot.h.

302{ m_visible = show; };

Referenced by mpWindow::SetLayerVisible(), SIM_PLOT_PANEL::ShowLegend(), and SIM_PLOT_PANEL::SIM_PLOT_PANEL().

◆ 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 262 of file mathplot.h.

262{ m_showName = show; };

mpLayer::m_showName

bool m_showName

Definition: mathplot.h:319

Referenced by TRACE::TRACE().

Member Data Documentation

◆ m_brush

wxBrush mpLayer::m_brush

protectedinherited

Definition at line 316 of file mathplot.h.

◆ m_continuous

bool mpLayer::m_continuous

protectedinherited

Definition at line 318 of file mathplot.h.

Referenced by CURSOR::Plot(), mpFXY::Plot(), and mpMovableObject::Plot().

◆ m_drawOutsideMargins

bool mpLayer::m_drawOutsideMargins

protectedinherited

Definition at line 320 of file mathplot.h.

Referenced by mpScaleXBase::getVisibleDataRange(), mpScaleY::getVisibleDataRange(), CURSOR::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().

◆ m_font

wxFont mpLayer::m_font

protectedinherited

Definition at line 314 of file mathplot.h.

Referenced by mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

◆ m_name

wxString mpLayer::m_name

protectedinherited

Definition at line 317 of file mathplot.h.

Referenced by mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

◆ m_offsetx

int mpText::m_offsetx

protected

Definition at line 1687 of file mathplot.h.

Referenced by Plot().

◆ m_offsety

int mpText::m_offsety

protected

Definition at line 1688 of file mathplot.h.

Referenced by Plot().

◆ m_pen

wxPen mpLayer::m_pen

protectedinherited

Definition at line 315 of file mathplot.h.

Referenced by mpLayer::GetColourSquare(), mpInfoLayer::Plot(), mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), Plot(), and mpMovableObject::Plot().

◆ m_showName

bool mpLayer::m_showName

protectedinherited

Definition at line 319 of file mathplot.h.

Referenced by mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

◆ m_type

mpLayerType mpLayer::m_type

protectedinherited

Definition at line 321 of file mathplot.h.

Referenced by mpInfoLayer::mpInfoLayer().

◆ m_visible

bool mpLayer::m_visible

protectedinherited

Definition at line 322 of file mathplot.h.

Referenced by CURSOR::Plot(), mpInfoLayer::Plot(), mpInfoCoords::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

The documentation for this class was generated from the following files:

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ mpText()

Member Function Documentation

◆ GetBrush()

◆ GetColourSquare()

◆ GetContinuity()

◆ GetDrawOutsideMargins()

◆ GetFont()

◆ GetLayerType()

◆ GetMaxX()

◆ GetMaxY()

◆ GetMinX()

◆ GetMinY()

◆ GetName()

◆ GetPen()

◆ HasBBox()

◆ IsInfo()

◆ IsVisible()

◆ Plot()

◆ SetBrush()

◆ SetContinuity()

◆ SetDrawOutsideMargins()

◆ SetFont()

◆ SetName()

◆ SetPen()

◆ SetVisible()

◆ ShowName()

Member Data Documentation

◆ m_brush

◆ m_continuous

◆ m_drawOutsideMargins

◆ m_font

◆ m_name

◆ m_offsetx

◆ m_offsety

◆ m_pen

◆ m_showName

◆ m_type

◆ m_visible