Implements an overlay box which shows the mouse coordinates in plot units. More...

#include <mathplot.h>

Inheritance diagram for mpInfoCoords:

Public Member Functions
	mpInfoCoords ()
	Default constructor. More...

	mpInfoCoords (wxRect rect, const wxBrush *brush=wxTRANSPARENT_BRUSH)
	Complete constructor, setting initial rectangle and background brush. More...

	~mpInfoCoords ()
	Default destructor. More...

virtual void	UpdateInfo (mpWindow &w, wxEvent &event) override
	Updates the content of the info box. More...

virtual void	Plot (wxDC &dc, mpWindow &w) override
	Plot method. More...

virtual bool	HasBBox () const override
	mpInfoLayer has not bounding box. More...

virtual bool	IsInfo () const override
	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 () const
	Returns the position of the upper left corner of the box (in pixels) More...

wxSize	GetSize () const
	Returns the size of the box (in pixels) More...

const wxRect &	GetRectangle () const
	Returns the current rectangle coordinates. 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
wxString	m_content

wxRect	m_dim

wxPoint	m_reference

wxBrush	m_brush

int	m_winX

int	m_winY

wxFont	m_font

wxPen	m_pen

wxString	m_name

bool	m_continuous

bool	m_showName

bool	m_drawOutsideMargins

mpLayerType	m_type

bool	m_visible

Detailed Description

Implements an overlay box which shows the mouse coordinates in plot units.

When an mpInfoCoords layer is activated, when mouse is moved over the mpWindow, its coordinates (in mpWindow units, not pixels) are continuously reported inside the layer box.

Definition at line 406 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpInfoCoords() [1/2]

mpInfoCoords::mpInfoCoords ( )

Default constructor.

Definition at line 200 of file mathplot.cpp.

 : mpInfoLayer()
{
}

◆ mpInfoCoords() [2/2]

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

Complete constructor, setting initial rectangle and background brush.

Parameters

rect	The initial bounding rectangle.
brush	The wxBrush to be used for box background: default is transparent

Definition at line 205 of file mathplot.cpp.

 : mpInfoLayer( rect, brush )
{
}

◆ ~mpInfoCoords()

mpInfoCoords::~mpInfoCoords ( )

Default destructor.

Definition at line 210 of file mathplot.cpp.

211{

212}

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; };

mpLayer::m_type

mpLayerType m_type

Definition: mathplot.h:321

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 mpText::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().

◆ GetPosition()

wxPoint mpInfoLayer::GetPosition ( ) const

inherited

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

Returns: The rectangle position

Definition at line 188 of file mathplot.cpp.

{
 return m_dim.GetPosition();
}

References mpInfoLayer::m_dim.

◆ GetRectangle()

const wxRect & mpInfoLayer::GetRectangle ( ) const

inlineinherited

Returns the current rectangle coordinates.

Returns: The info layer rectangle

Definition at line 392 of file mathplot.h.

392{ return m_dim; };

Referenced by mpWindow::OnMouseMove().

◆ GetSize()

wxSize mpInfoLayer::GetSize ( ) const

inherited

Returns the size of the box (in pixels)

Returns: The rectangle size

Definition at line 194 of file mathplot.cpp.

{
 return m_dim.GetSize();
}

References mpInfoLayer::m_dim.

◆ HasBBox()

virtual bool mpInfoLayer::HasBBox ( ) const

inlineoverridevirtualinherited

mpInfoLayer has not bounding box.

See also: mpLayer::HasBBox

Returns: always false

Reimplemented from mpLayer.

Definition at line 357 of file mathplot.h.

357{ return false; }

◆ Inside()

bool mpInfoLayer::Inside ( wxPoint & point )

virtualinherited

Checks whether a point is inside the info box rectangle.

Parameters

point The point to be checked

Returns: true if the point is inside the bounding box

Reimplemented in CURSOR.

Definition at line 127 of file mathplot.cpp.

{
 return m_dim.Contains( point );
}

References mpInfoLayer::m_dim.

Referenced by mpWindow::IsInsideInfoLayer().

◆ IsInfo()

virtual bool mpInfoLayer::IsInfo ( ) const

inlineoverridevirtualinherited

Specifies that this is an Info box layer.

Returns: always true

See also: mpLayer::IsInfo

Reimplemented from mpLayer.

Definition at line 368 of file mathplot.h.

368{ return true; }

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

◆ Move()

void mpInfoLayer::Move ( wxPoint delta )

virtualinherited

Moves the layer rectangle of given pixel deltas.

Parameters

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

Reimplemented in CURSOR.

Definition at line 133 of file mathplot.cpp.

{
 m_dim.SetX( m_reference.x + delta.x );
 m_dim.SetY( m_reference.y + delta.y );
}

References delta, mpInfoLayer::m_dim, and mpInfoLayer::m_reference.

Referenced by CURSOR::Move(), and mpWindow::OnMouseMove().

◆ Plot()

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

overridevirtual

Plot method.

Parameters

dc	the device content where to plot
w	the window to plot

See also: mpLayer::Plot

Reimplemented from mpInfoLayer.

Definition at line 231 of file mathplot.cpp.

