Canvas for plotting mpLayer implementations. More...

#include <mathplot.h>

Inheritance diagram for mpWindow:

Collaboration diagram for mpWindow:

Public Member Functions
	mpWindow (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long flags=0)
	Construct a plotting window. More...

wxMenu *	GetPopupMenu ()
	Get reference to context menu of the plot canvas. More...

bool	AddLayer (mpLayer *layer, bool refreshDisplay=true, bool refreshConfig=true)
	Add a plot layer to the canvas. More...

bool	DelLayer (mpLayer *layer, mpDeleteAction alsoDeleteObject, bool refreshDisplay=true, bool refreshConfig=true)
	Remove a plot layer from the canvas. More...

void	DelAllLayers (mpDeleteAction alsoDeleteObject, bool refreshDisplay=true)
	Remove all layers from the plot. More...

void	DelAllPlot (mpDeleteAction alsoDeleteObject, mpFunctionType func=mpfAllType, bool refreshDisplay=true)
	Remove all plot layers. More...

void	DelAllYAxisAfterID (mpDeleteAction alsoDeleteObject, int yAxisID=0, bool refreshDisplay=true)
	Remove all extra y axis after the selected y axis. More...

mpLayer *	GetLayer (int position)

int	GetLayerPosition (mpLayer *layer)

mpLayer *	GetLayersType (int position, mpLayerType type)

mpLayer *	GetLayerPlot (int position, mpFunctionType func=mpfAllType)

mpScale *	GetLayerAxis (int position, mpScaleType scale=mpsAllType)

mpFXYVector *	GetXYSeries (unsigned int n, const wxString &name=_T("Serie "), bool create=true)

mpLayer *	GetClosestPlot (wxCoord ix, wxCoord iy, double xnear, double ynear)

mpLayer *	GetLayerByName (const wxString &name)

mpLayer *	GetLayerByClassName (const wxString &name)

void	RefreshLegend (void)

bool	IsYAxisUsed (int yAxisID)

mpScaleX *	GetLayerXAxis ()
	Get the first scale X layer (X axis) or NULL if not found. More...

mpScaleY *	GetLayerYAxis (int yAxisID)
	Get the scale Y layer (Y axis) with a specific yAxisID or NULL if not found. More...

void	SetScaleX (const double scaleX)
	Set current view's X scale and refresh display. More...

double	GetScaleX (void) const
	Get current view's X scale. More...

void	SetScaleY (const double scaleY, int yAxisID)
	Set current view's Y scale and refresh display. More...

double	GetScaleY (int yAxisID)
	Get current view's Y scale. More...

void	SetBound ()
	Update bound for mpFX and mpFY when axis is scaled. More...

mpRange< double >	GetBoundX (void) const
	Get bounding box for X axis. More...

mpRange< double >	GetDesiredBoundX (void) const
	Get desired bounding box for X axis. More...

mpRange< double >	GetBoundY (int yAxisID)
	Get bounding box for Y axis of ID yAxisID. More...

mpRange< double >	GetDesiredBoundY (int yAxisID)
	Get desired bounding box for Y axis of ID yAxisID. More...

std::unordered_map< int, mpRange< double > >	GetAllBoundY ()
	Returns the bounds for all Y-axes. More...

std::unordered_map< int, mpRange< double > >	GetAllDesiredY ()
	Returns the desired bounds for all Y-axes. More...

void	SetPosX (const double posX)
	Set current view's X position and refresh display. More...

double	GetPosX (void) const
	Get current view's X position. More...

void	SetPosY (std::unordered_map< int, double > &posYList)
	Set current view's Y position and refresh display. More...

double	GetPosY (int yAxisID)
	Get current view's Y position. More...

int	GetNOfYAxis (void) const
	Get the number of Y axis. More...

mpAxisList	GetAxisDataYList (void) const
	Get the Y-axis data map. More...

std::map< int, mpAxisData >	GetSortedAxisDataYList (void) const
	Get a sorted version of the Y-axis data map. More...

void	SetScreen (const int scrX, const int scrY)
	Set current view's dimensions in device context units. More...

int	GetScreenX (void) const
	Get current view's X dimension in device context units. More...

int	GetScreenY (void) const
	Get current view's Y dimension in device context units. More...

void	SetPos (const double posX, std::unordered_map< int, double > &posYList)
	Set current view's X and Y position and refresh display. More...

double	p2x (const wxCoord pixelCoordX) const
	Converts mpWindow (screen) pixel coordinates into graph (floating point) coordinates, using current mpWindow position and scale. More...

double	p2y (const wxCoord pixelCoordY, int yAxisID=0)
	Converts mpWindow (screen) pixel coordinates into graph (floating point) coordinates, using current mpWindow position and scale. More...

wxCoord	x2p (const double x) const
	Converts graph (floating point) coordinates into mpWindow (screen) pixel coordinates, using current mpWindow position and scale. More...

wxCoord	y2p (const double y, int yAxisID=0)
	Converts graph (floating point) coordinates into mpWindow (screen) pixel coordinates, using current mpWindow position and scale. More...

void	EnableDoubleBuffer (const bool enabled)
	Enable/disable the double-buffering of the window, eliminating the flicker (default=enabled).

void	EnableMousePanZoom (const bool enabled)
	Enable/disable the feature of pan/zoom with the mouse (default=enabled)

void	LockAspect (bool enable=true)
	Enable or disable X/Y scale aspect locking for the view. More...

bool	IsAspectLocked () const
	Checks whether the X/Y scale aspect is locked. More...

bool	IsRepainting () const
	Checks if we are repainting. More...

void	Fit ()
	Set view to fit global bounding box of all plot layers and refresh display with UpdateAll(). More...

void	Fit (const mpRange< double > &rangeX, std::unordered_map< int, mpRange< double >> rangeY, wxCoord printSizeX=NULL, wxCoord printSizeY=NULL)
	Set view to fit a given bounding box and refresh display with UpdateAll(). More...

void	FitX (void)
	Similar to Fit() but only fit in X. More...

void	FitY (int yAxisID)
	Similar to Fit() but only fit in Y and only one Y-axis, specified by ID. More...

void	ZoomIn (const wxPoint &centerPoint=wxDefaultPosition)
	Zoom into current view and refresh display. More...

void	ZoomOut (const wxPoint &centerPoint=wxDefaultPosition)
	Zoom out current view and refresh display. More...

void	ZoomInX ()
	Zoom in current view along X around center and refresh display.

void	ZoomOutX ()
	Zoom out current view along X around center and refresh display.

void	ZoomInY (mpOptional_int yAxisID=-1)
	Zoom in current view along Y around center and refresh display. More...

void	ZoomOutY (mpOptional_int yAxisID=-1)
	Zoom out current view along Y around center and refresh display. More...

void	ZoomRect (wxPoint p0, wxPoint p1)
	Zoom view fitting given coordinates to the window (p0 and p1 do not need to be in any specific order) More...

void	UpdateAll ()
	Refresh display.

unsigned int	CountLayers ()
	Counts the number of plot layers, including axes: this is to count only the layers which have a bounding box. More...

unsigned int	CountAllLayers ()
	Counts the number of plot layers, whether or not they have a bounding box. More...

