This virtual class represents objects that can be moved to an arbitrary 2D location+rotation. More...

#include <mathplot.h>

Inheritance diagram for mpMovableObject:

Public Member Functions
	mpMovableObject ()
	Default constructor (sets location and rotation to (0,0,0)) More...

virtual	~mpMovableObject ()

void	GetCoordinateBase (double &x, double &y, double &phi) const
	Get the current coordinate transformation. More...

void	SetCoordinateBase (double x, double y, double phi=0)
	Set the coordinate transformation (phi in radians, 0 means no rotation). More...

virtual bool	HasBBox () const override
	Check whether this layer has a bounding box. More...

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

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

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

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

virtual void	Plot (wxDC &dc, mpWindow &w) override
	Plot given view of layer to the given device context. More...

void	SetAlign (int align)
	Set label axis alignment. More...

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

const wxString &	GetName () const
	Get layer name. More...

const wxString &	GetDisplayName () const

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

virtual void	SetName (const 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 Member Functions
void	TranslatePoint (double x, double y, double &out_x, double &out_y)
	A method for 2D translation and rotation, using the current transformation stored in m_reference_x,m_reference_y,m_reference_phi. More...

void	ShapeUpdated ()
	Must be called by the descendent class after updating the shape (m_shape_xs/ys), or when the transformation changes. More...

Protected Attributes
int	m_flags

double	m_reference_x
	The coordinates of the object (orientation "phi" is in radians). More...

double	m_reference_y

double	m_reference_phi

std::vector< double >	m_shape_xs
	This contains the object points, in local coordinates (to be transformed by the current transformation). More...

std::vector< double >	m_shape_ys

std::vector< double >	m_trans_shape_xs
	The buffer for the translated & rotated points (to avoid recomputing them with each mpWindow refresh). More...

std::vector< double >	m_trans_shape_ys

double	m_bbox_min_x
	The precomputed bounding box: More...

double	m_bbox_max_x

double	m_bbox_min_y

double	m_bbox_max_y

wxFont	m_font

wxPen	m_pen

wxBrush	m_brush

wxString	m_name

wxString	m_displayName

bool	m_continuous

bool	m_showName

bool	m_drawOutsideMargins

mpLayerType	m_type

bool	m_visible

Detailed Description

This virtual class represents objects that can be moved to an arbitrary 2D location+rotation.

The current transformation is set through SetCoordinateBase. To ease the implementation of descendent classes, mpMovableObject will be in charge of Bounding Box computation and layer rendering, assuming that the object updates its shape in m_shape_xs & m_shape_ys.

Definition at line 1740 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpMovableObject()

mpMovableObject::mpMovableObject ( )

inline

Default constructor (sets location and rotation to (0,0,0))

Definition at line 1745 of file mathplot.h.

References mpLAYER_PLOT.

◆ ~mpMovableObject()

virtual mpMovableObject::~mpMovableObject ( )

inlinevirtual

Definition at line 1760 of file mathplot.h.

Member Function Documentation

◆ GetBrush()

const wxBrush & mpLayer::GetBrush ( ) const

inlineinherited

Get brush set for this layer.

Returns: brush.

Definition at line 315 of file mathplot.h.

◆ 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 76 of file mathplot.cpp.

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

◆ GetCoordinateBase()

void mpMovableObject::GetCoordinateBase	(	double &	x,
		double &	y,
		double &	phi
	)		const

inline

Get the current coordinate transformation.

Definition at line 1764 of file mathplot.h.

◆ GetDisplayName()

const wxString & mpLayer::GetDisplayName ( ) const

inlineinherited

Definition at line 244 of file mathplot.h.

Referenced by mpInfoLegend::Plot().

◆ GetDrawOutsideMargins()

bool mpLayer::GetDrawOutsideMargins ( )

inlineinherited

Get Draw mode: inside or outside margins.

Returns: The draw mode

Definition at line 294 of file mathplot.h.

◆ GetFont()

const wxFont & mpLayer::GetFont ( ) const

inlineinherited

Get font set for this layer.

Returns: Font

Definition at line 252 of file mathplot.h.

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

Referenced by mpInfoLegend::Plot().

◆ GetMaxX()

virtual double mpMovableObject::GetMaxX ( ) const

inlineoverridevirtual

Get inclusive right border of bounding box.

Reimplemented from mpLayer.

Definition at line 1790 of file mathplot.h.

◆ GetMaxY()

virtual double mpMovableObject::GetMaxY ( ) const

inlineoverridevirtual

Get inclusive top border of bounding box.

Reimplemented from mpLayer.

Definition at line 1798 of file mathplot.h.

◆ GetMinX()

virtual double mpMovableObject::GetMinX ( ) const

inlineoverridevirtual

Get inclusive left border of bounding box.

Reimplemented from mpLayer.

Definition at line 1786 of file mathplot.h.

◆ GetMinY()

virtual double mpMovableObject::GetMinY ( ) const

inlineoverridevirtual

Get inclusive bottom border of bounding box.

Reimplemented from mpLayer.

Definition at line 1794 of file mathplot.h.

◆ GetName()

const wxString & mpLayer::GetName ( ) const

inlineinherited

Get layer name.

Returns: Name

Definition at line 242 of file mathplot.h.

Referenced by SIM_PLOT_PANEL::GetLabelX(), SIM_PLOT_PANEL::GetLabelY1(), SIM_PLOT_PANEL::GetLabelY2(), SIM_PLOT_PANEL::GetLabelY3(), mpText::Plot(), and SIMULATOR_FRAME::updateCursors().

◆ GetPen()

const wxPen & mpLayer::GetPen ( ) const

inlineinherited

Get pen set for this layer.

Returns: Pen

Definition at line 257 of file mathplot.h.

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

◆ HasBBox()

virtual bool mpMovableObject::HasBBox ( ) const

inlineoverridevirtual

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

true	Has bounding box
false	Has not bounding box

Reimplemented from mpLayer.

Definition at line 1782 of file mathplot.h.

Referenced by Plot().

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

◆ IsVisible()

bool mpLayer::IsVisible ( ) const

inlineinherited

Checks whether the layer is visible or not.

Returns: true if visible

Definition at line 307 of file mathplot.h.

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

◆ Plot()

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

overridevirtual

Plot given view of layer to the given device context.

An implementation of this function has to transform layer coordinates to wxDC coordinates based on the view parameters retrievable from the mpWindow passed in w. Note that the public methods of mpWindow: x2p,y2p and p2x,p2y are already provided which transform layer coordinates to DC pixel coordinates, and user code should rely on them for portability and future changes to be applied transparently, instead of implementing the following formulas manually.

The passed device context dc has its coordinate origin set to the top-left corner of the visible area (the default). The coordinate orientation is as shown in the following picture:

(wxDC origin 0,0)
x-------------> ascending X ----------------+
|                                           |
|                                           |
|  V ascending Y                            |
|                                           |
|                                           |
|                                           |
|+------------------------------------------+  <-- right-bottom corner of the mpWindow visible area.

Note that Y ascends in downward direction, whereas the usual vertical orientation for mathematical plots is vice versa. Thus Y-orientation will be swapped usually, when transforming between wxDC and mpLayer coordinates. This change of coordinates is taken into account in the methods p2x,p2y,x2p,y2p.

Rules for transformation between mpLayer and wxDC coordinates

dc_X = (layer_X - mpWindow::GetPosX()) * mpWindow::GetScaleX()
dc_Y = (mpWindow::GetPosY() - layer_Y) * mpWindow::GetScaleY() // swapping Y-orientation
 
layer_X = (dc_X / mpWindow::GetScaleX()) + mpWindow::GetPosX() // scale guaranteed to be not 0
layer_Y = mpWindow::GetPosY() - (dc_Y / mpWindow::GetScaleY()) // swapping Y-orientation

Parameters

dc	Device context to plot to.
w	View to plot. The visible area can be retrieved from this object.

See also: mpWindow::p2x,mpWindow::p2y,mpWindow::x2p,mpWindow::y2p

Implements mpLayer.

Definition at line 3189 of file mathplot.cpp.

References mpWindow::GetPosX(), mpWindow::GetPosY(), mpWindow::GetScaleX(), mpWindow::GetScaleY(), mpWindow::GetScrX(), mpWindow::GetScrY(), HasBBox(), m_bbox_max_x, m_bbox_max_y, mpLayer::m_continuous, m_flags, mpLayer::m_font, mpLayer::m_name, mpLayer::m_pen, mpLayer::m_showName, m_trans_shape_xs, m_trans_shape_ys, mpLayer::m_visible, mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGNMASK, mpWindow::x2p(), and mpWindow::y2p().

◆ SetAlign()

void mpMovableObject::SetAlign ( int align )

inline

Set label axis alignment.

Parameters

align alignment (choose between mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGN_SE

Definition at line 1805 of file mathplot.h.

◆ SetBrush()

void mpLayer::SetBrush ( wxBrush brush )

inlineinherited

Set layer brush.

Parameters

brush brush, will be copied to internal class member

Definition at line 319 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 262 of file mathplot.h.

Referenced by TRACE::TRACE().

◆ SetCoordinateBase()

void mpMovableObject::SetCoordinateBase	(	double	x,
		double	y,
		double	phi = `0`
	)

inline

Set the coordinate transformation (phi in radians, 0 means no rotation).

Definition at line 1773 of file mathplot.h.

References mpALIGN_NE.

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

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

◆ SetName()

virtual void mpLayer::SetName ( const wxString & name )

inlinevirtualinherited

Set layer name.

Parameters

name	Name, will be copied to internal class member

Reimplemented in TRACE.

Definition at line 276 of file mathplot.h.

References name.

Referenced by SIM_PLOT_PANEL::prepareDCAxes(), TRACE::SetName(), and SIM_PLOT_PANEL::updateAxes().

◆ SetPen()

void mpLayer::SetPen ( wxPen pen )

inlineinherited

Set layer pen.

Parameters

pen	Pen, will be copied to internal class member

Definition at line 286 of file mathplot.h.

Referenced by SIM_PLOT_PANEL::UpdateTraceStyle().

◆ SetVisible()

void mpLayer::SetVisible ( bool show )

inlineinherited

Sets layer visibility.

Parameters

show	visibility bool.

Definition at line 311 of file mathplot.h.

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

◆ ShapeUpdated()

void mpMovableObject::ShapeUpdated ( )

protected

Must be called by the descendent class after updating the shape (m_shape_xs/ys), or when the transformation changes.

This method updates the buffers m_trans_shape_xs/ys, and the precomputed bounding box.

Definition at line 3143 of file mathplot.cpp.

References m_bbox_max_x, m_bbox_max_y, m_bbox_min_x, m_bbox_min_y, m_reference_phi, m_reference_x, m_reference_y, m_shape_xs, m_shape_ys, m_trans_shape_xs, and m_trans_shape_ys.

Referenced by mpCovarianceEllipse::RecalculateShape(), and mpPolygon::setPoints().

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

Referenced by TRACE::TRACE().

◆ TranslatePoint()

void mpMovableObject::TranslatePoint	(	double	x,
		double	y,
		double &	out_x,
		double &	out_y
	)

protected

A method for 2D translation and rotation, using the current transformation stored in m_reference_x,m_reference_y,m_reference_phi.

Definition at line 3132 of file mathplot.cpp.

References m_reference_phi, m_reference_x, and m_reference_y.

Member Data Documentation

◆ m_bbox_max_x

double mpMovableObject::m_bbox_max_x

protected

Definition at line 1832 of file mathplot.h.

Referenced by Plot(), and ShapeUpdated().

◆ m_bbox_max_y

double mpMovableObject::m_bbox_max_y

protected

Definition at line 1832 of file mathplot.h.

Referenced by Plot(), and ShapeUpdated().

◆ m_bbox_min_x

double mpMovableObject::m_bbox_min_x

protected

The precomputed bounding box:

See also: ShapeUpdated

Definition at line 1832 of file mathplot.h.

Referenced by ShapeUpdated().

◆ m_bbox_min_y

double mpMovableObject::m_bbox_min_y

protected

Definition at line 1832 of file mathplot.h.

Referenced by ShapeUpdated().

◆ m_brush

wxBrush mpLayer::m_brush

protectedinherited

Definition at line 325 of file mathplot.h.

◆ m_continuous

bool mpLayer::m_continuous

protectedinherited

Definition at line 328 of file mathplot.h.

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

◆ m_displayName

wxString mpLayer::m_displayName

protectedinherited

Definition at line 327 of file mathplot.h.

Referenced by TRACE::SetName().

◆ m_drawOutsideMargins

bool mpLayer::m_drawOutsideMargins

protectedinherited

Definition at line 330 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_flags

int mpMovableObject::m_flags

protected

Definition at line 1808 of file mathplot.h.

Referenced by Plot().

◆ m_font

wxFont mpLayer::m_font

protectedinherited

Definition at line 323 of file mathplot.h.

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

◆ m_name

wxString mpLayer::m_name

protectedinherited

Definition at line 326 of file mathplot.h.

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

◆ m_pen

wxPen mpLayer::m_pen

protectedinherited

Definition at line 324 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(), mpText::Plot(), and Plot().

◆ m_reference_phi

double mpMovableObject::m_reference_phi

protected

Definition at line 1812 of file mathplot.h.

Referenced by ShapeUpdated(), and TranslatePoint().

◆ m_reference_x

double mpMovableObject::m_reference_x

protected

The coordinates of the object (orientation "phi" is in radians).

Definition at line 1812 of file mathplot.h.

Referenced by ShapeUpdated(), and TranslatePoint().

◆ m_reference_y

double mpMovableObject::m_reference_y

protected

Definition at line 1812 of file mathplot.h.

Referenced by ShapeUpdated(), and TranslatePoint().

◆ m_shape_xs

std::vector<double> mpMovableObject::m_shape_xs

protected

This contains the object points, in local coordinates (to be transformed by the current transformation).

Definition at line 1822 of file mathplot.h.

Referenced by mpCovarianceEllipse::RecalculateShape(), mpPolygon::setPoints(), and ShapeUpdated().

◆ m_shape_ys

std::vector<double> mpMovableObject::m_shape_ys

protected

Definition at line 1822 of file mathplot.h.

Referenced by mpCovarianceEllipse::RecalculateShape(), mpPolygon::setPoints(), and ShapeUpdated().

◆ m_showName

bool mpLayer::m_showName

protectedinherited

Definition at line 329 of file mathplot.h.

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

◆ m_trans_shape_xs

std::vector<double> mpMovableObject::m_trans_shape_xs

protected

The buffer for the translated & rotated points (to avoid recomputing them with each mpWindow refresh).

Definition at line 1827 of file mathplot.h.

Referenced by Plot(), and ShapeUpdated().

◆ m_trans_shape_ys

std::vector<double> mpMovableObject::m_trans_shape_ys

protected

Definition at line 1827 of file mathplot.h.

Referenced by Plot(), and ShapeUpdated().

◆ m_type

mpLayerType mpLayer::m_type

protectedinherited

Definition at line 331 of file mathplot.h.

Referenced by mpInfoLayer::mpInfoLayer().

◆ m_visible

bool mpLayer::m_visible

protectedinherited

Definition at line 332 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(), mpText::Plot(), Plot(), and mpBitmapLayer::Plot().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ mpMovableObject()

◆ ~mpMovableObject()

Member Function Documentation

◆ GetBrush()

◆ GetColourSquare()

◆ GetContinuity()

◆ GetCoordinateBase()

◆ GetDisplayName()

◆ GetDrawOutsideMargins()

◆ GetFont()

◆ GetLayerType()

◆ GetMaxX()

◆ GetMaxY()

◆ GetMinX()

◆ GetMinY()

◆ GetName()

◆ GetPen()

◆ HasBBox()

◆ IsInfo()

◆ IsVisible()

◆ Plot()

◆ SetAlign()

◆ SetBrush()

◆ SetContinuity()

◆ SetCoordinateBase()

◆ SetDrawOutsideMargins()

◆ SetFont()

◆ SetName()

◆ SetPen()

◆ SetVisible()

◆ ShapeUpdated()

◆ ShowName()

◆ TranslatePoint()

Member Data Documentation

◆ m_bbox_max_x

◆ m_bbox_max_y

◆ m_bbox_min_x

◆ m_bbox_min_y

◆ m_brush

◆ m_continuous

◆ m_displayName

◆ m_drawOutsideMargins

◆ m_flags

◆ m_font

◆ m_name

◆ m_pen

◆ m_reference_phi

◆ m_reference_x

◆ m_reference_y

◆ m_shape_xs

◆ m_shape_ys

◆ m_showName

◆ m_trans_shape_xs

◆ m_trans_shape_ys

◆ m_type

◆ m_visible