{
 if( m_visible )
 {
 // Adjust relative position inside the window
 int scrx = w.GetScrX();
 int scry = w.GetScrY();
 
 if( (m_winX != scrx) || (m_winY != scry) )
 {
  if( m_winX > 1 )
 m_dim.x = (int) floor( (double) (m_dim.x * scrx / m_winX) );
 
 if( m_winY > 1 )
 {
 m_dim.y = (int) floor( (double) (m_dim.y * scry / m_winY) );
 UpdateReference();
 }
 
 // Finally update window size
 m_winX = scrx;
 m_winY = scry;
 }
 
 dc.SetPen( m_pen );
 // wxImage image0(wxT("pixel.png"), wxBITMAP_TYPE_PNG);
 // wxBitmap image1(image0);
 // wxBrush semiWhite(image1);
 dc.SetBrush( m_brush );
 dc.SetFont( m_font );
 int textX, textY;
 dc.GetTextExtent( m_content, &textX, &textY );
 
 if( m_dim.width < textX + 10 )
 m_dim.width = textX + 10;
 
 if( m_dim.height < textY + 10 )
 m_dim.height = textY + 10;
 
 dc.DrawRectangle( m_dim.x, m_dim.y, m_dim.width, m_dim.height );
 dc.DrawText( m_content, m_dim.x + 5, m_dim.y + 5 );
 }
}

References mpWindow::GetScrX(), mpWindow::GetScrY(), mpInfoLayer::m_brush, m_content, mpInfoLayer::m_dim, mpLayer::m_font, mpLayer::m_pen, mpLayer::m_visible, mpInfoLayer::m_winX, mpInfoLayer::m_winY, and mpInfoLayer::UpdateReference().

◆ 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; }

name

const char * name

Definition: DXF_plotter.cpp:56

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

◆ UpdateInfo()

void mpInfoCoords::UpdateInfo	(	mpWindow &	w,
		wxEvent &	event
	)

overridevirtual

Updates the content of the info box.

It is used to update coordinates.

Parameters

w	parent mpWindow from which to obtain information
event	The event which called the update.

Reimplemented from mpInfoLayer.

Definition at line 215 of file mathplot.cpp.

{
 if( event.GetEventType() == wxEVT_MOTION )
 {
 /* It seems that Windows port of wxWidgets don't support multi-line test to be drawn in a wxDC.
 * wxGTK instead works perfectly with it.
 * Info on wxForum: http://wxforum.shadonet.com/viewtopic.php?t=3451&highlight=drawtext+eol */
#ifdef _WINDOWS
 // FIXME m_content.Printf(wxT("x = %f y = %f"), XScale().P2x(w, mouseX), YScale().P2x(w, mouseY));
#else
 // FIXME m_content.Printf(wxT("x = %f\ny = %f"), XScale().P2x(w, mouseX), YScale().P2x(w, mouseY));
#endif
 }
}

◆ UpdateReference()

void mpInfoLayer::UpdateReference ( )

virtualinherited

Updates the rectangle reference point.

Used by internal methods of mpWindow to correctly move mpInfoLayers.

Reimplemented in CURSOR.

Definition at line 140 of file mathplot.cpp.

{
 m_reference.x = m_dim.x;
 m_reference.y = m_dim.y;
}

References mpInfoLayer::m_dim, and mpInfoLayer::m_reference.

Referenced by mpWindow::OnMouseLeftRelease(), mpInfoLayer::Plot(), Plot(), and mpInfoLegend::Plot().

Member Data Documentation

◆ m_brush

wxBrush mpInfoLayer::m_brush

protectedinherited

Definition at line 397 of file mathplot.h.

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

◆ m_content

wxString mpInfoCoords::m_content

protected

Definition at line 431 of file mathplot.h.

Referenced by Plot().

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

wxRect mpInfoLayer::m_dim

protectedinherited

Definition at line 395 of file mathplot.h.

Referenced by mpInfoLayer::GetPosition(), mpInfoLayer::GetSize(), mpInfoLayer::Inside(), mpInfoLayer::Move(), CURSOR::Plot(), mpInfoLayer::Plot(), Plot(), mpInfoLegend::Plot(), and mpInfoLayer::UpdateReference().

◆ 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 Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::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_pen

wxPen mpLayer::m_pen

protectedinherited

Definition at line 315 of file mathplot.h.

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

◆ m_reference

wxPoint mpInfoLayer::m_reference

protectedinherited

Definition at line 396 of file mathplot.h.

Referenced by mpInfoLayer::Move(), mpInfoLayer::mpInfoLayer(), CURSOR::SetX(), mpInfoLayer::UpdateReference(), and CURSOR::UpdateReference().

◆ 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(), Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpProfile::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), mpText::Plot(), mpMovableObject::Plot(), and mpBitmapLayer::Plot().

◆ m_winX

int mpInfoLayer::m_winX

protectedinherited

Definition at line 398 of file mathplot.h.

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

◆ m_winY

int mpInfoLayer::m_winY

protectedinherited

Definition at line 398 of file mathplot.h.

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ mpInfoCoords() [1/2]

◆ mpInfoCoords() [2/2]

◆ ~mpInfoCoords()

Member Function Documentation

◆ GetBrush()

◆ GetColourSquare()

◆ GetContinuity()

◆ GetDrawOutsideMargins()

◆ GetFont()

◆ GetLayerType()

◆ GetMaxX()

◆ GetMaxY()

◆ GetMinX()

◆ GetMinY()

◆ GetName()

◆ GetPen()

◆ GetPosition()

◆ GetRectangle()

◆ GetSize()

◆ HasBBox()

◆ Inside()

◆ IsInfo()

◆ IsVisible()

◆ Move()

◆ Plot()

◆ SetBrush()

◆ SetContinuity()

◆ SetDrawOutsideMargins()

◆ SetFont()

◆ SetName()

◆ SetPen()

◆ SetVisible()

◆ ShowName()

◆ UpdateInfo()

◆ UpdateReference()

Member Data Documentation

◆ m_brush

◆ m_content

◆ m_continuous

◆ m_dim

◆ m_drawOutsideMargins

◆ m_font

◆ m_name

◆ m_pen

◆ m_reference

◆ m_showName

◆ m_type

◆ m_visible

◆ m_winX

◆ m_winY