unsigned int	CountLayersType (mpLayerType type)
	Counts the number of plot layers: this is to count only the layers which have a plot. More...

unsigned int	CountLayersFXYPlot ()
	Counts the number of XY plot layers. More...

void	UpdateDesiredBoundingBox (mpAxisUpdate update)
	Update m_desired bounds. More...

mpFloatRectSimple	GetBoundingBox (bool desired, unsigned int yAxisID=0)
	Return a bounding box for an y-axis ID. More...

double	GetDesiredXmin () const
	Returns the left-border layer coordinate that the user wants the mpWindow to show (it may be not exactly the actual shown coordinate in the case of locked aspect ratio). More...

double	GetDesiredXmax () const
	Return the right-border layer coordinate that the user wants the mpWindow to show (it may be not exactly the actual shown coordinate in the case of locked aspect ratio). More...

double	GetDesiredYmin (int yAxisID)
	Return the bottom-border layer coordinate that the user wants the mpWindow to show (it may be not exactly the actual shown coordinate in the case of locked aspect ratio). More...

double	GetDesiredYmax (int yAxisID)
	Return the top layer-border coordinate that the user wants the mpWindow to show (it may be not exactly the actual shown coordinate in the case of locked aspect ratio). More...

bool	GetBoundingBox (mpRange< double > boundX, mpRange< double > boundY, int yAxisID)
	Return the bounding box coordinates for the Y axis of ID yAxisID.

bool	PointIsInsideBound (double px, double py, int yAxisID)
	Is the given point inside the current bounding box for the selected Y axis?

void	UpdateBoundingBoxToInclude (double px, double py, int yAxisID)
	Ensure the bounding box includes the given point for the selected Y axis. More...

void	InitializeBoundingBox (double px, double py, int yAxisID)
	Initialize the bounding box from a first point for the selected Y axis.

void	SetMPScrollbars (bool status)
	Enable/disable scrollbars. More...

bool	GetMPScrollbars () const
	Get scrollbars status. More...

bool	SaveScreenshot (const wxString &filename, int type=wxBITMAP_TYPE_BMP, wxSize imageSize=wxDefaultSize, bool fit=false)
	Draw the window on a wxBitmap, then save it to a file. More...

wxBitmap *	BitmapScreenshot (wxSize imageSize=wxDefaultSize, bool fit=false)
	Get a screen shot of the window plot.

void	ClipboardScreenshot (wxSize imageSize=wxDefaultSize, bool fit=false)
	Send the screen shot to the Clipboard.

void	SetWildcard (const wxString &wildcard)
	Set wildcard for LoadFile() function when we use wxFileDialog.

const wxString &	GetWildcard (void) const
	Get wildcard.

bool	LoadFile (const wxString &filename=wxEmptyString)
	Load a data file like a csv file Data must be formatted in 2 or more columns. More...

void	SetDefaultDir (const wxString &dirname)
	Set the default directory for wxFileDialog. More...

void	SetMargins (int top, int right, int bottom, int left)
	Set window margins, creating a blank area where some kinds of layers cannot draw. More...

void	UpdateMargins ()
	Update margins if e.g. More...

void	SetMarginTop (int top)
	Set the top margin. More...

int	GetMarginTop (bool minusExtra=false) const
	Get the top margin. More...

void	SetMarginRight (int right)
	Set the right margin. More...

int	GetMarginRight (bool minusExtra=false) const
	Get the right margin. More...

int	GetMarginRightOuter () const
	Get the right outer margin, exluding Y-axis. More...

void	SetMarginBottom (int bottom)
	Set the bottom margin. More...

int	GetMarginBottom (bool minusExtra=false) const
	Get the bottom margin. More...

void	SetMarginLeft (int left)
	Set the left margin. More...

int	GetMarginLeft (bool minusExtra=false) const
	Get the left margin. More...

void	SetExtraMargin (int extra)
	Set the extra margin. More...

int	GetExtraMargin () const
	Get the extra margin. More...

int	GetMarginLeftOuter () const
	Get the left outer margin, exluding Y-axis. More...

int	GetPlotWidth () const
	Get the width of the plot. More...

int	GetPlotHeight () const
	Get the height of the plot. More...

mpRect	GetPlotBoundaries (bool with_margin) const
	Get the boundaries of the plot. More...

int	GetLeftYAxesWidth (mpOptional_int yAxisID=-1)
	Calculate width of all axes to the left of this axis. More...

int	GetRightYAxesWidth (mpOptional_int yAxisID=-1)
	Calculate width of all axes to the right of this axis. More...

void	SetDrawBox (bool drawbox)
	Set the draw of the box around the plot. More...

bool	GetDrawBox () const
	Get the draw of the box around the plot. More...

mpOptional_int	IsInsideYAxis (const wxPoint &point)
	Check if a given point is inside the area of a visible Y-axis and returns its ID if so. More...

mpInfoLayer *	IsInsideInfoLayer (const wxPoint &point)
	Check if a given point is inside the area of a mpInfoLayer and eventually returns its pointer. More...

void	SetLayerVisible (const wxString &name, bool viewable)
	Sets the visibility of a layer by its name. More...

bool	IsLayerVisible (const wxString &name)
	Check whether a layer with given name is visible. More...

bool	IsLayerVisible (const unsigned int position)
	Check whether the layer at given position is visible. More...

void	SetLayerVisible (const unsigned int position, bool viewable)
	Sets the visibility of a layer by its position in layer list. More...

void	SetColourTheme (const wxColour &bgColour, const wxColour &drawColour, const wxColour &axesColour)
	Set Color theme. More...

const wxColour &	GetAxesColour () const
	Get axes draw colour. More...

const wxColour &	GetbgColour () const
	Get the plot background colour.

void	SetbgColour (const wxColour &colour)
	Set the plot background colour.

void	SetOnDeleteLayer (const mpOnDeleteLayer &event)
	On delete layer event Allows the user to perform certain actions before deleting the layer. More...

void	UnSetOnDeleteLayer ()
	Remove the 'delete layer event' callback.

void	SetOnUserMouseAction (const mpOnUserMouseAction &userMouseEventHandler)
	On user mouse action event Allows the user to perform certain actions before normal event processing. More...

void	UnSetOnUserMouseAction ()
	Remove the 'user mouse action event' callback.

bool	IsLogXaxis ()
	Is this an X axis to be displayed with log scale? It is really an axis property but as we need to control the bound and the scale, it is easiest and faster to declare this property here.

bool	IsLogYaxis (int yAxisID)
	Get the log property (true or false) Y layer (Y axis) with a specific Y ID or false if not found.

void	SetLogXaxis (bool log)
	Enable or disable logarithmic scaling on the X axis.

void	SetLogYaxis (int yAxisID, bool log)
	Set the log property (true or false) for a Y layer (Y axis) given by is ID.

bool	GetMagnetize () const
	Is mouse magnetization enabled? Useful to read the position on the axes.

void	SetMagnetize (bool mag)
	Enable or disable mouse-position magnet lines (cross-hairs) in the plot area.

void	SetMouseLeftDownAction (mpMouseButtonAction action)
	Set the type of action for the left mouse button. More...

mpMouseButtonAction	GetMouseLeftDownAction ()
	Returns the type of action for the left mouse button. More...

