A layer that allows you to have a bitmap image printed in the mpWindow. More...
#include <mathplot.h>
Inheritance diagram for mpBitmapLayer:
Collaboration diagram for mpBitmapLayer:
Public Member Functions | |
| mpBitmapLayer () | |
| Default constructor. | |
| void | GetBitmapCopy (wxImage &outBmp) const |
| Returns a copy of the current bitmap assigned to the layer. | |
| void | SetBitmap (const wxImage &inBmp, double x, double y, double lx, double ly) |
| Change the bitmap associated with the layer (to update the screen, refresh the mpWindow). More... | |
| virtual double | GetMinX () |
| Get inclusive left border of bounding box. | |
| virtual double | GetMaxX () |
| Get inclusive right border of bounding box. | |
| virtual double | GetMinY () |
| Get inclusive bottom border of bounding box. | |
| virtual double | GetMaxY () |
| Get inclusive top border of bounding box. | |
 Public Member Functions inherited from mpLayer | |
| mpLayer (mpLayerType layerType) | |
| void | SetWindow (mpWindow &w) |
| Set the wxWindow handle. | |
| virtual bool | HasBBox () |
| Check whether this layer has a bounding box. 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... | |
| int | GetLayerSubType () const |
| Get layer subtype: each layer type can have several flavors. More... | |
| virtual bool | IsLayerType (mpLayerType type, int *sub_type) |
| Specifies that if the layer is of type "type". More... | |
| void | Plot (wxDC &dc, mpWindow &w) |
| Plot given view of layer to the given device context. More... | |
| void | SetName (const wxString &name) |
| Set layer name. More... | |
| const wxString & | GetName () const |
| Get layer name. More... | |
| void | SetFont (const wxFont &font) |
| Set layer font. More... | |
| const wxFont & | GetFont () const |
| Get font set for this layer. More... | |
| void | SetFontColour (const wxColour &colour) |
| Set layer font foreground colour. More... | |
| const wxColour & | GetFontColour () const |
| Get font foreground colour set for this layer. More... | |
| void | SetPen (const wxPen &pen) |
| Set layer pen. More... | |
| const wxPen & | GetPen () const |
| Get pen set for this layer. More... | |
| void | SetBrush (const wxBrush &brush) |
| Set layer brush. More... | |
| const wxBrush & | GetBrush () const |
| Get brush set for this layer. More... | |
| void | SetShowName (bool show) |
| Set Name visibility. More... | |
| bool | GetShowName () const |
| Get Name visibility. More... | |
| void | SetDrawOutsideMargins (bool drawModeOutside) |
| Set Draw mode: inside or outside margins. More... | |
| bool | GetDrawOutsideMargins () const |
| Get Draw mode: inside or outside margins. More... | |
| wxBitmap | GetColourSquare (int side=16) |
| Get a small square bitmap filled with the colour of the pen used in the layer. More... | |
| bool | IsVisible () const |
| Checks whether the layer is visible or not. More... | |
| virtual void | SetVisible (bool show) |
| Sets layer visibility. More... | |
| bool | IsTractable () const |
| Checks whether the layer is tractable or not. More... | |
| virtual void | SetTractable (bool track) |
| Sets layer tractability. More... | |
| void | SetAlign (int align) |
| Set X/Y alignment. More... | |
| int | GetAlign () const |
| Get X/Y alignment. More... | |
| void | SetCanDelete (bool canDelete) |
| Set CanDelete for plot. More... | |
| bool | GetCanDelete (void) const |
| Get CanDelete for plot. More... | |
| mpLayerZOrder | GetZIndex (void) const |
| Get the ZIndex of the plot. More... | |
Protected Member Functions | |
| virtual void | DoPlot (wxDC &dc, mpWindow &w) |
| Pure virtual method to plot the layer. More... | |
| wxDECLARE_DYNAMIC_CLASS (mpBitmapLayer) | |
| Protected Member Functions inherited from mpLayer | |
| void | UpdateContext (wxDC &dc) const |
| Initialize the context. | |
| virtual void | DoBeforePlot () |
| If we need to do something before plot like reinitialize some parameters ... | |
| void | CheckLog (double *x, double *y) |
| Test if we are in log axis and if true return the log of the values. | |
Protected Attributes | |
| wxImage | m_bitmap |
| The internal copy of the Bitmap: | |
| wxBitmap | m_scaledBitmap |
| wxCoord | m_scaledBitmap_offset_x |
| wxCoord | m_scaledBitmap_offset_y |
| bool | m_validImg |
| bool | m_bitmapChanged |
| double | m_min_x |
| The shape of the bitmap: | |
| double | m_max_x |
| double | m_min_y |
| double | m_max_y |
| Protected Attributes inherited from mpLayer | |
| const mpLayerType | m_type |
| Layer type mpLAYER_*. | |
| mpWindow * | m_win |
| The wxWindow handle. | |
| int | m_subtype |
| Layer sub type, set in constructors. | |
| wxFont | m_font |
| Layer's font. | |
| wxColour | m_fontcolour |
| Layer's font foreground colour. | |
| wxPen | m_pen |
| Layer's pen. Default Colour = Black, width = 1, style = wxPENSTYLE_SOLID. | |
| wxBrush | m_brush |
| Layer's brush. Default wxTRANSPARENT_BRUSH. | |
| wxString | m_name |
| Layer's name. | |
| bool | m_showName |
| States whether the name of the layer must be shown. Default : false. | |
| bool | m_drawOutsideMargins |
| Select if the layer should draw only inside margins or over all DC. Default : false. | |
| bool | m_visible |
| Toggles layer visibility. Default : true. | |
| bool | m_tractable |
| Is the layer tractable. | |
| int | m_flags |
| Holds label alignment. Default : mpALIGN_NE. | |
| mpRect | m_plotBoundaries |
| The boundaries for plotting curve calculated by mpWindow. | |
| bool | m_CanDelete |
| Is the layer can be deleted. | |
| mpLayerZOrder | m_ZIndex |
| The index in Z-Order to draw the layer. | |
Detailed Description
A layer that allows you to have a bitmap image printed in the mpWindow.
Use SetBitmap() to load the image in the right place. You can retrieve the image from the layer at anytime you want with getBitmapCopy()
Member Function Documentation
◆ DoPlot()
|
protectedvirtual |
Pure virtual method to plot the layer.
Must be overridden and implemented by derived classes.
Implements mpLayer.
◆ SetBitmap()
| void mpBitmapLayer::SetBitmap | ( | const wxImage & | inBmp, |
| double | x, | ||
| double | y, | ||
| double | lx, | ||
| double | ly | ||
| ) |
Change the bitmap associated with the layer (to update the screen, refresh the mpWindow).
- Parameters
-
inBmp The bitmap to associate. A copy is made, thus it can be released after calling this. x The left corner X coordinate (in plot units). y The top corner Y coordinate (in plot units). lx The width in plot units. ly The height in plot units.