Static Public Attributes
static double	m_zoomIncrementalFactor = 1.5
	This value sets the zoom steps whenever the user clicks "Zoom in/out" or performs zoom with the mouse wheel. More...

Protected Member Functions
virtual void	BindEvents (void)
	Connect all events.

virtual void	OnPaint (wxPaintEvent &event)
	Paint handler, will plot all attached layers.

virtual void	OnSize (wxSizeEvent &event)
	Size handler, will update scroll bar sizes.

virtual void	OnShowPopupMenu (wxMouseEvent &event)
	Mouse handler, will show context menu.

virtual void	OnCenter (wxCommandEvent &event)
	Center handler.

virtual void	OnFit (wxCommandEvent &event)
	Fit handler.

virtual void	OnToggleGrids (wxCommandEvent &event)
	Toggle Grids handler.

virtual void	OnToggleCoords (wxCommandEvent &event)
	Toggle Coords handler.

virtual void	OnScreenShot (wxCommandEvent &event)
	ScreenShot handler.

virtual void	OnFullScreen (wxCommandEvent &event)
	FullScreen handler.

virtual void	OnLoadFile (wxCommandEvent &event)
	Load File handler. More...

virtual void	OnZoomIn (wxCommandEvent &event)
	Zoom In handler.

virtual void	OnZoomOut (wxCommandEvent &event)
	Zoom Out handler.

virtual void	OnLockAspect (wxCommandEvent &event)
	Lock Aspect handler.

virtual void	OnMouseHelp (wxCommandEvent &event)
	Help handler.

virtual void	OnMouseLeftDown (wxMouseEvent &event)
	Mouse left click (for rect zoom)

virtual void	OnMouseRightDown (wxMouseEvent &event)
	Mouse handler, for detecting when the user drags with the right button or just "clicks" for the menu.

virtual void	OnMouseMove (wxMouseEvent &event)
	Mouse handler for mouse motion (for pan)

virtual void	OnMouseLeftRelease (wxMouseEvent &event)
	Mouse left click (for rect zoom)

virtual void	OnMouseWheel (wxMouseEvent &event)
	Mouse handler for the wheel.

virtual void	OnMouseLeave (wxMouseEvent &event)
	Mouse handler for mouse motion (for pan) More...

bool	CheckUserMouseAction (wxMouseEvent &event)
	Check if a user mouse action is required.

virtual void	OnScrollThumbTrack (wxScrollWinEvent &event)
	Scroll thumb on scroll bar moving.

virtual void	OnScrollPageUp (wxScrollWinEvent &event)
	Scroll page up.

virtual void	OnScrollPageDown (wxScrollWinEvent &event)
	Scroll page down.

virtual void	OnScrollLineUp (wxScrollWinEvent &event)
	Scroll line up.

virtual void	OnScrollLineDown (wxScrollWinEvent &event)
	Scroll line down.

virtual void	OnScrollTop (wxScrollWinEvent &event)
	Scroll to top.

virtual void	OnScrollBottom (wxScrollWinEvent &event)
	Scroll to bottom.

void	DoScrollCalc (const int position, const int orientation)
	Update scrolling state from a scrollbar position/orientation pair. More...

void	DoZoomXCalc (bool zoomIn, wxCoord staticXpixel=-1)
	Zoom in or out X around a X position. More...

void	DoZoomYCalc (bool zoomIn, wxCoord staticYpixel=-1, mpOptional_int yAxisID=-1)
	Zoom in or out Y around a Y position. More...

void	SetScaleXAndCenter (double scaleX)
	Set the m_scaleX directly to fixed zoom level, but also adjust m_posX to to make the zoom around center. More...

void	SetScaleYAndCenter (double scaleY, int yAxisID)
	Set the m_scaleY directly to fixed zoom level, but also adjust m_posY to to make the zoom around center. More...

void	Zoom (bool zoomIn, const wxPoint &centerPoint)
	zoom action More...

virtual bool	UpdateBBox ()
	Set bounding box 'm_bound' to contain all visible plots of this mpWindow. More...

void	InitParameters ()
	Function to initialize all variables to their default values This function is called in mpWindow constructor and should not be used anymore.

virtual void	DesiredBoundsHaveChanged ()
	To be notified of displayed bounds changes (after user zoom etc), override this callback in your derived class and look at the new value of m_desired. More...

Protected Attributes
wxTopLevelWindow *	m_parent
	Pointer to the top-level window containing the plot (used for fullscreen)

bool	m_fullscreen
	Boolean value indicating that we are in fullscreen mode (default false)

mpLayerList	m_layers
	List of attached plot layers.

mpAxisData	m_AxisDataX
	Axis data for the X direction.

mpAxisList	m_AxisDataYList
	List of axis data for the Y direction.

wxMenu	m_popmenu
	Canvas' context menu.

bool	m_lockaspect
	Scale aspect is locked or not.

wxColour	m_bgColour
	Background Colour.

wxColour	m_fgColour
	Foreground Colour.

wxColour	m_axColour
	Axes Colour.

bool	m_drawBox
	Draw box of the plot bound. Default true.

int	m_scrX
	Current view's X dimension in DC units, including all scales, margins.

int	m_scrY
	Current view's Y dimension.

int	m_clickedX
	Last mouse click X position, for centering and zooming the view.

int	m_clickedY
	Last mouse click Y position, for centering and zooming the view.

mpRect	m_margin
	Margin around the plot including Y-axis.

mpRect	m_marginOuter
	Margin around the plot exluding Y-axis. Default 50.

int	m_extraMargin
	Extra margin around the plot. Default 8.

wxCoord	m_plotWidth
	Width of the plot = m_scrX - (m_margin.left + m_margin.right)

wxCoord	m_plotHeight
	Height of the plot = m_scrY - (m_margin.top + m_margin.bottom)

mpRect	m_plotBoundaries
	The full size of the plot. Calculated.

mpRect	m_plotBoundariesMargin
	The size of the plot with the margins. Calculated.

wxRect	m_PlotArea
	The full size of the plot with m_extraMargin.

bool	m_repainting
	Boolean value indicating that we are in repaint step.

int	m_last_lx
	Last logical X origin, used for double buffering.

int	m_last_ly
	Last logical Y origin, used for double buffering.

wxBitmap *	m_buff_bmp
	For double buffering.

bool	m_enableDoubleBuffer
	For double buffering. Default enabled.

bool	m_enableMouseNavigation
	For pan/zoom with the mouse.

mpMouseButtonAction	m_mouseLeftDownAction
	Type of action for left mouse button.

bool	m_mouseMovedAfterRightClick
	If the mouse does not move after a right click, then the context menu is displayed.

wxPoint	m_mouseRClick
	For the right button "drag" feature.

wxPoint	m_mouseLClick
	Starting coords for rectangular zoom selection.

double	m_mouseScaleX
	Store current X-scale, used as reference during drag zooming.

std::unordered_map< int, double >	m_mouseScaleYList
	Store current Y-scales, used as reference during drag zooming.

mpOptional_int	m_mouseYAxisID
	Indicate which ID of Y-axis the mouse was on during zoom/pan.

bool	m_enableScrollBars
	Enable scrollbar in plot window (default false)

mpInfoLayer *	m_movingInfoLayer
	For moving info layers over the window area.

mpInfoCoords *	m_InfoCoords
	Pointer to the optional info coords layer.

mpInfoLegend *	m_InfoLegend
	Pointer to the optional info legend layer.

bool	m_InInfoLegend
	Boolean value indicating that the mouse is moving over the legend area.

wxBitmap *	m_zoom_bmp
	For zoom selection.

wxRect	m_zoom_Dim
	Rectangular area selected for zoom.

bool	m_magnetize
	For mouse magnetization.

mpMagnet	m_magnet
	For mouse magnetization.

wxBitmap *	m_Screenshot_bmp
	For clipboard, save and print.

wxString	m_wildcard
	For loadfile() function when we use wxFileDialog.

wxString	m_DefaultDir
	The default directory for wxFileDialog.

mpOnDeleteLayer	m_OnDeleteLayer = NULL
	Event when we delete a layer.

mpOnUserMouseAction	m_OnUserMouseAction = NULL
	Event when we have a mouse click.

Detailed Description

Canvas for plotting mpLayer implementations.

This class defines a zoomable and moveable 2D plot canvas. Any number of mpLayer implementations (scale rulers, function plots, ...) can be attached using mpWindow::AddLayer.

The canvas window provides a context menu with actions for navigating the view. The context menu can be retrieved with mpWindow::GetPopupMenu, e.g. for extending it externally.

Since wxMathPlot version 0.03, the mpWindow incorporates the following features:

DoubleBuffering (Default=disabled): Can be set with EnableDoubleBuffer
Mouse based pan/zoom (Default=enabled): Can be set with EnableMousePanZoom.

The mouse commands can be visualized by the user through the popup menu, and are:

Mouse Move+CTRL: Pan (Move)
Mouse Wheel UP: Zoom in
Mouse Wheel DOWN: Zoom out
Mouse Wheel+CTRL: Vertical scroll
Mouse Wheel+SHIFT: Horizontal scroll

Constructor & Destructor Documentation

◆ mpWindow()

mpWindow::mpWindow	(	wxWindow *	parent,
		wxWindowID	id = `wxID_ANY`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		long	flags = `0`
	)

Construct a plotting window.

Parameters

parent	Parent wxWidgets window.
id	Window identifier.
pos	Initial window position.
size	Initial window size.
flags	Additional wxWidgets window style flags.

Member Function Documentation

◆ AddLayer()

bool mpWindow::AddLayer	(	mpLayer *	layer,
		bool	refreshDisplay = `true`,
		bool	refreshConfig = `true`
	)

Add a plot layer to the canvas.

Parameters

layer	Pointer to layer. The mpLayer object will get under control of mpWindow, i.e. it will be delete'd on mpWindow destruction
refreshDisplay	States whether to fit and refresh the display (UpdateAll) after adding the layer.
refreshConfig	States whether to refresh the config window (if exist)

Return values

TRUE	Success
FALSE	Failure. layer = NULL or layer already exist (Coords or Legend).

◆ CountAllLayers()

unsigned int mpWindow::CountAllLayers ( )

inline

Counts the number of plot layers, whether or not they have a bounding box.

Returns: The number of layers in the mpWindow.

◆ CountLayers()

unsigned int mpWindow::CountLayers ( )

Counts the number of plot layers, including axes: this is to count only the layers which have a bounding box.

Several layer operations.

Returns: The number of profiles plotted.

CountLayers() : return the number of layer with BBox
CountLayersType() : return the number of layer who are of selected type
CountLayersFXYPlot() : return the number of layer who are FXYVector function plot
GetLayer(int position) : return the layer at position
GetLayerPlot(int position, mpFunctionType func) : return the layer at position if his function type is func

◆ CountLayersFXYPlot()

unsigned int mpWindow::CountLayersFXYPlot ( )

Counts the number of XY plot layers.

Returns: The number of XY plot plotted.

◆ CountLayersType()

unsigned int mpWindow::CountLayersType ( mpLayerType type )

Counts the number of plot layers: this is to count only the layers which have a plot.

Returns: The number of profiles plotted.

◆ DelAllLayers()

void mpWindow::DelAllLayers	(	mpDeleteAction	alsoDeleteObject,
		bool	refreshDisplay = `true`
	)

Remove all layers from the plot.

Parameters

alsoDeleteObject	If set to true, the mpLayer objects will be also "deleted", not just removed from the internal list.
refreshDisplay	States whether to refresh the display (UpdateAll) after removing the layers. See DelLayer() for more infos

◆ DelAllPlot()

void mpWindow::DelAllPlot	(	mpDeleteAction	alsoDeleteObject,
		mpFunctionType	func = `mpfAllType`,
		bool	refreshDisplay = `true`
	)

Remove all plot layers.

Parameters

alsoDeleteObject	If set to true, the mpLayer objects will be also "deleted", not just removed from the internal list.
func	Select type of plot
refreshDisplay	States whether to refresh the display (UpdateAll) after removing the layers. See DelLayer() for more infos

◆ DelAllYAxisAfterID()

void mpWindow::DelAllYAxisAfterID	(	mpDeleteAction	alsoDeleteObject,
		int	yAxisID = `0`,
		bool	refreshDisplay = `true`
	)

Remove all extra y axis after the selected y axis.

Parameters

alsoDeleteObject	If set to true, the mpLayer objects will be also "deleted", not just removed from the internal list.
yAxisID	the ID of the axis to keep (Default 0). Remove all y axis after this ID. If y-axis ID < 0, remove all y axis.
refreshDisplay	States whether to refresh the display (UpdateAll) after removing the layers. See DelLayer() for more infos

◆ DelLayer()

bool mpWindow::DelLayer	(	mpLayer *	layer,
		mpDeleteAction	alsoDeleteObject,
		bool	refreshDisplay = `true`,
		bool	refreshConfig = `true`
	)

Remove a plot layer from the canvas.

Parameters

layer	Pointer to layer. The mpLayer object will be destructed using delete.
alsoDeleteObject	If set to mpYesDelete, the mpLayer object will be also "deleted", not just removed from the internal list. In case mpForceDelete, the mpLayer object is deleted even if m_CanDelete is false
refreshDisplay	States whether to refresh the display (UpdateAll) after removing the layer.
refreshConfig	States whether to refresh the config window (if exist)

Returns: true if layer is deleted correctly

N.B. If alsoDeleteObject is false, only the layer pointer in the mpWindow is removed, the layer object still exists. WARNING: Invalidates any extant m_layers iterators! WARNING: If alsoDeleteObject is true, the layer object object is deleted but his reference (pointer) is not set to NULL.

◆ DesiredBoundsHaveChanged()

virtual void mpWindow::DesiredBoundsHaveChanged ( )

inlineprotectedvirtual

To be notified of displayed bounds changes (after user zoom etc), override this callback in your derived class and look at the new value of m_desired.

Useful for keeping multiple plots in sync when user zooms.

◆ DoScrollCalc()

void mpWindow::DoScrollCalc	(	const int	position,
		const int	orientation
	)

protected

Update scrolling state from a scrollbar position/orientation pair.

◆ DoZoomXCalc()

void mpWindow::DoZoomXCalc	(	bool	zoomIn,
		wxCoord	staticXpixel = `-1`
	)

protected

Zoom in or out X around a X position.

Is the position is not set, it will zoom around center.

Parameters

zoomIn	Zoom in or zoom out boolean
staticXpixel	Optional center position

◆ DoZoomYCalc()

void mpWindow::DoZoomYCalc	(	bool	zoomIn,
		wxCoord	staticYpixel = `-1`,
		mpOptional_int	yAxisID = `-1`
	)

protected

Zoom in or out Y around a Y position.

Is the position is not set, it will zoom around center. An optional Y-axis ID can be passe to only zoom a specific Y-axis

Parameters

zoomIn	Zoom in or zoom out boolean
staticYpixel	Optional center position
yAxisID	Optional Y-axis ID used to specify which Y-axis to zoom

◆ Fit() [1/2]

void mpWindow::Fit ( )

Set view to fit global bounding box of all plot layers and refresh display with UpdateAll().

General fit Use global layer bounding box.

Scale and position will be set to show all attached mpLayers. The X/Y scale aspect lock is taken into account.

◆ Fit() [2/2]

void mpWindow::Fit	(	const mpRange< double > &	rangeX,
		std::unordered_map< int, mpRange< double >>	rangeY,
		wxCoord *	printSizeX = `NULL`,
		wxCoord *	printSizeY = `NULL`
	)

Set view to fit a given bounding box and refresh display with UpdateAll().

Here rangeY is a vector and he is exactly ordered like Range in m_AxisDataYList.

The X/Y scale aspect lock is taken into account. If provided, the parameters printSizeX and printSizeY are taken as the DC size, and the pixel scales are computed accordingly. Also, in this case the passed borders are not saved as the "desired borders", since this use will be invoked only when printing.

◆ FitX()

void mpWindow::FitX ( void )

Similar to Fit() but only fit in X.

Intentionally don't call UpdateAll() since you might want to perform other actions before updating plot

◆ FitY()

void mpWindow::FitY ( int yAxisID )

Similar to Fit() but only fit in Y and only one Y-axis, specified by ID.

Intentionally don't call UpdateAll() since you might want to perform other actions before updating plot

Parameters

yAxisID indicating which Y-axis to fit

◆ GetAllBoundY()

std::unordered_map<int, mpRange<double> > mpWindow::GetAllBoundY ( )

inline

Returns the bounds for all Y-axes.

Returns: A map from Y-axis ID to its bound.

◆ GetAllDesiredY()

std::unordered_map<int, mpRange<double> > mpWindow::GetAllDesiredY ( )

inline

Returns the desired bounds for all Y-axes.

Returns: A map from Y-axis ID to its desired bound.

◆ GetAxesColour()

const wxColour& mpWindow::GetAxesColour ( ) const

inline

Get axes draw colour.

Returns: reference to axis colour used in theme

◆ GetAxisDataYList()

mpAxisList mpWindow::GetAxisDataYList ( void ) const

inline

Get the Y-axis data map.

Returns: The Y-axis data map

◆ GetBoundingBox()

mpFloatRectSimple mpWindow::GetBoundingBox	(	bool	desired,
		unsigned int	yAxisID = `0`
	)

inline

Return a bounding box for an y-axis ID.

Parameters

desired	if true return desired bound else return bound
yAxisID	the y-axis ID (default 0)

◆ GetBoundX()

mpRange<double> mpWindow::GetBoundX ( void ) const

inline

Get bounding box for X axis.

◆ GetBoundY()

mpRange<double> mpWindow::GetBoundY ( int yAxisID )

inline

Get bounding box for Y axis of ID yAxisID.

Parameters

yAxisID Y axis ID to get bound

◆ GetClosestPlot()

mpLayer * mpWindow::GetClosestPlot	(	wxCoord	ix,
		wxCoord	iy,
		double *	xnear,
		double *	ynear
	)

Search the point of the layer plot nearest a point

Parameters

ix	x-coordinate
iy	y-coordinate
xnear	Return the x value of the plot
ynear	Return the y value of the plot

Returns: A pointer to the plot closest to the point

◆ GetDesiredBoundX()

mpRange<double> mpWindow::GetDesiredBoundX ( void ) const

inline

Get desired bounding box for X axis.

◆ GetDesiredBoundY()

mpRange<double> mpWindow::GetDesiredBoundY ( int yAxisID )

inline

Get desired bounding box for Y axis of ID yAxisID.

Parameters

yAxisID Y axis ID to get bound

◆ GetDesiredXmax()

double mpWindow::GetDesiredXmax ( ) const

inline

Return the right-border layer coordinate that the user wants the mpWindow to show (it may be not exactly the actual shown coordinate in the case of locked aspect ratio).

See also: Fit, Zoom

◆ GetDesiredXmin()

double mpWindow::GetDesiredXmin ( ) const

inline

Returns the left-border layer coordinate that the user wants the mpWindow to show (it may be not exactly the actual shown coordinate in the case of locked aspect ratio).

See also: Fit, Zoom

◆ GetDesiredYmax()

double mpWindow::GetDesiredYmax ( int yAxisID )

inline

Return the top layer-border coordinate that the user wants the mpWindow to show (it may be not exactly the actual shown coordinate in the case of locked aspect ratio).

Parameters

yAxisID Y axis ID to get desired max

See also: Fit, Zoom

◆ GetDesiredYmin()

double mpWindow::GetDesiredYmin ( int yAxisID )

inline

Return the bottom-border layer coordinate that the user wants the mpWindow to show (it may be not exactly the actual shown coordinate in the case of locked aspect ratio).

Parameters

yAxisID Y axis ID to get desired min

See also: Fit, Zoom

◆ GetDrawBox()

bool mpWindow::GetDrawBox ( ) const

inline

Get the draw of the box around the plot.

◆ GetExtraMargin()

int mpWindow::GetExtraMargin ( ) const

inline

Get the extra margin.

◆ GetLayer()

mpLayer * mpWindow::GetLayer ( int position )

Get the layer in list position indicated. N.B. You must know the index of the layer inside the list!

Parameters

position position of the layer in the layers list

Returns: pointer to mpLayer

◆ GetLayerAxis()

mpScale * mpWindow::GetLayerAxis	(	int	position,
		mpScaleType	scale = `mpsAllType`
	)

Get the layer axis in list position indicated. N.B. You must know the index of the layer axis inside the list of axis!

Parameters

position	position of the layer axis in the layers axis list
scale	type of the axis we want to get (default mpsAllType)

◆ GetLayerByClassName()

mpLayer * mpWindow::GetLayerByClassName ( const wxString & name )

Get the first layer by its class name (case sensitive).

Parameters

name	The class name of the layer to retrieve

Returns: A pointer to the mpLayer object, or NULL if not found.

◆ GetLayerByName()

mpLayer * mpWindow::GetLayerByName ( const wxString & name )

Get the layer by its name (case sensitive).

Parameters

name	The name of the layer to retrieve

Returns: A pointer to the mpLayer object, or NULL if not found.

◆ GetLayerPlot()

mpLayer * mpWindow::GetLayerPlot	(	int	position,
		mpFunctionType	func = `mpfAllType`
	)

Get the layer plot in list position indicated. N.B. You must know the index of the layer plot inside the list of plot!

Parameters

position	position of the layer plot in the layers plot list
func	type of the function we want to get (default mpfAllType)

Returns: pointer to mpLayer

◆ GetLayerPosition()

int mpWindow::GetLayerPosition ( mpLayer * layer )

Get the position of the layer in the list.

Parameters

layer the layer to find

Returns: the position of the layer or -1 if not found

◆ GetLayersType()

mpLayer * mpWindow::GetLayersType	(	int	position,
		mpLayerType	type
	)

Get the layer of a certain type in list position indicated. N.B. You must know the index of the layer inside the list!

Parameters

position	position of the layer in the layers list
type	of the layer

Returns: pointer to mpLayer

◆ GetLayerXAxis()

mpScaleX * mpWindow::GetLayerXAxis ( )

Get the first scale X layer (X axis) or NULL if not found.

Get the first scale X layer (X axis).

Returns: A pointer to the mpScaleX object, or NULL if not found.

◆ GetLayerYAxis()

mpScaleY * mpWindow::GetLayerYAxis ( int yAxisID )

Get the scale Y layer (Y axis) with a specific yAxisID or NULL if not found.

Get the scale Y layer (Y axis) with a specific yAxisID

Returns: A pointer to the mpScaleY object, or NULL if not found.

◆ GetLeftYAxesWidth()

int mpWindow::GetLeftYAxesWidth ( mpOptional_int yAxisID = -1 )

Calculate width of all axes to the left of this axis.

If y-axis ID is not specified, calculate width of all left axes

Parameters

yAxisID of this y-axis

◆ GetMarginBottom()

int mpWindow::GetMarginBottom ( bool minusExtra = false ) const

inline

Get the bottom margin.

Parameters

minusExtra (default false): return bottom margin minus extra margin

◆ GetMarginLeft()

int mpWindow::GetMarginLeft ( bool minusExtra = false ) const

inline

Get the left margin.

Parameters

minusExtra (default false): return left margin minus extra margin

◆ GetMarginLeftOuter()

int mpWindow::GetMarginLeftOuter ( ) const

inline

Get the left outer margin, exluding Y-axis.

◆ GetMarginRight()

int mpWindow::GetMarginRight ( bool minusExtra = false ) const

inline

Get the right margin.

Parameters

minusExtra (default false): return right margin minus extra margin

◆ GetMarginRightOuter()

int mpWindow::GetMarginRightOuter ( ) const

inline

Get the right outer margin, exluding Y-axis.

◆ GetMarginTop()

int mpWindow::GetMarginTop ( bool minusExtra = false ) const

inline

Get the top margin.

Parameters

minusExtra (default false): return top margin minus extra margin

◆ GetMouseLeftDownAction()

mpMouseButtonAction mpWindow::GetMouseLeftDownAction ( )

inline

Returns the type of action for the left mouse button.

Returns: Left mouse button action

◆ GetMPScrollbars()

bool mpWindow::GetMPScrollbars ( ) const

inline

Get scrollbars status.

Returns: true if scrollbars are visible

◆ GetNOfYAxis()

int mpWindow::GetNOfYAxis ( void ) const

inline

Get the number of Y axis.

Returns: The number of Y axis in m_AxisDataYList

◆ GetPlotBoundaries()

mpRect mpWindow::GetPlotBoundaries ( bool with_margin ) const

inline

Get the boundaries of the plot.

Bond is reduced by m_extraMargin constant

Parameters

with_margin include margin if true

◆ GetPlotHeight()

int mpWindow::GetPlotHeight ( ) const

inline

Get the height of the plot.

◆ GetPlotWidth()

int mpWindow::GetPlotWidth ( ) const

inline

Get the width of the plot.

◆ GetPopupMenu()

wxMenu* mpWindow::GetPopupMenu ( )

inline

Get reference to context menu of the plot canvas.

Returns: Pointer to menu. The menu can be modified.

◆ GetPosX()

double mpWindow::GetPosX ( void ) const

inline

Get current view's X position.

See rules for coordinate transformation

Returns: X Position in layer coordinate system, that corresponds to the center point of the view.

◆ GetPosY()

double mpWindow::GetPosY ( int yAxisID )

inline

Get current view's Y position.

See rules for coordinate transformation

Parameters

yAxisID Y axis ID to get Pos

Returns: Y Position in layer coordinate system, that corresponds to the center point of the view.

◆ GetRightYAxesWidth()

int mpWindow::GetRightYAxesWidth ( mpOptional_int yAxisID = -1 )

Calculate width of all axes to the right of this axis.

If y-axis ID is not specified, calculate width of all right axes

Parameters

yAxisID of this y-axis

◆ GetScaleX()

double mpWindow::GetScaleX ( void ) const

inline

Get current view's X scale.

See rules for coordinate transformation

Returns: Scale

◆ GetScaleY()

double mpWindow::GetScaleY ( int yAxisID )

inline

Get current view's Y scale.

See rules for coordinate transformation

Parameters

yAxisID Y axis ID to get scale

Returns: Scale

◆ GetScreenX()

int mpWindow::GetScreenX ( void ) const

inline

Get current view's X dimension in device context units.

Usually this is equal to wxDC::GetSize, but it might differ thus mpLayer implementations should rely on the value returned by the function. See rules for coordinate transformation

Returns: X dimension.

◆ GetScreenY()

int mpWindow::GetScreenY ( void ) const

inline

Get current view's Y dimension in device context units.

Usually this is equal to wxDC::GetSize, but it might differ thus mpLayer implementations should rely on the value returned by the function. See rules for coordinate transformation

Returns: Y dimension.

◆ GetSortedAxisDataYList()

std::map<int, mpAxisData> mpWindow::GetSortedAxisDataYList ( void ) const

inline

Get a sorted version of the Y-axis data map.

Returns: A sorted Y-axis data map

◆ GetXYSeries()

mpFXYVector * mpWindow::GetXYSeries	(	unsigned int	n,
		const wxString &	name = `_T("Serie ")`,
		bool	create = `true`
	)

Return the serie n If the serie not exist then create it

Parameters

n	the number of the series
name	the name to give to the series in case we create it
create	if true and the series doesn't exist, then we'll create it.

Returns: the existing or created series. NULL if not found or not created.

◆ IsAspectLocked()

bool mpWindow::IsAspectLocked ( ) const

inline

Checks whether the X/Y scale aspect is locked.

Return values

TRUE	Locked
FALSE	Unlocked

◆ IsInsideInfoLayer()

mpInfoLayer * mpWindow::IsInsideInfoLayer ( const wxPoint & point )

Check if a given point is inside the area of a mpInfoLayer and eventually returns its pointer.

Parameters

point The position to be checked

Returns: point If an info layer is found, returns its pointer, NULL otherwise

◆ IsInsideYAxis()

mpOptional_int mpWindow::IsInsideYAxis ( const wxPoint & point )

Check if a given point is inside the area of a visible Y-axis and returns its ID if so.

Parameters

point The position to be checked

Returns: point If the point is inside a Y-Axis, returns its ID, otherwise -1

◆ IsLayerVisible() [1/2]

bool mpWindow::IsLayerVisible ( const wxString & name )

Check whether a layer with given name is visible.

Parameters

name	The layer name

Returns: layer visibility status

◆ IsLayerVisible() [2/2]

bool mpWindow::IsLayerVisible ( const unsigned int position )

Check whether the layer at given position is visible.

Parameters

position The layer position in layer list

Returns: layer visibility status

◆ IsRepainting()

bool mpWindow::IsRepainting ( ) const

inline

Checks if we are repainting.

Return values

TRUE
FALSE

◆ IsYAxisUsed()

bool mpWindow::IsYAxisUsed ( int yAxisID )

Check if a specific Y-axis exists or is used by any function

Parameters

yAxisID ID of Y axis to check

Returns: True if specified Y-axis is used, false otherwise

◆ LoadFile()

bool mpWindow::LoadFile ( const wxString & filename = wxEmptyString )

Load a data file like a csv file Data must be formatted in 2 or more columns.

First column is X value and others columns are Y values that represent several series. Each columns are separated by space or ; or tab character. Lines beginning with # are ignored (comment lines)

Parameters

filename Complete path name of the file. If empty, call wxFileDialog to select file with m_wildcard to filter files

◆ LockAspect()

void mpWindow::LockAspect ( bool enable = true )

Enable or disable X/Y scale aspect locking for the view.

Note: Explicit calls to mpWindow::SetScaleX and mpWindow::SetScaleY will set an unlocked aspect, but any other action changing the view scale will lock the aspect again.

◆ OnLoadFile()

void mpWindow::OnLoadFile ( wxCommandEvent & event )

protectedvirtual

Load File handler.

Create series from a data file.

See LoadFile() function for more info.

◆ OnMouseLeave()

void mpWindow::OnMouseLeave ( wxMouseEvent & event )

protectedvirtual

Mouse handler for mouse motion (for pan)

Mouse leave the plot area.

◆ p2x()

double mpWindow::p2x ( const wxCoord pixelCoordX ) const

inline

Converts mpWindow (screen) pixel coordinates into graph (floating point) coordinates, using current mpWindow position and scale.

See also: p2y,x2p,y2p

◆ p2y()

double mpWindow::p2y	(	const wxCoord	pixelCoordY,
		int	yAxisID = `0`
	)

inline

Converts mpWindow (screen) pixel coordinates into graph (floating point) coordinates, using current mpWindow position and scale.

See also: p2x,x2p,y2p

◆ RefreshLegend()

void mpWindow::RefreshLegend ( void )

Flag for refresh legend

◆ SaveScreenshot()

bool mpWindow::SaveScreenshot	(	const wxString &	filename,
		int	type = `wxBITMAP_TYPE_BMP`,
		wxSize	imageSize = `wxDefaultSize`,
		bool	fit = `false`
	)

Draw the window on a wxBitmap, then save it to a file.

Parameters

filename	File name where to save the screenshot
type	image type to be saved: see wxImage output file types for flags
imageSize	Set a size for the output image. Default is the same as the screen size
fit	Decide whether to fit the plot into the size

◆ SetBound()

void mpWindow::SetBound ( )

Update bound for mpFX and mpFY when axis is scaled.

Deprecated: Incomplete, set bound only for mpFX and mpFY with one y-axis! Use UpdateBBox for complete set!

Deprecated:: Incomplete! Use UpdateBBox!

◆ SetColourTheme()

void mpWindow::SetColourTheme	(	const wxColour &	bgColour,
		const wxColour &	drawColour,
		const wxColour &	axesColour
	)

Set Color theme.

Provide colours to set a new colour theme.

Parameters

bgColour	Background colour
drawColour	The colour used to draw all elements in foreground, axes excluded
axesColour	The colour used to draw axes (but not their labels)

◆ SetDefaultDir()

void mpWindow::SetDefaultDir ( const wxString & dirname )

inline

Set the default directory for wxFileDialog.

Parameters

dirname the name of the directory

◆ SetDrawBox()

void mpWindow::SetDrawBox ( bool drawbox )

inline

Set the draw of the box around the plot.

◆ SetExtraMargin()

void mpWindow::SetExtraMargin ( int extra )

inline

Set the extra margin.

Parameters

extra Extra Margin

◆ SetLayerVisible() [1/2]

void mpWindow::SetLayerVisible	(	const wxString &	name,
		bool	viewable
	)

Sets the visibility of a layer by its name.

Parameters

name	The layer name to set visibility
viewable	the view status to be set

◆ SetLayerVisible() [2/2]

void mpWindow::SetLayerVisible	(	const unsigned int	position,
		bool	viewable
	)

Sets the visibility of a layer by its position in layer list.

Parameters

position	The layer position in layer list
viewable	the view status to be set

◆ SetMarginBottom()

void mpWindow::SetMarginBottom ( int bottom )

inline

Set the bottom margin.

Parameters

bottom Bottom Margin

◆ SetMarginLeft()

void mpWindow::SetMarginLeft ( int left )

inline

Set the left margin.

Parameters

left	Left Margin

◆ SetMarginRight()

void mpWindow::SetMarginRight ( int right )

inline

Set the right margin.

Parameters

right Right Margin

◆ SetMargins()

void mpWindow::SetMargins	(	int	top,
		int	right,
		int	bottom,
		int	left
	)

Set window margins, creating a blank area where some kinds of layers cannot draw.

This is useful for example to draw axes outside the area where the plots are drawn.

Parameters

top	Top border
right	Right border
bottom	Bottom border
left	Left border

◆ SetMarginTop()

void mpWindow::SetMarginTop ( int top )

inline

Set the top margin.

Parameters

top	Top Margin

◆ SetMouseLeftDownAction()

void mpWindow::SetMouseLeftDownAction ( mpMouseButtonAction action )

inline

Set the type of action for the left mouse button.

Parameters

action Left mouse button action

◆ SetMPScrollbars()

void mpWindow::SetMPScrollbars ( bool status )

Enable/disable scrollbars.

Parameters

status Set to true to show scrollbars

◆ SetOnDeleteLayer()

void mpWindow::SetOnDeleteLayer ( const mpOnDeleteLayer & event )

inline

On delete layer event Allows the user to perform certain actions before deleting the layer.

The user can abort the deletion. See mpOnDeleteLayer type.

◆ SetOnUserMouseAction()

void mpWindow::SetOnUserMouseAction ( const mpOnUserMouseAction & userMouseEventHandler )

inline

On user mouse action event Allows the user to perform certain actions before normal event processing.

The user has the possibility to interrupt or continue the normal processing of the event.

◆ SetPos()

void mpWindow::SetPos	(	const double	posX,
		std::unordered_map< int, double > &	posYList
	)

inline

Set current view's X and Y position and refresh display.

Parameters

posX	New position that corresponds to the center point of the view.
posYList	New positions that corresponds to the center point of the view. IMPORTANT: posYList items must be in the same order of Y axis list

◆ SetPosX()

void mpWindow::SetPosX ( const double posX )

inline

Set current view's X position and refresh display.

Parameters

posX	New position that corresponds to the center point of the view.

◆ SetPosY()

void mpWindow::SetPosY ( std::unordered_map< int, double > & posYList )

inline

Set current view's Y position and refresh display.

Parameters

posYList New position that corresponds to the center point of the view. IMPORTANT: posYList items must be in the same order of Y axis list

◆ SetScaleX()

void mpWindow::SetScaleX ( const double scaleX )

inline

Set current view's X scale and refresh display.

Parameters

scaleX New scale, must not be 0.

◆ SetScaleXAndCenter()

void mpWindow::SetScaleXAndCenter ( double scaleX )

protected

Set the m_scaleX directly to fixed zoom level, but also adjust m_posX to to make the zoom around center.

Parameters

scaleX value

◆ SetScaleY()

void mpWindow::SetScaleY	(	const double	scaleY,
		int	yAxisID
	)

inline

Set current view's Y scale and refresh display.

Parameters

scaleY	New scale, must not be 0.
yAxisID	Y axis ID to set scale

◆ SetScaleYAndCenter()

void mpWindow::SetScaleYAndCenter	(	double	scaleY,
		int	yAxisID
	)

protected

Set the m_scaleY directly to fixed zoom level, but also adjust m_posY to to make the zoom around center.

Parameters

scaleY	value
yAxisID	ID used to specify which Y-axis to set

◆ SetScreen()

void mpWindow::SetScreen	(	const int	scrX,
		const int	scrY
	)

inline

Set current view's dimensions in device context units.

Needed by plotting functions. It doesn't refresh display.

Parameters

scrX	New position that corresponds to the center point of the view.
scrY	New position that corresponds to the center point of the view.

◆ UpdateBBox()

bool mpWindow::UpdateBBox ( )

protectedvirtual

Set bounding box 'm_bound' to contain all visible plots of this mpWindow.

Returns: true if there valid bounding box set in m_bounds.

◆ UpdateBoundingBoxToInclude()

void mpWindow::UpdateBoundingBoxToInclude	(	double	px,
		double	py,
		int	yAxisID
	)

inline

Ensure the bounding box includes the given point for the selected Y axis.

Parameters

px	point on x-axis
py	point on y-axis
yAxisID	the y-axis ID

◆ UpdateDesiredBoundingBox()

void mpWindow::UpdateDesiredBoundingBox ( mpAxisUpdate update )

inline

Update m_desired bounds.

Store the min and max position of the visible data in the plot. Used primarily during frame resizing via OnSize so that the data stays in the same place when resizing the frame. Needs to be updated whenever m_posX, m_scaleX, m_posY or m_scaleY is updated. Check if there is some changes

Parameters

update the axis to be updated

◆ UpdateMargins()

void mpWindow::UpdateMargins ( )

inline

Update margins if e.g.

more axis have been added.

◆ x2p()

wxCoord mpWindow::x2p ( const double x ) const

inline

Converts graph (floating point) coordinates into mpWindow (screen) pixel coordinates, using current mpWindow position and scale.

See also: p2x,p2y,y2p

◆ y2p()

wxCoord mpWindow::y2p	(	const double	y,
		int	yAxisID = `0`
	)

inline

Converts graph (floating point) coordinates into mpWindow (screen) pixel coordinates, using current mpWindow position and scale.

See also: p2x,p2y,x2p

◆ Zoom()

void mpWindow::Zoom	(	bool	zoomIn,
		const wxPoint &	centerPoint
	)

protected

zoom action

Parameters

zoomIn	if true then zoom in else zoom out
centerPoint	the focus point on which we zoom

◆ ZoomIn()

void mpWindow::ZoomIn ( const wxPoint & centerPoint = wxDefaultPosition )

Zoom into current view and refresh display.

Parameters

centerPoint The point (pixel coordinates) that will stay in the same position on the screen after the zoom (by default, the center of the mpWindow).

◆ ZoomInY()

void mpWindow::ZoomInY ( mpOptional_int yAxisID = -1 )

Zoom in current view along Y around center and refresh display.

Parameters

yAxisID Optional Y-axis ID used to specify which Y-axis to zoom

◆ ZoomOut()

void mpWindow::ZoomOut ( const wxPoint & centerPoint = wxDefaultPosition )

Zoom out current view and refresh display.

Parameters

centerPoint The point (pixel coordinates) that will stay in the same position on the screen after the zoom (by default, the center of the mpWindow).

◆ ZoomOutY()

void mpWindow::ZoomOutY ( mpOptional_int yAxisID = -1 )

Zoom out current view along Y around center and refresh display.

Parameters

yAxisID Optional Y-axis ID used to specify which Y-axis to zoom

◆ ZoomRect()

void mpWindow::ZoomRect	(	wxPoint	p0,
		wxPoint	p1
	)

Zoom view fitting given coordinates to the window (p0 and p1 do not need to be in any specific order)

Parameters

p0	initial point
p1	final point

Member Data Documentation

◆ m_zoomIncrementalFactor

double mpWindow::m_zoomIncrementalFactor = 1.5

static

This value sets the zoom steps whenever the user clicks "Zoom in/out" or performs zoom with the mouse wheel.

It must be a number above unity. This number is used for zoom in, and its inverse for zoom out. Set to 1.5 by default.

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ mpWindow()

Member Function Documentation

◆ AddLayer()

◆ CountAllLayers()

◆ CountLayers()

◆ CountLayersFXYPlot()

◆ CountLayersType()

◆ DelAllLayers()

◆ DelAllPlot()

◆ DelAllYAxisAfterID()

◆ DelLayer()

◆ DesiredBoundsHaveChanged()

◆ DoScrollCalc()

◆ DoZoomXCalc()

◆ DoZoomYCalc()

◆ Fit() [1/2]

◆ Fit() [2/2]

◆ FitX()

◆ FitY()

◆ GetAllBoundY()

◆ GetAllDesiredY()

◆ GetAxesColour()

◆ GetAxisDataYList()

◆ GetBoundingBox()

◆ GetBoundX()

◆ GetBoundY()

◆ GetClosestPlot()

◆ GetDesiredBoundX()

◆ GetDesiredBoundY()

◆ GetDesiredXmax()

◆ GetDesiredXmin()

◆ GetDesiredYmax()

◆ GetDesiredYmin()

◆ GetDrawBox()

◆ GetExtraMargin()

◆ GetLayer()

◆ GetLayerAxis()

◆ GetLayerByClassName()

◆ GetLayerByName()

◆ GetLayerPlot()

◆ GetLayerPosition()

◆ GetLayersType()

◆ GetLayerXAxis()

◆ GetLayerYAxis()

◆ GetLeftYAxesWidth()

◆ GetMarginBottom()

◆ GetMarginLeft()

◆ GetMarginLeftOuter()

◆ GetMarginRight()

◆ GetMarginRightOuter()

◆ GetMarginTop()

◆ GetMouseLeftDownAction()

◆ GetMPScrollbars()

◆ GetNOfYAxis()

◆ GetPlotBoundaries()

◆ GetPlotHeight()

◆ GetPlotWidth()

◆ GetPopupMenu()

◆ GetPosX()

◆ GetPosY()

◆ GetRightYAxesWidth()

◆ GetScaleX()

◆ GetScaleY()

◆ GetScreenX()

◆ GetScreenY()

◆ GetSortedAxisDataYList()

◆ GetXYSeries()

◆ IsAspectLocked()

◆ IsInsideInfoLayer()

◆ IsInsideYAxis()

◆ IsLayerVisible() [1/2]

◆ IsLayerVisible() [2/2]

◆ IsRepainting()

◆ IsYAxisUsed()